Class AbstractTrieMap<V>Abstract

Abstract base class for implementing trie-based map data structures. Provides the core interface for associating values with string keys efficiently.

A trie-map combines the prefix-matching capabilities of tries with key-value storage, similar to how a Map associates values with keys, but optimized for string-based keys.

Example

class MyTrieMap extends AbstractTrieMap {
  // Implement abstract methods
}

Type Parameters

  • V extends unknown = unknown

    The type of values stored in the trie-map.

Hierarchy (View Summary)

Constructors

constructor

Accessors

size

Methods

[iterator] clear delete entries find forEach get has keys set values

Constructors

constructor

Accessors

Abstractsize

Methods

Abstract[iterator]

  • "[iterator]"(reversed: boolean): Generator<[string, V], void, void>

    Makes the AbstractTrieMap iterable.

    Parameters

    • reversed: boolean

      If true, entries are yielded in reverse insertion order.

    Returns Generator<[string, V], void, void>

    An iterator for the trie-map's entries.

Abstractclear

Abstractdelete

  • delete(word: string): boolean

    Removes an entry from the trie-map.

    Parameters

    • word: string

      The key of the entry to remove.

    Returns boolean

    true if the entry was found and removed, false if not found.

Abstractentries

  • entries(reversed: boolean): Generator<[string, V], void, void>

    Returns an iterator for the entries in the trie-map.

    Parameters

    • reversed: boolean

      If true, entries are yielded in reverse order.

    Returns Generator<[string, V], void, void>

    An iterator of the trie's entries.

Abstractfind

  • find(prefix: string): [string, V][]

    Finds all entries whose keys start with the given prefix.

    Parameters

    • prefix: string

      The prefix to search for.

    Returns [string, V][]

    An array of matching [word, value] pairs.

AbstractforEach

  • forEach(
        callback: (value: V, word: string, trieMap: AbstractTrieMap<V>) => void,
        thisArg?: any,
    ): void

    Executes a callback function for each entry in the trie-map.

    Parameters

    • callback: (value: V, word: string, trieMap: AbstractTrieMap<V>) => void
        • (value: V, word: string, trieMap: AbstractTrieMap<V>): void

        • Parameters

          • value: V

            The value of the current entry.

          • word: string

            The word of the current entry.

          • trieMap: AbstractTrieMap<V>

            The trie-map instance being traversed.

          Returns void

    • OptionalthisArg: any

      Param: thisArg

      Optional value to use as this in the callback.

    Returns void

Abstractget

  • get(word: string): undefined | V

    Retrieves the value associated with a given key.

    Parameters

    • word: string

      The key to look up.

    Returns undefined | V

    The associated value if found, undefined otherwise.

Abstracthas

  • has(word: string): boolean

    Checks if an entry with the specified key exists in the trie-map.

    Parameters

    • word: string

      The key to check.

    Returns boolean

    true if an entry with the key exists, false otherwise.

Abstractkeys

  • keys(reversed: boolean): Generator<string, void, void>

    Returns an iterator for the keys of the entries in the trie-map.

    Parameters

    • reversed: boolean

      If true, keys are yielded in reverse order.

    Returns Generator<string, void, void>

    An iterator of the trie-map's entries keys.

Abstractset

  • set(word: string, value: V): void

    Adds or updates an entry in the trie-map.

    Parameters

    • word: string

      The key for the entry.

    • value: V

      The value to associate with the key.

    Returns void

Abstractvalues

  • values(reversed: boolean): Generator<V, void, void>

    Returns an iterator for the values of the entries in the trie-map.

    Parameters

    • reversed: boolean

      If true, values are yielded in reverse order.

    Returns Generator<V, void, void>

    An iterator of the trie-map's entries values.

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods