Class TreeMultiMap<K, V, R>

Red-Black Tree–based multimap (key → array of values). Preserves O(log N) updates and supports map-like mode.

Remarks

Time O(1), Space O(1)

Example

// players ranked by score with their equipment
    type Equipment = {
      name: string; // Equipment name
      quality: 'legendary' | 'epic' | 'rare' | 'common';
      level: number;
    };

    type Player = {
      name: string;
      score: number;
      equipments: Equipment[];
    };

    // Mock player data with their scores and equipment
    const players: Player[] = [
      {
        name: 'DragonSlayer',
        score: 8750,
        equipments: [
          { name: 'AWM', quality: 'legendary', level: 85 },
          { name: 'Level 3 Helmet', quality: 'epic', level: 80 },
          { name: 'Extended Quickdraw Mag', quality: 'rare', level: 75 },
          { name: 'Compensator', quality: 'epic', level: 78 },
          { name: 'Vertical Grip', quality: 'rare', level: 72 }
        ]
      },
      {
        name: 'ShadowNinja',
        score: 7200,
        equipments: [
          { name: 'M416', quality: 'epic', level: 75 },
          { name: 'Ghillie Suit', quality: 'rare', level: 70 },
          { name: 'Red Dot Sight', quality: 'common', level: 65 },
          { name: 'Extended QuickDraw Mag', quality: 'rare', level: 68 }
        ]
      },
      {
        name: 'RuneMaster',
        score: 9100,
        equipments: [
          { name: 'KAR98K', quality: 'legendary', level: 90 },
          { name: 'Level 3 Vest', quality: 'legendary', level: 85 },
          { name: 'Holographic Sight', quality: 'epic', level: 82 },
          { name: 'Suppressor', quality: 'legendary', level: 88 },
          { name: 'Level 3 Backpack', quality: 'epic', level: 80 }
        ]
      },
      {
        name: 'BattleKing',
        score: 8500,
        equipments: [
          { name: 'AUG', quality: 'epic', level: 82 },
          { name: 'Red Dot Sight', quality: 'rare', level: 75 },
          { name: 'Extended Mag', quality: 'common', level: 70 },
          { name: 'Tactical Stock', quality: 'rare', level: 76 }
        ]
      },
      {
        name: 'SniperElite',
        score: 7800,
        equipments: [
          { name: 'M24', quality: 'legendary', level: 88 },
          { name: 'Compensator', quality: 'epic', level: 80 },
          { name: 'Scope 8x', quality: 'legendary', level: 85 },
          { name: 'Level 2 Helmet', quality: 'rare', level: 75 }
        ]
      },
      {
        name: 'RushMaster',
        score: 7500,
        equipments: [
          { name: 'Vector', quality: 'rare', level: 72 },
          { name: 'Level 2 Helmet', quality: 'common', level: 65 },
          { name: 'Quickdraw Mag', quality: 'common', level: 60 },
          { name: 'Laser Sight', quality: 'rare', level: 68 }
        ]
      },
      {
        name: 'GhostWarrior',
        score: 8200,
        equipments: [
          { name: 'SCAR-L', quality: 'epic', level: 78 },
          { name: 'Extended Quickdraw Mag', quality: 'rare', level: 70 },
          { name: 'Holographic Sight', quality: 'epic', level: 75 },
          { name: 'Suppressor', quality: 'rare', level: 72 },
          { name: 'Vertical Grip', quality: 'common', level: 65 }
        ]
      },
      {
        name: 'DeathDealer',
        score: 7300,
        equipments: [
          { name: 'SKS', quality: 'epic', level: 76 },
          { name: 'Holographic Sight', quality: 'rare', level: 68 },
          { name: 'Extended Mag', quality: 'common', level: 65 }
        ]
      },
      {
        name: 'StormRider',
        score: 8900,
        equipments: [
          { name: 'MK14', quality: 'legendary', level: 92 },
          { name: 'Level 3 Backpack', quality: 'legendary', level: 85 },
          { name: 'Scope 8x', quality: 'epic', level: 80 },
          { name: 'Suppressor', quality: 'legendary', level: 88 },
          { name: 'Tactical Stock', quality: 'rare', level: 75 }
        ]
      },
      {
        name: 'CombatLegend',
        score: 7600,
        equipments: [
          { name: 'UMP45', quality: 'rare', level: 74 },
          { name: 'Level 2 Vest', quality: 'common', level: 67 },
          { name: 'Red Dot Sight', quality: 'common', level: 62 },
          { name: 'Extended Mag', quality: 'rare', level: 70 }
        ]
      }
    ];

    // Create a TreeMultiMap for player rankings
    const playerRankings = new TreeMultiMap<number, Equipment, Player>(players, {
      toEntryFn: ({ score, equipments }) => [score, equipments],
      isMapMode: false
    });

    const topPlayersEquipments = playerRankings.rangeSearch([8900, 10000], node => playerRankings.get(node));
    console.log(topPlayersEquipments); // [
 //      [
 //        {
 //          name: 'MK14',
 //          quality: 'legendary',
 //          level: 92
 //        },
 //        { name: 'Level 3 Backpack', quality: 'legendary', level: 85 },
 //        {
 //          name: 'Scope 8x',
 //          quality: 'epic',
 //          level: 80
 //        },
 //        { name: 'Suppressor', quality: 'legendary', level: 88 },
 //        {
 //          name: 'Tactical Stock',
 //          quality: 'rare',
 //          level: 75
 //        }
 //      ],
 //      [
 //        { name: 'KAR98K', quality: 'legendary', level: 90 },
 //        {
 //          name: 'Level 3 Vest',
 //          quality: 'legendary',
 //          level: 85
 //        },
 //        { name: 'Holographic Sight', quality: 'epic', level: 82 },
 //        {
 //          name: 'Suppressor',
 //          quality: 'legendary',
 //          level: 88
 //        },
 //        { name: 'Level 3 Backpack', quality: 'epic', level: 80 }
 //      ]
 //    ]

Type Parameters

K = any
V = any
R extends object = object

Hierarchy (view full)

RedBlackTree<K, V[], R>
- TreeMultiMap

Implements

IBinaryTree<K, V[], R>

Index

Constructors

constructor

new TreeMultiMap<K, V, R>(keysNodesEntriesOrRaws?, options?): TreeMultiMap<K, V, R>
Create a TreeMultiMap and optionally bulk-insert items.
Type Parameters
- K = any
- V = any
- R extends object = object
Parameters
- OptionalkeysNodesEntriesOrRaws: Iterable<
      | undefined
      | null
      | K
      | R
      | TreeMultiMapNode<K, V>
      | [undefined | null | K, undefined | V[]], any, any> = []
  Iterable of keys/nodes/entries/raw items to insert.
- Optionaloptions: TreeMultiMapOptions<K, V[], R>
  Options for TreeMultiMap (comparator, reverse, map mode).
Returns TreeMultiMap<K, V, R>
New TreeMultiMap instance.

Remarks
Time O(N log N), Space O(N)
Overrides RedBlackTree<K, V[], R>.constructor
- Defined in data-structures/binary-tree/tree-multi-map.ts:264

Properties

`Protected`_comparator

_comparator: Comparator<K> = ...

The default comparator function.

Remarks

Time O(1) (or O(C) if specifyComparable is used, C is complexity of that function).

Accessors

comparator

get comparator(): Comparator<K>
Gets the comparator function used by the tree.

Returns Comparator<K>
The comparator function.

Remarks
Time O(1)
Inherited from RedBlackTree.comparator
- Defined in data-structures/binary-tree/bst.ts:250

isDuplicate

get isDuplicate(): boolean
Gets whether the tree allows duplicate keys.

Returns boolean
True if duplicates are allowed, false otherwise.

Remarks
Time O(1)
Implementation of IBinaryTree.isDuplicate
Inherited from RedBlackTree.isDuplicate
- Defined in data-structures/binary-tree/binary-tree.ts:321

isMapMode

get isMapMode(): boolean
Gets whether the tree is in Map mode.

Returns boolean
True if in Map mode, false otherwise.

Remarks
In Map mode (default), values are stored in an external Map, and nodes only hold keys. If false, values are stored directly on the nodes. Time O(1)
Implementation of IBinaryTree.isMapMode
Inherited from RedBlackTree.isMapMode
- Defined in data-structures/binary-tree/binary-tree.ts:309

isReverse

get isReverse(): boolean
Gets whether the tree's comparison logic is reversed.

Returns boolean
True if the tree is reversed (e.g., a max-heap logic).

Remarks
Time O(1)
Inherited from RedBlackTree.isReverse
- Defined in data-structures/binary-tree/bst.ts:215

NIL

get NIL(): BinaryTreeNode<K, V>
Gets the sentinel NIL node (used in self-balancing trees like Red-Black Tree).

Returns BinaryTreeNode<K, V>
The NIL node.

Remarks
Time O(1)
Implementation of IBinaryTree.NIL
Inherited from RedBlackTree.NIL
- Defined in data-structures/binary-tree/binary-tree.ts:369

root

get root(): undefined | RedBlackTreeNode<K, V>
Get the current root node.

Returns undefined | RedBlackTreeNode<K, V>
Root node, or undefined.

Remarks
Time O(1), Space O(1)
Implementation of IBinaryTree.root
Inherited from RedBlackTree.root
- Defined in data-structures/binary-tree/red-black-tree.ts:170

size

get size(): number
Gets the number of nodes in the tree.

Returns number
The size of the tree.

Remarks
Time O(1)
Implementation of IBinaryTree.size
Inherited from RedBlackTree.size
- Defined in data-structures/binary-tree/binary-tree.ts:357

specifyComparable

get specifyComparable(): undefined | ((key: K) => Comparable)
Gets the function used to extract a comparable value from a complex key.

Returns undefined | ((key: K) => Comparable)
The key-to-comparable conversion function.

Remarks
Time O(1)
Inherited from RedBlackTree.specifyComparable
- Defined in data-structures/binary-tree/bst.ts:262

store

get store(): Map<K, undefined | V>
Gets the external value store (used in Map mode).

Returns Map<K, undefined | V>
The map storing key-value pairs.

Remarks
Time O(1)
Implementation of IBinaryTree.store
Inherited from RedBlackTree.store
- Defined in data-structures/binary-tree/binary-tree.ts:333

toEntryFn

get toEntryFn(): undefined | ToEntryFn<K, V, R>
Gets the function used to convert raw data objects (R) into [key, value] entries.

Returns undefined | ToEntryFn<K, V, R>
The conversion function.

Remarks
Time O(1)
Implementation of IBinaryTree.toEntryFn
Inherited from RedBlackTree.toEntryFn
- Defined in data-structures/binary-tree/binary-tree.ts:381

Methods

`Protected`_clearNodes

_clearNodes(): void
(Protected) Clears all nodes from the tree.

Returns void
Remarks
Time O(1)
Inherited from RedBlackTree._clearNodes
- Defined in data-structures/binary-tree/binary-tree.ts:2306

`Protected`_clearValues

_clearValues(): void
(Protected) Clears all values from the external store.

Returns void
Remarks
Time O(N)
Inherited from RedBlackTree._clearValues
- Defined in data-structures/binary-tree/binary-tree.ts:2315

`Protected`_clone

_clone(cloned): void
(Protected) Helper for cloning. Performs a BFS and adds all nodes to the new tree.
Parameters
- cloned: BinaryTree<K, V[], R>
  The new, empty tree instance to populate.
Returns void
Remarks
Time O(N * M) (O(N) BFS + O(M) add for each node).
Inherited from RedBlackTree._clone
- Defined in data-structures/binary-tree/binary-tree.ts:2036

`Protected`_compare

_compare(a, b): number
(Protected) Compares two keys using the tree's comparator and reverse setting.
Parameters
- a: K
  The first key.
- b: K
  The second key.
Returns number
A number (1, -1, or 0) representing the comparison.

Remarks
Time O(1) (or O(C) if specifyComparable is used).
Inherited from RedBlackTree._compare
- Defined in data-structures/binary-tree/bst.ts:948

`Protected`_createInstance

_createInstance<TK, TV, TR>(options?): this
(Protected) Create an empty instance of the same concrete class.
Type Parameters
- TK = K
- TV = V
- TR extends object = R
Parameters
- Optionaloptions: Partial<RedBlackTreeOptions<TK, TV, TR>>
  Optional constructor options for the like-kind instance.
Returns this
An empty like-kind instance.

Remarks
Time O(1), Space O(1)
Overrides RedBlackTree._createInstance
- Defined in data-structures/binary-tree/tree-multi-map.ts:411

`Protected`_createLike

_createLike<TK, TV, TR>(iter?, options?): RedBlackTree<TK, TV, TR>
(Protected) Create a like-kind instance and seed it from an iterable.
Type Parameters
- TK = K
- TV = V
- TR extends object = R
Parameters
- iter: Iterable<
      | undefined
      | null
      | TK
      | TR
      | RedBlackTreeNode<TK, TV>
      | [undefined | null | TK, undefined | TV], any, any> = []
  Iterable used to seed the new tree.
- Optionaloptions: Partial<RedBlackTreeOptions<TK, TV, TR>>
  Options merged with the current snapshot.
Returns RedBlackTree<TK, TV, TR>
A like-kind RedBlackTree built from the iterable.

Remarks
Time O(N log N), Space O(N)
Overrides RedBlackTree._createLike
- Defined in data-structures/binary-tree/tree-multi-map.ts:431

_createNode

_createNode(key, value?): TreeMultiMapNode<K, V>
Create a red-black node for the given key/value (value ignored in map mode).
Parameters
- key: K
  See parameter type for details.
- value: V[] = []
  See parameter type for details.
Returns TreeMultiMapNode<K, V>
A new RedBlackTreeNode instance.

Remarks
Time O(1), Space O(1)
Implementation of IBinaryTree._createNode
Overrides RedBlackTree._createNode
- Defined in data-structures/binary-tree/tree-multi-map.ts:276

`Protected`_DEFAULT_NODE_CALLBACK

_DEFAULT_NODE_CALLBACK(node): undefined | K
(Protected) Default callback function, returns the node's key.
Parameters
- node: undefined | null | BinaryTreeNode<K, V[]>
  The node.
Returns undefined | K
The node's key or undefined.

Remarks
Time O(1)
Inherited from RedBlackTree._DEFAULT_NODE_CALLBACK
- Defined in data-structures/binary-tree/binary-tree.ts:1942

`Protected`_deleteFixup

_deleteFixup(node): void
(Protected) Restore red-black properties after deletion (recolor/rotate).
Parameters
- node: undefined | RedBlackTreeNode<K, V[]>
  Child that replaced the deleted node (may be undefined).
Returns void
void

Remarks
Time O(log n), Space O(1)
Inherited from RedBlackTree._deleteFixup
- Defined in data-structures/binary-tree/red-black-tree.ts:505

`Protected`_dfs

_dfs<C>(callback, pattern?, onlyOne?, startNode?, iterationType?, includeNull?, shouldVisitLeft?, shouldVisitRight?, shouldVisitRoot?, shouldProcessRoot?): ReturnType<C>[]
Type Parameters
- C extends NodeCallback<BinaryTreeNode<K, V[]>>
  Callback type.
Parameters
- callback: C
  Function to call on nodes.
- Optionalpattern: DFSOrderPattern
  Traversal order.
- OptionalonlyOne: boolean
  Stop after first match.
- OptionalstartNode:
      | null
      | K
      | BinaryTreeNode<K, V[]>
      | [undefined | null | K, undefined | V[]]
  Starting node.
- OptionaliterationType: IterationType
  Traversal method.
- OptionalincludeNull: boolean
  Include nulls.
- OptionalshouldVisitLeft: ((node: undefined | null | BinaryTreeNode<K, V[]>) => boolean)
  Predicate to traverse left.
  - - (node): boolean
    - Parameters
      node: undefined | null | BinaryTreeNode<K, V[]>
      Returns boolean
- OptionalshouldVisitRight: ((node: undefined | null | BinaryTreeNode<K, V[]>) => boolean)
  Predicate to traverse right.
  - - (node): boolean
    - Parameters
      node: undefined | null | BinaryTreeNode<K, V[]>
      Returns boolean
- OptionalshouldVisitRoot: ((node: undefined | null | BinaryTreeNode<K, V[]>) => boolean)
  Predicate to visit root.
  - - (node): boolean
    - Parameters
      node: undefined | null | BinaryTreeNode<K, V[]>
      Returns boolean
- OptionalshouldProcessRoot: ((node: undefined | null | BinaryTreeNode<K, V[]>) => boolean)
  Predicate to process root.
  - - (node): boolean
    - Parameters
      node: undefined | null | BinaryTreeNode<K, V[]>
      Returns boolean
Returns ReturnType<C>[]
Array of callback results.
Inherited from RedBlackTree._dfs
- Defined in data-structures/binary-tree/binary-tree.ts:1751

`Protected`_displayAux

_displayAux(node, options): NodeDisplayLayout
(Protected) Recursive helper for toVisual.
Parameters
- node: undefined | null | BinaryTreeNode<K, V[]>
  The current node.
- options: BinaryTreePrintOptions
  Print options.
Returns NodeDisplayLayout
Layout information for this subtree.

Remarks
Time O(N), Space O(N*H) or O(N^2)
Inherited from RedBlackTree._displayAux
- Defined in data-structures/binary-tree/binary-tree.ts:2061

`Protected`_ensurePredicate

_ensurePredicate(keyNodeEntryOrPredicate): NodePredicate<BinaryTreeNode<K, V[]>>
(Protected) Converts a key, node, entry, or predicate into a standardized predicate function.
Parameters
- keyNodeEntryOrPredicate:
      | undefined
      | null
      | K
      | BinaryTreeNode<K, V[]>
      | [undefined | null | K, undefined | V[]]
      | NodePredicate<BinaryTreeNode<K, V[]>>
  The item to convert.
Returns NodePredicate<BinaryTreeNode<K, V[]>>
A predicate function.

Remarks
Time O(1)
Inherited from RedBlackTree._ensurePredicate
- Defined in data-structures/binary-tree/binary-tree.ts:2215

`Protected`_extractKey

_extractKey(keyNodeOrEntry): undefined | null | K
(Protected) Extracts the key from a key, node, or entry.
Parameters
- keyNodeOrEntry:
      | undefined
      | null
      | K
      | BinaryTreeNode<K, V[]>
      | [undefined | null | K, undefined | V[]]
  The item.
Returns undefined | null | K
The extracted key.

Remarks
Time O(1)
Inherited from RedBlackTree._extractKey
- Defined in data-structures/binary-tree/binary-tree.ts:2275

`Protected`_getIterator

_getIterator(node?): IterableIterator<[K, undefined | V[]], any, any>
(Protected) Gets the iterator for the tree (default in-order).
Parameters
- Optionalnode: null | BinaryTreeNode<K, V[]> = ...
  The node to start iteration from.
Returns IterableIterator<[K, undefined | V[]], any, any>
An iterator for [key, value] pairs.

Remarks
Time O(N) for full iteration. O(H) to get the first element. Space O(H) for the iterative stack. O(H) for recursive stack.
Inherited from RedBlackTree._getIterator
- Defined in data-structures/binary-tree/binary-tree.ts:1896

`Protected`_insert

_insert(node): CRUD
(Protected) Standard BST insert followed by red-black fix-up.
Parameters
- node: RedBlackTreeNode<K, V[]>
  Node to insert.
Returns CRUD
Status string: 'CREATED' or 'UPDATED'.

Remarks
Time O(log n), Space O(1)
Inherited from RedBlackTree._insert
- Defined in data-structures/binary-tree/red-black-tree.ts:387

`Protected`_insertFixup

_insertFixup(z): void
(Protected) Restore red-black properties after insertion (recolor/rotate).
Parameters
- z: undefined | RedBlackTreeNode<K, V[]>
  Recently inserted node.
Returns void
void

Remarks
Time O(log n), Space O(1)
Inherited from RedBlackTree._insertFixup
- Defined in data-structures/binary-tree/red-black-tree.ts:451

`Protected`_isPredicate

_isPredicate(p): p is NodePredicate<BinaryTreeNode<K, V[]>>
(Protected) Checks if an item is a predicate function.
Parameters
- p: any
  The item to check.
Returns p is NodePredicate<BinaryTreeNode<K, V[]>>
True if it's a function.

Remarks
Time O(1)
Inherited from RedBlackTree._isPredicate
- Defined in data-structures/binary-tree/binary-tree.ts:2264

`Protected`_keyValueNodeOrEntryToNodeAndValue

_keyValueNodeOrEntryToNodeAndValue(keyNodeOrEntry, value?): [OptNode<BSTNode<K, V[]>>, undefined | V[]]
(Protected) Converts a key, node, or entry into a standardized [node, value] tuple.
Parameters
- keyNodeOrEntry:
      | undefined
      | null
      | K
      | BSTNode<K, V[]>
      | [undefined | null | K, undefined | V[]]
  The input item.
- Optionalvalue: V[]
  An optional value (used if input is just a key).
Returns [OptNode<BSTNode<K, V[]>>, undefined | V[]]
A tuple of [node, value].

Remarks
Time O(1)
Inherited from RedBlackTree._keyValueNodeOrEntryToNodeAndValue
- Defined in data-structures/binary-tree/bst.ts:920

`Protected`_leftRotate

_leftRotate(x): void
(Protected) Perform a left rotation around x.
Parameters
- x: undefined | RedBlackTreeNode<K, V[]>
  Pivot node to rotate around.
Returns void
void

Remarks
Time O(1), Space O(1)
Inherited from RedBlackTree._leftRotate
- Defined in data-structures/binary-tree/red-black-tree.ts:575

`Protected`_replaceNode

_replaceNode(oldNode, newNode): RedBlackTreeNode<K, V[]>
(Protected) Replaces a node in the tree with a new node, maintaining children and parent links.
Parameters
- oldNode: RedBlackTreeNode<K, V[]>
  The node to be replaced.
- newNode: RedBlackTreeNode<K, V[]>
  The node to insert.
Returns RedBlackTreeNode<K, V[]>
The newNode.

Remarks
Time O(1)
Inherited from RedBlackTree._replaceNode
- Defined in data-structures/binary-tree/red-black-tree.ts:371

`Protected`_rightRotate

_rightRotate(y): void
(Protected) Perform a right rotation around y.
Parameters
- y: undefined | RedBlackTreeNode<K, V[]>
  Pivot node to rotate around.
Returns void
void

Remarks
Time O(1), Space O(1)
Inherited from RedBlackTree._rightRotate
- Defined in data-structures/binary-tree/red-black-tree.ts:608

`Protected`_setRoot

_setRoot(v): void
(Protected) Sets the root node and clears its parent reference.
Parameters
- v: undefined | RedBlackTreeNode<K, V[]>
  The node to set as root.
Returns void
Remarks
Time O(1)
Inherited from RedBlackTree._setRoot
- Defined in data-structures/binary-tree/red-black-tree.ts:364

`Protected`_setValue

_setValue(key, value): false | Map<K, undefined | V[]>
(Protected) Sets a value in the external store (Map mode).
Parameters
- key: undefined | null | K
  The key.
- value: undefined | V[]
  The value.
Returns false | Map<K, undefined | V[]>
True if successful.

Remarks
Time O(1) (average for Map.set).
Inherited from RedBlackTree._setValue
- Defined in data-structures/binary-tree/binary-tree.ts:2296

`Protected`_snapshotOptions

_snapshotOptions<TK, TV, TR>(): BSTOptions<TK, TV, TR>
(Protected) Snapshots the current BST's configuration options.
Type Parameters
- TK = K
- TV = V[]
- TR extends object = R
Returns BSTOptions<TK, TV, TR>
The options object.

Remarks
Time O(1)
Inherited from RedBlackTree._snapshotOptions
- Defined in data-structures/binary-tree/bst.ts:904

`Protected`_swapProperties

_swapProperties(srcNode, destNode): undefined | BinaryTreeNode<K, V[]>
(Protected) Swaps the key/value properties of two nodes.
Parameters
- srcNode:
      | undefined
      | null
      | K
      | BinaryTreeNode<K, V[]>
      | [undefined | null | K, undefined | V[]]
  The source node.
- destNode:
      | undefined
      | null
      | K
      | BinaryTreeNode<K, V[]>
      | [undefined | null | K, undefined | V[]]
  The destination node.
Returns undefined | BinaryTreeNode<K, V[]>
The destNode (now holding srcNode's properties).

Remarks
Time O(1)
Inherited from RedBlackTree._swapProperties
- Defined in data-structures/binary-tree/binary-tree.ts:2143

`Protected`_transplant

_transplant(u, v): void
(Protected) Transplant a subtree in place of another during deletion.
Parameters
- u: RedBlackTreeNode<K, V[]>
  Node to replace.
- v: undefined | RedBlackTreeNode<K, V[]>
  Replacement subtree root (may be undefined).
Returns void
void

Remarks
Time O(1), Space O(1)
Inherited from RedBlackTree._transplant
- Defined in data-structures/binary-tree/red-black-tree.ts:430

[iterator]

[iterator](...args): IterableIterator<[K, undefined | V[]], any, any>
Default iterator yielding [key, value] entries.
Parameters
- Rest...args: any[]
Returns IterableIterator<[K, undefined | V[]], any, any>
Iterator of [K, V].

Remarks
Time O(n) to iterate, Space O(1)
Implementation of IBinaryTree.[iterator]
Inherited from RedBlackTree.[iterator]
- Defined in data-structures/base/iterable-entry-base.ts:22

add

add(keyNodeOrEntry): boolean
Insert or replace an entry using BST order and red-black fix-up.
Parameters
- keyNodeOrEntry:
      | undefined
      | null
      | K
      | TreeMultiMapNode<K, V>
      | [undefined | null | K, undefined | V[]]
  Key, node, or [key, value] entry to insert.
Returns boolean
True if inserted or updated; false if ignored.

Remarks
Time O(log n), Space O(1)
Implementation of IBinaryTree.add
Overrides RedBlackTree.add
- Defined in data-structures/binary-tree/tree-multi-map.ts:280
add(key, value): boolean
Parameters
- key: K
- value: V
Returns boolean
Implementation of IBinaryTree.add
Overrides RedBlackTree.add
- Defined in data-structures/binary-tree/tree-multi-map.ts:284

addMany

addMany(keysNodesEntriesOrRaws, values?, isBalanceAdd?, iterationType?): boolean[]
Adds multiple items to the tree.
Parameters
- keysNodesEntriesOrRaws: Iterable<R | BTNRep<K, V[], BSTNode<K, V[]>>, any, any>
  An iterable of items to add.
- Optionalvalues: Iterable<undefined | V[], any, any>
  An optional parallel iterable of values.
- OptionalisBalanceAdd: boolean = true
  If true, builds a balanced tree from the items.
- OptionaliterationType: IterationType = ...
  The traversal method for balanced add (recursive or iterative).
Returns boolean[]
An array of booleans indicating the success of each individual add operation.

Remarks
If isBalanceAdd is true, sorts the input and builds a balanced tree. Time O(N log N) (due to sort and balanced add). If false, adds items one by one. Time O(N * H), which is O(N^2) worst-case. Space O(N) for sorting and recursion/iteration stack.
Implementation of IBinaryTree.addMany
Inherited from RedBlackTree.addMany
- Defined in data-structures/binary-tree/bst.ts:579

bfs

bfs<C>(callback?, startNode?, iterationType?): ReturnType<C>[]
Performs a Breadth-First Search (BFS) or Level-Order traversal.
Type Parameters
- C extends NodeCallback<BSTNode<K, V[]>>
  The type of the callback function.
Parameters
- Optionalcallback: C = ...
  Function to call on each node.
- OptionalstartNode:
      | null
      | K
      | BSTNode<K, V[]>
      | [undefined | null | K, undefined | V[]] = ...
  The node to start from.
- OptionaliterationType: IterationType = ...
  The traversal method.
Returns ReturnType<C>[]
An array of callback results.

Remarks
Time O(N), visits every node. Space O(N) in the worst case for the queue.
Implementation of IBinaryTree.bfs
Inherited from RedBlackTree.bfs
- Defined in data-structures/binary-tree/bst.ts:349

clear

clear(): void
Remove all nodes and clear the key→value store (if in map mode).

Returns void
void

Remarks
Time O(n), Space O(1)
Implementation of IBinaryTree.clear
Inherited from RedBlackTree.clear
- Defined in data-structures/binary-tree/red-black-tree.ts:205

clone

clone(): this
Clones the tree.

Returns this
A new, cloned instance of the tree.

Remarks
Time O(N * M), where N is the number of nodes and M is the tree size during insertion (due to bfs + add, and add is O(M)). Space O(N) for the new tree and the BFS queue.
Implementation of IBinaryTree.clone
Inherited from RedBlackTree.clone
- Defined in data-structures/binary-tree/binary-tree.ts:1659

createTree

createTree(options?): this
Creates a new, empty tree of the same type and configuration.
Parameters
- Optionaloptions: Partial<BinaryTreeOptions<K, V[], R>>
  Optional overrides for the new tree's options.
Returns this
A new, empty tree instance.

Remarks
Time O(1) (excluding options cloning), Space O(1)
Implementation of IBinaryTree.createTree
Inherited from RedBlackTree.createTree
- Defined in data-structures/binary-tree/binary-tree.ts:404

delete

delete(keyNodeOrEntry): BinaryTreeDeleteResult<RedBlackTreeNode<K, V[]>>[]
Delete a node by key/node/entry and rebalance as needed.
Parameters
- keyNodeOrEntry:
      | undefined
      | null
      | K
      | RedBlackTreeNode<K, V[]>
      | [undefined | null | K, undefined | V[]]
  Key, node, or [key, value] entry identifying the node to delete.
Returns BinaryTreeDeleteResult<RedBlackTreeNode<K, V[]>>[]
Array with deletion metadata (removed node, rebalancing hint if any).

Remarks
Time O(log n), Space O(1)
Implementation of IBinaryTree.delete
Inherited from RedBlackTree.delete
- Defined in data-structures/binary-tree/red-black-tree.ts:250

deleteValue

deleteValue(keyNodeOrEntry, value): boolean
Delete a single value from the bucket at a given key. Removes the key if the bucket becomes empty.
Parameters
- keyNodeOrEntry:
      | undefined
      | null
      | K
      | TreeMultiMapNode<K, V>
      | [undefined | null | K, undefined | V[]]
  Key, node, or [key, values] entry to locate the bucket.
- value: V
  Value to remove from the bucket.
Returns boolean
True if the value was removed; false if not found.

Remarks
Time O(log N), Space O(1)
- Defined in data-structures/binary-tree/tree-multi-map.ts:351

deleteWhere

deleteWhere(predicate): boolean
Deletes the first node found that satisfies the predicate.
Parameters
- predicate: ((key: K, value: undefined | V[], index: number, tree: this) => boolean)
  A function to test each [key, value] pair.
  - - (key, value, index, tree): boolean
    - Parameters
      key: K
      value: undefined | V[]
      index: number
      tree: this
      Returns boolean
Returns boolean
True if a node was deleted, false otherwise.

Remarks
Performs an in-order traversal. Time O(N) worst-case (O(log N) to find + O(log N) to delete). Space O(log N) for stack.
Inherited from RedBlackTree.deleteWhere
- Defined in data-structures/binary-tree/bst.ts:835

dfs

dfs<C>(callback?, pattern?, onlyOne?, startNode?, iterationType?): ReturnType<C>[]
Performs a Depth-First Search (DFS) traversal.
Type Parameters
- C extends NodeCallback<BSTNode<K, V[]>>
  The type of the callback function.
Parameters
- Optionalcallback: C = ...
  Function to call on each node.
- Optionalpattern: DFSOrderPattern = 'IN'
  The traversal order ('IN', 'PRE', 'POST').
- OptionalonlyOne: boolean = false
  If true, stops after the first callback.
- OptionalstartNode:
      | null
      | K
      | BSTNode<K, V[]>
      | [undefined | null | K, undefined | V[]] = ...
  The node to start from.
- OptionaliterationType: IterationType = ...
  The traversal method.
Returns ReturnType<C>[]
An array of callback results.

Remarks
Time O(N), visits every node. Space O(log N) for the call/explicit stack. O(N) worst-case.
Implementation of IBinaryTree.dfs
Inherited from RedBlackTree.dfs
- Defined in data-structures/binary-tree/bst.ts:329

ensureNode

ensureNode(keyNodeOrEntry, iterationType?): OptNode<BSTNode<K, V[]>>
Ensures the input is a node. If it's a key or entry, it searches for the node.
Parameters
- keyNodeOrEntry:
      | undefined
      | null
      | K
      | BSTNode<K, V[]>
      | [undefined | null | K, undefined | V[]]
  The item to resolve to a node.
- OptionaliterationType: IterationType = ...
  The traversal method to use if searching.
Returns OptNode<BSTNode<K, V[]>>
The resolved node, or undefined if not found.

Remarks
Time O(log N) (height of the tree), O(N) worst-case.
Inherited from RedBlackTree.ensureNode
- Defined in data-structures/binary-tree/bst.ts:286

entries

entries(): IterableIterator<[K, undefined | V[]], any, any>
Iterate over [key, value] pairs (may yield undefined values).

Returns IterableIterator<[K, undefined | V[]], any, any>
Iterator of [K, V | undefined].

Remarks
Time O(n), Space O(1)
Implementation of IBinaryTree.entries
Inherited from RedBlackTree.entries
- Defined in data-structures/base/iterable-entry-base.ts:31

every

every(predicate, thisArg?): boolean
Test whether all entries satisfy the predicate.
Parameters
- predicate: EntryCallback<K, undefined | V[], boolean>
  (key, value, index, self) => boolean.
- OptionalthisArg: any
  Optional this for callback.
Returns boolean
true if all pass; otherwise false.

Remarks
Time O(n), Space O(1)
Implementation of IBinaryTree.every
Inherited from RedBlackTree.every
- Defined in data-structures/base/iterable-entry-base.ts:66

filter

filter(predicate, thisArg?): this
Creates a new tree containing only the entries that satisfy the predicate.
Parameters
- predicate: EntryCallback<K, undefined | V[], boolean>
  A function to test each [key, value] pair.
- OptionalthisArg: unknown
  this context for the predicate.
Returns this
A new, filtered tree.

Remarks
Time O(N * M), where N is nodes in this tree, and M is size of the new tree during insertion (O(N) iteration + O(M) add for each item). Space O(N) for the new tree.
Implementation of IBinaryTree.filter
Inherited from RedBlackTree.filter
- Defined in data-structures/binary-tree/binary-tree.ts:1673

find

find(callbackfn, thisArg?): undefined | [K, undefined | V[]]
Find the first entry that matches a predicate.
Parameters
- callbackfn: EntryCallback<K, undefined | V[], boolean>
  (key, value, index, self) => boolean.
- OptionalthisArg: any
  Optional this for callback.
Returns undefined | [K, undefined | V[]]
Matching [key, value] or undefined.

Remarks
Time O(n), Space O(1)
Implementation of IBinaryTree.find
Inherited from RedBlackTree.find
- Defined in data-structures/base/iterable-entry-base.ts:114

forEach

forEach(callbackfn, thisArg?): void
Visit each entry, left-to-right.
Parameters
- callbackfn: EntryCallback<K, undefined | V[], void>
  (key, value, index, self) => void.
- OptionalthisArg: any
  Optional this for callback.
Returns void
Remarks
Time O(n), Space O(1)
Implementation of IBinaryTree.forEach
Inherited from RedBlackTree.forEach
- Defined in data-structures/base/iterable-entry-base.ts:99

get

get(keyNodeEntryOrPredicate, startNode?, iterationType?): undefined | V[]
Gets the value associated with a key.
Parameters
- keyNodeEntryOrPredicate:
      | undefined
      | null
      | K
      | BinaryTreeNode<K, V[]>
      | [undefined | null | K, undefined | V[]]
  The key, node, or entry to get the value for.
- OptionalstartNode:
      | null
      | K
      | BinaryTreeNode<K, V[]>
      | [undefined | null | K, undefined | V[]] = ...
  The node to start searching from (if not in Map mode).
- OptionaliterationType: IterationType = ...
  The traversal method (if not in Map mode).
Returns undefined | V[]
The associated value, or undefined.

Remarks
Time O(log N), For BST, Red-Black Tree, and AVL Tree subclasses, the worst-case time is O(log N). Time O(1) if in Map mode. O(N) if not in Map mode (uses getNode). Space O(1) if in Map mode. O(H) or O(N) otherwise.
Implementation of IBinaryTree.get
Inherited from RedBlackTree.get
- Defined in data-structures/binary-tree/binary-tree.ts:884

getDepth

getDepth(dist, startNode?): number
Gets the depth of a node (distance from startNode).
Parameters
- dist:
      | undefined
      | null
      | K
      | BinaryTreeNode<K, V[]>
      | [undefined | null | K, undefined | V[]]
  The node to find the depth of.
- OptionalstartNode:
      | null
      | K
      | BinaryTreeNode<K, V[]>
      | [undefined | null | K, undefined | V[]] = ...
  The node to measure depth from (defaults to root).
Returns number
The depth (0 if dist is startNode).

Remarks
Time O(H), where H is the depth of the dist node relative to startNode. O(N) worst-case. Space O(1).
Implementation of IBinaryTree.getDepth
Inherited from RedBlackTree.getDepth
- Defined in data-structures/binary-tree/binary-tree.ts:1023

getHeight

getHeight(startNode?, iterationType?): number
Gets the maximum height of the tree (longest path from startNode to a leaf).
Parameters
- OptionalstartNode:
      | null
      | K
      | BinaryTreeNode<K, V[]>
      | [undefined | null | K, undefined | V[]] = ...
  The node to start measuring from.
- OptionaliterationType: IterationType = ...
  The traversal method.
Returns number
The height ( -1 for an empty tree, 0 for a single-node tree).

Remarks
Time O(N), as it must visit every node. Space O(H) for recursive stack (O(N) worst-case) or O(N) for iterative stack (storing node + depth).
Implementation of IBinaryTree.getHeight
Inherited from RedBlackTree.getHeight
- Defined in data-structures/binary-tree/binary-tree.ts:1048

getLeftMost

getLeftMost<C>(callback?, startNode?, iterationType?): ReturnType<C>
Finds the leftmost node in a subtree (the node with the smallest key in a BST).
Type Parameters
- C extends NodeCallback<undefined | BinaryTreeNode<K, V[]>>
  The type of the callback function.
Parameters
- Optionalcallback: C = ...
  A function to call on the leftmost node.
- OptionalstartNode:
      | null
      | K
      | BinaryTreeNode<K, V[]>
      | [undefined | null | K, undefined | V[]] = ...
  The subtree root to search from.
- OptionaliterationType: IterationType = ...
  The traversal method.
Returns ReturnType<C>
The callback result for the leftmost node.

Remarks
Time O(H), where H is the height of the left spine. O(N) worst-case. Space O(H) for recursive/trampoline stack.
Implementation of IBinaryTree.getLeftMost
Inherited from RedBlackTree.getLeftMost
- Defined in data-structures/binary-tree/binary-tree.ts:1175

getMinHeight

getMinHeight(startNode?, iterationType?): number
Gets the minimum height of the tree (shortest path from startNode to a leaf).
Parameters
- OptionalstartNode:
      | null
      | K
      | BinaryTreeNode<K, V[]>
      | [undefined | null | K, undefined | V[]] = ...
  The node to start measuring from.
- OptionaliterationType: IterationType = ...
  The traversal method.
Returns number
The minimum height (-1 for empty, 0 for single node).

Remarks
Time O(N), as it must visit every node. Space O(H) for recursive stack (O(N) worst-case) or O(N) for iterative (due to depths Map).
Implementation of IBinaryTree.getMinHeight
Inherited from RedBlackTree.getMinHeight
- Defined in data-structures/binary-tree/binary-tree.ts:1090

getNode

getNode(keyNodeEntryOrPredicate, startNode?, iterationType?): OptNode<BSTNode<K, V[]>>
Gets the first node matching a predicate.
Parameters
- keyNodeEntryOrPredicate:
      | undefined
      | null
      | K
      | BSTNode<K, V[]>
      | [undefined | null | K, undefined | V[]]
      | NodePredicate<BSTNode<K, V[]>>
  The key, node, entry, or predicate function to search for.
- OptionalstartNode: BSTNOptKeyOrNode<K, BSTNode<K, V[]>> = ...
  The node to start the search from.
- OptionaliterationType: IterationType = ...
  The traversal method.
Returns OptNode<BSTNode<K, V[]>>
The first matching node, or undefined if not found.

Remarks
Time O(log N) if searching by key, O(N) if searching by predicate. Space O(log N) or O(N).
Implementation of IBinaryTree.getNode
Inherited from RedBlackTree.getNode
- Defined in data-structures/binary-tree/bst.ts:384

getNodes

getNodes(keyNodeEntryOrPredicate, onlyOne?, startNode?, iterationType?): BinaryTreeNode<K, V[]>[]
Gets all nodes matching a predicate.
Parameters
- keyNodeEntryOrPredicate:
      | undefined
      | null
      | K
      | BinaryTreeNode<K, V[]>
      | [undefined | null | K, undefined | V[]]
      | NodePredicate<BinaryTreeNode<K, V[]>>
  The key, node, entry, or predicate function to search for.
- OptionalonlyOne: boolean
  If true, stops after finding the first match.
- OptionalstartNode:
      | null
      | K
      | BinaryTreeNode<K, V[]>
      | [undefined | null | K, undefined | V[]]
  The node to start the search from.
- OptionaliterationType: IterationType
  The traversal method.
Returns BinaryTreeNode<K, V[]>[]
An array of matching nodes.

Remarks
Time O(N) (via search). Space O(H) or O(N) (via search).
Inherited from RedBlackTree.getNodes
- Defined in data-structures/binary-tree/binary-tree.ts:824

getPathToRoot

getPathToRoot<C>(beginNode, callback?, isReverse?): ReturnType<C>[]
Gets the path from a given node up to the root.
Type Parameters
- C extends NodeCallback<undefined | BinaryTreeNode<K, V[]>>
  The type of the callback function.
Parameters
- beginNode:
      | undefined
      | null
      | K
      | BinaryTreeNode<K, V[]>
      | [undefined | null | K, undefined | V[]]
  The node to start the path from.
- Optionalcallback: C = ...
  A function to call on each node in the path.
- OptionalisReverse: boolean = false
  If true, returns the path from root-to-node.
Returns ReturnType<C>[]
An array of callback results.

Remarks
Time O(H), where H is the depth of the beginNode. O(N) worst-case. Space O(H) for the result array.
Implementation of IBinaryTree.getPathToRoot
Inherited from RedBlackTree.getPathToRoot
- Defined in data-structures/binary-tree/binary-tree.ts:1147

getPredecessor

getPredecessor(node): BinaryTreeNode<K, V[]>
Gets the Morris traversal predecessor (rightmost node in the left subtree, or node itself).
Parameters
- node: BinaryTreeNode<K, V[]>
  The node to find the predecessor for.
Returns BinaryTreeNode<K, V[]>
The Morris predecessor.

Remarks
This is primarily a helper for Morris traversal. Time O(H), where H is the height of the left subtree. O(N) worst-case. Space O(1).
Inherited from RedBlackTree.getPredecessor
- Defined in data-structures/binary-tree/binary-tree.ts:1249

getRightMost

getRightMost<C>(callback?, startNode?, iterationType?): ReturnType<C>
Finds the rightmost node in a subtree (the node with the largest key in a BST).
Type Parameters
- C extends NodeCallback<undefined | BinaryTreeNode<K, V[]>>
  The type of the callback function.
Parameters
- Optionalcallback: C = ...
  A function to call on the rightmost node.
- OptionalstartNode:
      | null
      | K
      | BinaryTreeNode<K, V[]>
      | [undefined | null | K, undefined | V[]] = ...
  The subtree root to search from.
- OptionaliterationType: IterationType = ...
  The traversal method.
Returns ReturnType<C>
The callback result for the rightmost node.

Remarks
Time O(H), where H is the height of the right spine. O(N) worst-case. Space O(H) for recursive/trampoline stack.
Implementation of IBinaryTree.getRightMost
Inherited from RedBlackTree.getRightMost
- Defined in data-structures/binary-tree/binary-tree.ts:1214

getSuccessor

getSuccessor(x?): undefined | null | BinaryTreeNode<K, V[]>
Gets the in-order successor of a node in a BST.
Parameters
- Optionalx: null | K | BinaryTreeNode<K, V[]>
  The node to find the successor of.
Returns undefined | null | BinaryTreeNode<K, V[]>
The successor node, or null/undefined if none exists.

Remarks
Time O(H), where H is the tree height. O(N) worst-case. Space O(H) (due to getLeftMost stack).
Inherited from RedBlackTree.getSuccessor
- Defined in data-structures/binary-tree/binary-tree.ts:1270

has

has(keyNodeEntryOrPredicate?, startNode?, iterationType?): boolean
Checks if a node matching the predicate exists in the tree.
Parameters
- OptionalkeyNodeEntryOrPredicate:
      | null
      | K
      | BinaryTreeNode<K, V[]>
      | [undefined | null | K, undefined | V[]]
      | NodePredicate<BinaryTreeNode<K, V[]>>
  The key, node, entry, or predicate to check for.
- OptionalstartNode:
      | null
      | K
      | BinaryTreeNode<K, V[]>
      | [undefined | null | K, undefined | V[]]
  The node to start the search from.
- OptionaliterationType: IterationType
  The traversal method.
Returns boolean
True if a matching node exists, false otherwise.

Remarks
Time O(log N), For BST, Red-Black Tree, and AVL Tree subclasses, the worst-case time is O(log N). Time O(N) in the worst case (via search). Space O(H) or O(N) (via search).
Implementation of IBinaryTree.has
Inherited from RedBlackTree.has
- Defined in data-structures/binary-tree/binary-tree.ts:906

hasValue

hasValue(value): boolean
Whether there exists an entry with the given value.
Parameters
- value: undefined | V[]
  Value to test.
Returns boolean
true if found; otherwise false.

Remarks
Time O(n), Space O(1)
Implementation of IBinaryTree.hasValue
Inherited from RedBlackTree.hasValue
- Defined in data-structures/base/iterable-entry-base.ts:143

isAVLBalanced

isAVLBalanced(iterationType?): boolean
Checks if the tree meets the AVL balance condition (height difference <= 1).
Parameters
- OptionaliterationType: IterationType = ...
  The traversal method.
Returns boolean
True if the tree is AVL balanced, false otherwise.

Remarks
Time O(N), as it must visit every node to compute height. Space O(log N) for recursion or O(N) for iterative map.
Inherited from RedBlackTree.isAVLBalanced
- Defined in data-structures/binary-tree/bst.ts:757

isBST

isBST(startNode?, iterationType?): boolean
Checks if the tree is a valid Binary Search Tree (BST).
Parameters
- OptionalstartNode:
      | null
      | K
      | BinaryTreeNode<K, V[]>
      | [undefined | null | K, undefined | V[]] = ...
  The node to start checking from.
- OptionaliterationType: IterationType = ...
  The traversal method.
Returns boolean
True if it's a valid BST, false otherwise.

Remarks
Time O(N), as it must visit every node. Space O(H) for the call stack (recursive) or explicit stack (iterative), where H is the tree height (O(N) worst-case).
Implementation of IBinaryTree.isBST
Inherited from RedBlackTree.isBST
- Defined in data-structures/binary-tree/binary-tree.ts:972

isEmpty

isEmpty(): boolean
Checks if the tree is empty.

Returns boolean
True if the tree has no nodes, false otherwise.

Remarks
Time O(1), Space O(1)
Implementation of IBinaryTree.isEmpty
Inherited from RedBlackTree.isEmpty
- Defined in data-structures/binary-tree/binary-tree.ts:947

isEntry

isEntry(keyNodeOrEntry): keyNodeOrEntry is BTNEntry<K, V[]>
Checks if the given item is a [key, value] entry pair.
Parameters
- keyNodeOrEntry:
      | undefined
      | null
      | K
      | BinaryTreeNode<K, V[]>
      | [undefined | null | K, undefined | V[]]
  The item to check.
Returns keyNodeOrEntry is BTNEntry<K, V[]>
True if it's an entry, false otherwise.

Remarks
Time O(1), Space O(1)
Inherited from RedBlackTree.isEntry
- Defined in data-structures/binary-tree/binary-tree.ts:541

isLeaf

isLeaf(keyNodeOrEntry): boolean
Checks if a node is a leaf (has no real children).
Parameters
- keyNodeOrEntry:
      | undefined
      | null
      | K
      | BinaryTreeNode<K, V[]>
      | [undefined | null | K, undefined | V[]]
  The node to check.
Returns boolean
True if the node is a leaf, false otherwise.

Remarks
Time O(N) if a key/entry is passed (due to ensureNode). O(1) if a node is passed. Space O(1) or O(H) (from ensureNode).
Inherited from RedBlackTree.isLeaf
- Defined in data-structures/binary-tree/binary-tree.ts:527

isNIL

isNIL(keyNodeOrEntry): boolean
Checks if the given item is the sentinel NIL node.
Parameters
- keyNodeOrEntry:
      | undefined
      | null
      | K
      | BinaryTreeNode<K, V[]>
      | [undefined | null | K, undefined | V[]]
  The item to check.
Returns boolean
True if it's the NIL node, false otherwise.

Remarks
Time O(1), Space O(1)
Inherited from RedBlackTree.isNIL
- Defined in data-structures/binary-tree/binary-tree.ts:496

isNode

isNode(keyNodeOrEntry): keyNodeOrEntry is RedBlackTreeNode<K, V[]>
Type guard: check whether the input is a RedBlackTreeNode.
Parameters
- keyNodeOrEntry:
      | undefined
      | null
      | K
      | RedBlackTreeNode<K, V[]>
      | [undefined | null | K, undefined | V[]]
  See parameter type for details.
Returns keyNodeOrEntry is RedBlackTreeNode<K, V[]>
True if the value is a RedBlackTreeNode.

Remarks
Time O(1), Space O(1)
Inherited from RedBlackTree.isNode
- Defined in data-structures/binary-tree/red-black-tree.ts:193

isPerfectlyBalanced

isPerfectlyBalanced(startNode?): boolean
Checks if the tree is perfectly balanced.
Parameters
- OptionalstartNode:
      | null
      | K
      | BinaryTreeNode<K, V[]>
      | [undefined | null | K, undefined | V[]] = ...
  The node to start checking from.
Returns boolean
True if perfectly balanced, false otherwise.

Remarks
A tree is perfectly balanced if the difference between min and max height is at most 1. Time O(N), as it requires two full traversals (getMinHeight and getHeight). Space O(H) or O(N) (from height calculation).
Implementation of IBinaryTree.isPerfectlyBalanced
Inherited from RedBlackTree.isPerfectlyBalanced
- Defined in data-structures/binary-tree/binary-tree.ts:958

isRange

isRange(keyNodeEntryOrPredicate): keyNodeEntryOrPredicate is Range<K>
Checks if the given item is a Range object.
Parameters
- keyNodeEntryOrPredicate:
      | undefined
      | null
      | K
      | BinaryTreeNode<K, V[]>
      | [undefined | null | K, undefined | V[]]
      | NodePredicate<BinaryTreeNode<K, V[]>>
      | Range<K>
  The item to check.
Returns keyNodeEntryOrPredicate is Range<K>
True if it's a Range, false otherwise.

Remarks
Time O(1), Space O(1)
Inherited from RedBlackTree.isRange
- Defined in data-structures/binary-tree/binary-tree.ts:507

isRaw

isRaw(keyNodeEntryOrRaw): keyNodeEntryOrRaw is R
Checks if the given item is a raw data object (R) that needs conversion via toEntryFn.
Parameters
- keyNodeEntryOrRaw:
      | undefined
      | null
      | K
      | R
      | BinaryTreeNode<K, V[]>
      | [undefined | null | K, undefined | V[]]
  The item to check.
Returns keyNodeEntryOrRaw is R
True if it's a raw object, false otherwise.

Remarks
Time O(1), Space O(1)
Inherited from RedBlackTree.isRaw
- Defined in data-structures/binary-tree/binary-tree.ts:456

isRealNode

isRealNode(keyNodeOrEntry): keyNodeOrEntry is BinaryTreeNode<K, V[]>
Checks if the given item is a "real" node (i.e., not null, undefined, or NIL).
Parameters
- keyNodeOrEntry:
      | undefined
      | null
      | K
      | BinaryTreeNode<K, V[]>
      | [undefined | null | K, undefined | V[]]
  The item to check.
Returns keyNodeOrEntry is BinaryTreeNode<K, V[]>
True if it's a real node, false otherwise.

Remarks
Time O(1), Space O(1)
Inherited from RedBlackTree.isRealNode
- Defined in data-structures/binary-tree/binary-tree.ts:469

isRealNodeOrNull

isRealNodeOrNull(keyNodeOrEntry): keyNodeOrEntry is null | BinaryTreeNode<K, V[]>
Checks if the given item is either a "real" node or null.
Parameters
- keyNodeOrEntry:
      | undefined
      | null
      | K
      | BinaryTreeNode<K, V[]>
      | [undefined | null | K, undefined | V[]]
  The item to check.
Returns keyNodeOrEntry is null | BinaryTreeNode<K, V[]>
True if it's a real node or null, false otherwise.

Remarks
Time O(1), Space O(1)
Inherited from RedBlackTree.isRealNodeOrNull
- Defined in data-structures/binary-tree/binary-tree.ts:483

isValidKey

isValidKey(key): key is K
Checks if the given key is valid (comparable).
Parameters
- key: any
  The key to validate.
Returns key is K
True if the key is valid, false otherwise.

Remarks
Time O(1)
Inherited from RedBlackTree.isValidKey
- Defined in data-structures/binary-tree/bst.ts:313

keys

keys(): IterableIterator<K, any, any>
Iterate over keys only.

Returns IterableIterator<K, any, any>
Iterator of keys.

Remarks
Time O(n), Space O(1)
Implementation of IBinaryTree.keys
Inherited from RedBlackTree.keys
- Defined in data-structures/base/iterable-entry-base.ts:42

leaves

leaves<C>(callback?, startNode?, iterationType?): ReturnType<C>[]
Finds all leaf nodes in the tree.
Type Parameters
- C extends NodeCallback<null | BinaryTreeNode<K, V[]>>
  The type of the callback function.
Parameters
- Optionalcallback: C = ...
  Function to call on each leaf node.
- OptionalstartNode:
      | null
      | K
      | BinaryTreeNode<K, V[]>
      | [undefined | null | K, undefined | V[]] = ...
  The node to start from.
- OptionaliterationType: IterationType = ...
  The traversal method.
Returns ReturnType<C>[]
An array of callback results.

Remarks
Time O(N), visits every node. Space O(H) for recursive stack or O(N) for iterative queue.
Implementation of IBinaryTree.leaves
Inherited from RedBlackTree.leaves
- Defined in data-structures/binary-tree/binary-tree.ts:1421

lesserOrGreaterTraverse

lesserOrGreaterTraverse<C>(callback?, lesserOrGreater?, targetNode?, iterationType?): ReturnType<C>[]
Traverses the tree and returns nodes that are lesser or greater than a target node.
Type Parameters
- C extends NodeCallback<BSTNode<K, V[]>>
  The type of the callback function.
Parameters
- Optionalcallback: C = ...
  Function to call on matching nodes.
- OptionallesserOrGreater: CP = -1
  1 for lesser, 1 for greater, 0 for equal.
- OptionaltargetNode:
      | null
      | K
      | BSTNode<K, V[]>
      | [undefined | null | K, undefined | V[]] = ...
  The node to compare against.
- OptionaliterationType: IterationType = ...
  The traversal method.
Returns ReturnType<C>[]
An array of callback results.

Remarks
Time O(N), as it performs a full traversal. Space O(log N) or O(N).
Inherited from RedBlackTree.lesserOrGreaterTraverse
- Defined in data-structures/binary-tree/bst.ts:681

listLevels

listLevels<C>(callback?, startNode?, iterationType?): ReturnType<C>[][]
Returns a 2D array of nodes, grouped by level.
Type Parameters
- C extends NodeCallback<BSTNode<K, V[]>>
  The type of the callback function.
Parameters
- Optionalcallback: C = ...
  Function to call on each node.
- OptionalstartNode:
      | null
      | K
      | BSTNode<K, V[]>
      | [undefined | null | K, undefined | V[]] = ...
  The node to start from.
- OptionaliterationType: IterationType = ...
  The traversal method.
Returns ReturnType<C>[][]
A 2D array of callback results.

Remarks
Time O(N), visits every node. Space O(N) for the result array and the queue/stack.
Implementation of IBinaryTree.listLevels
Inherited from RedBlackTree.listLevels
- Defined in data-structures/binary-tree/bst.ts:367

map

map<MK, MVArr, MR>(callback, options?, thisArg?): TreeMultiMap<MK, ElemOf<MVArr>, MR>
Transform entries into a like-kind red-black tree with possibly different key/value types.
Type Parameters
- MK = K
- MVArr extends unknown[] = V[]
- MR extends object = object
Parameters
- callback: EntryCallback<K, undefined | V[], [MK, MVArr]>
  Mapping function from (key, value, index, tree) to a new [key, value].
- Optionaloptions: Partial<RedBlackTreeOptions<MK, MVArr, MR>>
  See parameter type for details.
- OptionalthisArg: unknown
  See parameter type for details.
Returns TreeMultiMap<MK, ElemOf<MVArr>, MR>
A new RedBlackTree with mapped entries.

Remarks
Time O(n), Space O(n)
Implementation of IBinaryTree.map
Overrides RedBlackTree.map
- Defined in data-structures/binary-tree/tree-multi-map.ts:368
map<MK, MV, MR>(callback, options?, thisArg?): RedBlackTree<MK, MV, MR>
Type Parameters
- MK = K
- MV = V[]
- MR extends object = object
Parameters
- callback: EntryCallback<K, undefined | V[], [MK, MV]>
- Optionaloptions: Partial<RedBlackTreeOptions<MK, MV, MR>>
- OptionalthisArg: unknown
Returns RedBlackTree<MK, MV, MR>
Implementation of IBinaryTree.map
Overrides RedBlackTree.map
- Defined in data-structures/binary-tree/tree-multi-map.ts:374

merge

merge(anotherTree): void
Merges another tree into this one by adding all its nodes.
Parameters
- anotherTree: BinaryTree<K, V[], R>
  The tree to merge.
Returns void
Remarks
Time O(N * M), same as addMany, where N is the size of anotherTree and M is the size of this tree. Space O(M) (from add).
Implementation of IBinaryTree.merge
Inherited from RedBlackTree.merge
- Defined in data-structures/binary-tree/binary-tree.ts:665

morris

morris<C>(callback?, pattern?, startNode?): ReturnType<C>[]
Type Parameters
- C extends NodeCallback<BinaryTreeNode<K, V[]>>
  The type of the callback function.
Parameters
- Optionalcallback: C
  Function to call on each node.
- Optionalpattern: DFSOrderPattern
  The traversal order ('IN', 'PRE', 'POST').
- OptionalstartNode:
      | null
      | K
      | BinaryTreeNode<K, V[]>
      | [undefined | null | K, undefined | V[]]
  The node to start from.
Returns ReturnType<C>[]
An array of callback results.
Implementation of IBinaryTree.morris
Inherited from RedBlackTree.morris
- Defined in data-structures/binary-tree/binary-tree.ts:1537

perfectlyBalance

perfectlyBalance(iterationType?): boolean
Rebuilds the tree to be perfectly balanced.
Parameters
- OptionaliterationType: IterationType = ...
  The traversal method for the initial node export.
Returns boolean
True if successful, false if the tree was empty.

Remarks
Time O(N) (O(N) for DFS, O(N) for sorted build). Space O(N) for node array and recursion stack.
Inherited from RedBlackTree.perfectlyBalance
- Defined in data-structures/binary-tree/bst.ts:725

print

print(options?, startNode?): void
Prints a visual representation of the tree to the console.
Parameters
- Optionaloptions: BinaryTreePrintOptions
  Options to control the output.
- OptionalstartNode:
      | null
      | K
      | BinaryTreeNode<K, V[]>
      | [undefined | null | K, undefined | V[]] = ...
  The node to start printing from.
Returns void
Remarks
Time O(N) (via toVisual). Space O(N*H) or O(N^2) (via toVisual).
Inherited from RedBlackTree.print
- Defined in data-structures/binary-tree/binary-tree.ts:1744

rangeSearch

rangeSearch<C>(range, callback?, startNode?, iterationType?): ReturnType<C>[]
Performs an optimized search for nodes within a given key range.
Type Parameters
- C extends NodeCallback<BSTNode<K, V[]>>
  The type of the callback function.
Parameters
- range: Range<K> | [K, K]
  A Range object or a [low, high] tuple.
- Optionalcallback: C = ...
  A function to call on matching nodes.
- OptionalstartNode:
      | null
      | K
      | BSTNode<K, V[]>
      | [undefined | null | K, undefined | V[]] = ...
  The node to start the search from.
- OptionaliterationType: IterationType = ...
  The traversal method.
Returns ReturnType<C>[]
An array of callback results.

Remarks
Time O(H + M), where H is tree height and M is the number of matches.
Inherited from RedBlackTree.rangeSearch
- Defined in data-structures/binary-tree/bst.ts:505

reduce

reduce<U>(callbackfn, initialValue): U
Reduce entries into a single accumulator.
Type Parameters
- U
Parameters
- callbackfn: ReduceEntryCallback<K, undefined | V[], U>
  (acc, value, key, index, self) => acc.
- initialValue: U
  Initial accumulator.
Returns U
Final accumulator.

Remarks
Time O(n), Space O(1)
Implementation of IBinaryTree.reduce
Inherited from RedBlackTree.reduce
- Defined in data-structures/base/iterable-entry-base.ts:171

refill

refill(keysNodesEntriesOrRaws, values?): void
Clears the tree and refills it with new items.
Parameters
- keysNodesEntriesOrRaws: Iterable<
      | undefined
      | null
      | K
      | R
      | BinaryTreeNode<K, V[]>
      | [undefined | null | K, undefined | V[]], any, any>
  An iterable of items to add.
- Optionalvalues: Iterable<undefined | V[], any, any>
  An optional parallel iterable of values.
Returns void
Remarks
Time O(N) (for clear) + O(N * M) (for addMany) = O(N * M). Space O(M) (from addMany).
Implementation of IBinaryTree.refill
Inherited from RedBlackTree.refill
- Defined in data-structures/binary-tree/binary-tree.ts:676

search

search<C>(keyNodeEntryOrPredicate, onlyOne?, callback?, startNode?, iterationType?): ReturnType<C>[]
Searches the tree for nodes matching a predicate, key, or range.
Type Parameters
- C extends NodeCallback<BSTNode<K, V[]>>
  The type of the callback function.
Parameters
- keyNodeEntryOrPredicate:
      | undefined
      | null
      | K
      | BSTNode<K, V[]>
      | [undefined | null | K, undefined | V[]]
      | NodePredicate<BSTNode<K, V[]>>
      | Range<K>
  The key, node, entry, predicate, or range to search for.
- OptionalonlyOne: boolean = false
  If true, stops after finding the first match.
- Optionalcallback: C = ...
  A function to call on matching nodes.
- OptionalstartNode:
      | null
      | K
      | BSTNode<K, V[]>
      | [undefined | null | K, undefined | V[]] = ...
  The node to start the search from.
- OptionaliterationType: IterationType = ...
  Whether to use 'RECURSIVE' or 'ITERATIVE' search.
Returns ReturnType<C>[]
An array of results from the callback function for each matching node.

Remarks
This is an optimized search for a BST. If searching by key or range, it prunes branches. Time O(H + M) for key/range search (H=height, M=matches). O(N) for predicate search. Space O(log N) for the stack.
Implementation of IBinaryTree.search
Inherited from RedBlackTree.search
- Defined in data-structures/binary-tree/bst.ts:412

some

some(predicate, thisArg?): boolean
Test whether any entry satisfies the predicate.
Parameters
- predicate: EntryCallback<K, undefined | V[], boolean>
  (key, value, index, self) => boolean.
- OptionalthisArg: any
  Optional this for callback.
Returns boolean
true if any passes; otherwise false.

Remarks
Time O(n), Space O(1)
Implementation of IBinaryTree.some
Inherited from RedBlackTree.some
- Defined in data-structures/base/iterable-entry-base.ts:83

toVisual

toVisual(startNode?, options?): string
Generates a string representation of the tree for visualization.
Parameters
- OptionalstartNode:
      | null
      | K
      | BinaryTreeNode<K, V[]>
      | [undefined | null | K, undefined | V[]] = ...
  The node to start printing from.
- Optionaloptions: BinaryTreePrintOptions
  Options to control the output (e.g., show nulls).
Returns string
The string representation of the tree.

Remarks
Time O(N), visits every node. Space O(N*H) or O(N^2) in the worst case, as the string width can grow significantly.
Inherited from RedBlackTree.toVisual
- Defined in data-structures/binary-tree/binary-tree.ts:1711

values

values(): IterableIterator<undefined | V[], any, any>
Iterate over values only.

Returns IterableIterator<undefined | V[], any, any>
Iterator of values.

Remarks
Time O(n), Space O(1)
Implementation of IBinaryTree.values
Inherited from RedBlackTree.values
- Defined in data-structures/base/iterable-entry-base.ts:53

Class TreeMultiMap<K, V, R>

Remarks

Example

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns TreeMultiMap<K, V, R>

Remarks

Properties

Protected_comparator

Remarks

Accessors

comparator

Returns Comparator<K>

Remarks

isDuplicate

Returns boolean

Remarks

isMapMode

Returns boolean

Remarks

isReverse

Returns boolean

Remarks

NIL

Returns BinaryTreeNode<K, V>

Remarks

root

Returns undefined | RedBlackTreeNode<K, V>

Remarks

size

Returns number

Remarks

specifyComparable

Returns undefined | ((key: K) => Comparable)

Remarks

store

Returns Map<K, undefined | V>

Remarks

toEntryFn

Returns undefined | ToEntryFn<K, V, R>

Remarks

Methods

Protected_clearNodes

Returns void

Remarks

Protected_clearValues

Returns void

Remarks

Protected_clone

Parameters

Returns void

Remarks

Protected_compare

Parameters

Returns number

Remarks

Protected_createInstance

Type Parameters

Parameters

Returns this

Remarks

Protected_createLike

Type Parameters

Parameters

Returns RedBlackTree<TK, TV, TR>

Remarks

_createNode

Parameters

Returns TreeMultiMapNode<K, V>

Remarks

`Protected`_comparator

`Protected`_clearNodes

`Protected`_clearValues

`Protected`_clone

`Protected`_compare

`Protected`_createInstance

`Protected`_createLike

`Protected`_DEFAULT_NODE_CALLBACK

`Protected`_deleteFixup

`Protected`_dfs

`Protected`_displayAux

`Protected`_ensurePredicate

`Protected`_extractKey

`Protected`_getIterator

`Protected`_insert

`Protected`_insertFixup

`Protected`_isPredicate

`Protected`_keyValueNodeOrEntryToNodeAndValue

`Protected`_leftRotate

`Protected`_replaceNode

`Protected`_rightRotate

`Protected`_setRoot

`Protected`_setValue