Class RadixNodeEdges<T>

A simple Map<string, RadixNode>, but also maintains a single invariant:

Only a single key can start with a particular character

This invariant means that we can find the key that shares a prefix with a given string in O(1).

Type parameters

T

Hierarchy

RadixNodeEdges

Index

Constructors

constructor

Properties

Accessors

size

Methods

Constructors

constructor

new RadixNodeEdges(knpairs?: Array<[string, RadixNode<T>]>): RadixNodeEdges

- Defined in radix-node-edges.ts:11
example

const rne = new RadixNodeEdges([ ["aaa", new RadixNode()], ["bbb", new RadixNode()] ]);

Parameters
- Optional knpairs: Array<[string, RadixNode<T>]>
Returns RadixNodeEdges

Properties

firstCharToKeyMap

firstCharToKeyMap: Map<string, string>

m

m: Map<string, RadixNode<T>>

Accessors

size

get size(): number

- Defined in radix-node-edges.ts:83
get the number of elements (edges to other RadixNodes) in the map

Returns number

Methods

delete

delete(k: string): boolean

- Defined in radix-node-edges.ts:62
Delete a key from this RadixNodeEdges. Cannot corrupt the state of the edges list.

Parameters
- k: string
Returns boolean

entries

entries(): IterableIterator<[string, RadixNode<T>]>

- Defined in radix-node-edges.ts:89
A generator over all [key, node] pairs in the map. Returns pairs of values of the same type as those that were added to the map via set(k, v)

Returns IterableIterator<[string, RadixNode<T>]>

findKeyHavingSharedPrefix

findKeyHavingSharedPrefix(prefix: string): string | undefined

- Defined in radix-node-edges.ts:36
Parameters
- prefix: string
Returns string | undefined

either the matching key or undefined if no matching key

get

get(k: string): RadixNode<T>

- Defined in radix-node-edges.ts:44
Get the RadixNode associated to a key k

Parameters
- k: string
Returns RadixNode<T>

has

has(k: string): boolean

- Defined in radix-node-edges.ts:78
Check if a there are is an edge associated to a particular key.

Parameters
- k: string
Returns boolean

keys

keys(): IterableIterator<string>

- Defined in radix-node-edges.ts:94
A generator over all keys inserted into the map via set(k, v)

Returns IterableIterator<string>

set

set(k: string, v: RadixNode<T>): void

- Defined in radix-node-edges.ts:51
Set an association between a key k and a RadixNode

Parameters
- k: string
- v: RadixNode<T>
Returns void

values

values(): IterableIterator<RadixNode<T>>

- Defined in radix-node-edges.ts:99
A generator over all values inserted into the map via set(k, v)

Returns IterableIterator<RadixNode<T>>

Generated using TypeDoc