Class BST<K, V, R>

Represents a Binary Search Tree (BST). Keys are ordered, allowing for faster search operations compared to a standard Binary Tree.

Example

// basic BST creation and add operation
 // Create a simple BST with numeric keys
    const bst = new BST<number>([11, 3, 15, 1, 8, 13, 16, 2, 6, 9, 12, 14, 4, 7, 10, 5]);

    bst.print();
    //         _______8__________
    //        /                  \
    //     ___4___          ____12_____
    //    /       \        /           \
    //   _2_     _6_     _10__       _14__
    //  /   \   /   \   /     \     /     \
    //  1   3   5   7   9    11    13    15__
    //                                       \
    //                                      16

    // Verify size
    console.log(bst.size); // 16;

    // Add new elements
    bst.add(17);
    bst.add(0);
    console.log(bst.size); // 18;

    // Verify keys are searchable
    console.log(bst.has(11)); // true;
    console.log(bst.has(100)); // false;

Example

// BST delete and search after deletion
 const bst = new BST<number>([11, 3, 15, 1, 8, 13, 16, 2, 6, 9, 12, 14, 4, 7, 10, 5]);

    // Delete a leaf node
    bst.delete(1);
    console.log(bst.has(1)); // false;

    // Delete a node with one child
    bst.delete(2);
    console.log(bst.has(2)); // false;

    // Delete a node with two children
    bst.delete(3);
    console.log(bst.has(3)); // false;

    // Size decreases with each deletion
    console.log(bst.size); // 13;

    // Other nodes remain searchable
    console.log(bst.has(11)); // true;
    console.log(bst.has(15)); // true;

Example

// Merge 3 sorted datasets
 const dataset1 = new BST<number, string>([
      [1, 'A'],
      [7, 'G']
    ]);
    const dataset2 = [
      [2, 'B'],
      [6, 'F']
    ];
    const dataset3 = new BST<number, string>([
      [3, 'C'],
      [5, 'E'],
      [4, 'D']
    ]);

    // Merge datasets into a single BinarySearchTree
    const merged = new BST<number, string>(dataset1);
    merged.addMany(dataset2);
    merged.merge(dataset3);

    // Verify merged dataset is in sorted order
    console.log([...merged.values()]); // ['A', 'B', 'C', 'D', 'E', 'F', 'G'];

Example

// BST with custom objects for expression evaluation
 interface Expression {
      id: number;
      operator: string;
      precedence: number;
    }

    // BST efficiently stores and retrieves operators by precedence
    const operatorTree = new BST<number, Expression>(
      [
        [1, { id: 1, operator: '+', precedence: 1 }],
        [2, { id: 2, operator: '*', precedence: 2 }],
        [3, { id: 3, operator: '/', precedence: 2 }],
        [4, { id: 4, operator: '-', precedence: 1 }],
        [5, { id: 5, operator: '^', precedence: 3 }]
      ],
      { isMapMode: false }
    );

    console.log(operatorTree.size); // 5;

    // Quick lookup of operators
    const mult = operatorTree.get(2);
    console.log(mult?.operator); // '*';
    console.log(mult?.precedence); // 2;

    // Check if operator exists
    console.log(operatorTree.has(5)); // true;
    console.log(operatorTree.has(99)); // false;

    // Retrieve operator by precedence level
    const expNode = operatorTree.getNode(3);
    console.log(expNode?.key); // 3;
    console.log(expNode?.value?.precedence); // 2;

    // Delete operator and verify
    operatorTree.delete(1);
    console.log(operatorTree.has(1)); // false;
    console.log(operatorTree.size); // 4;

    // Get tree height for optimization analysis
    const treeHeight = operatorTree.getHeight();
    console.log(treeHeight); // > 0;

    // Remaining operators are still accessible
    const remaining = operatorTree.get(2);
    console.log(remaining); // defined;

Example

// Find lowest common ancestor
 const bst = new BST<number>([20, 10, 30, 5, 15, 25, 35, 3, 7, 12, 18]);

    // LCA helper function
    const findLCA = (num1: number, num2: number): number | undefined => {
      const path1 = bst.getPathToRoot(num1);
      const path2 = bst.getPathToRoot(num2);
      // Find the first common ancestor
      return findFirstCommon(path1, path2);
    };

    function findFirstCommon(arr1: (number | undefined)[], arr2: (number | undefined)[]): number | undefined {
      for (const num of arr1) {
        if (arr2.indexOf(num) !== -1) {
          return num;
        }
      }
      return undefined;
    }

    // Assertions
    console.log(findLCA(3, 10)); // 7;
    console.log(findLCA(5, 35)); // 15;
    console.log(findLCA(20, 30)); // 25;

Type Parameters

K = any
The type of the key.
V = any
The type of the value.
R = any
The type of the raw data object (if using toEntryFn).
1. Node Order: Each node's left child has a lesser value, and the right child has a greater value.
2. Unique Keys: No duplicate keys in a standard BST.
3. Efficient Search: Enables quick search, minimum, and maximum operations.
4. Inorder Traversal: Yields nodes in ascending order.
5. Logarithmic Operations: Ideal operations like insertion, deletion, and searching are O(log n) time-efficient.
6. Balance Variability: Can become unbalanced; special types maintain balance.
7. No Auto-Balancing: Standard BSTs don't automatically balance themselves.

Hierarchy (view full)

BinaryTree<K, V, R>
- BST
  - AVLTree
  - RedBlackTree

Implements

IBinaryTree<K, V, R>

Index

Constructors

constructor

new BST<K, V, R>(keysNodesEntriesOrRaws?, options?): BST<K, V, R>
Creates an instance of BST.
Type Parameters
- K = any
- V = any
- R = any
Parameters
- OptionalkeysNodesEntriesOrRaws: Iterable<
      | undefined
      | null
      | K
      | R
      | [undefined | null | K, undefined | V]
      | BSTNode<any, any>, any, any> = []
  An iterable of items to add.
- Optionaloptions: BSTOptions<K, V, R>
  Configuration options for the BST, including comparator.
Returns BST<K, V, R>
Remarks
Time O(N log N) or O(N^2) depending on isBalanceAdd in addMany and input order. Space O(N).
Overrides BinaryTree.constructor
- Defined in data-structures/binary-tree/bst.ts:356

Properties

`Protected`_comparator

_comparator: Comparator<K>

The comparator function used to determine the order of keys in the tree.

Remarks

Time O(1) Space O(1)

Accessors

comparator

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

Returns Comparator<K>
The comparator function.

Remarks
Time O(1)
- Defined in data-structures/binary-tree/bst.ts:401

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 BinaryTree.isDuplicate
- Defined in data-structures/binary-tree/binary-tree.ts:400

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 BinaryTree.isMapMode
- Defined in data-structures/binary-tree/binary-tree.ts:388

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 BinaryTree.NIL
- Defined in data-structures/binary-tree/binary-tree.ts:448

root

get root(): OptNode<BSTNode<K, V>>
Gets the root node of the tree.

Returns OptNode<BSTNode<K, V>>
The root node.

Remarks
Time O(1)
Implementation of IBinaryTree.root
Overrides BinaryTree.root
- Defined in data-structures/binary-tree/bst.ts:384

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 BinaryTree.size
- Defined in data-structures/binary-tree/binary-tree.ts:436

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 BinaryTree.store
- Defined in data-structures/binary-tree/binary-tree.ts:412

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 BinaryTree.toEntryFn
- Defined in data-structures/binary-tree/binary-tree.ts:460

Methods

`Protected`_bound

_bound(keyNodeEntryOrPredicate, isLower, iterationType): undefined | BSTNode<K, V>
(Protected) Core bound search implementation supporting all parameter types. Unified logic for both lowerBound and upperBound. Resolves various input types (Key, Node, Entry, Predicate) using parent class utilities.
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.
- isLower: boolean
  True for lowerBound (>=), false for upperBound (>).
- iterationType: IterationType
  The iteration type (RECURSIVE or ITERATIVE).
Returns undefined | BSTNode<K, V>
The first matching node, or undefined if no such node exists.
- Defined in data-structures/binary-tree/bst.ts:1709

`Protected`_boundByKey

_boundByKey(key, isLower, iterationType): undefined | BSTNode<K, V>
(Protected) Binary search for bound by key with pruning optimization. Performs standard BST binary search, choosing left or right subtree based on comparator result. For lowerBound: finds first node where key >= target. For upperBound: finds first node where key > target.
Parameters
- key: K
  The target key to search for.
- isLower: boolean
  True for lowerBound (>=), false for upperBound (>).
- iterationType: IterationType
  The iteration type (RECURSIVE or ITERATIVE).
Returns undefined | BSTNode<K, V>
The first node matching the bound condition, or undefined if none exists.
- Defined in data-structures/binary-tree/bst.ts:1765

`Protected`_boundByPredicate

_boundByPredicate(predicate, iterationType): undefined | BSTNode<K, V>
(Protected) In-order traversal search by predicate. Falls back to linear in-order traversal when predicate-based search is required. Returns the first node that satisfies the predicate function. Note: Predicate-based search cannot leverage BST's binary search optimization. Time Complexity: O(n) since it may visit every node.
Parameters
- predicate: NodePredicate<BSTNode<K, V>>
  The predicate function to test nodes.
- iterationType: IterationType
  The iteration type (RECURSIVE or ITERATIVE).
Returns undefined | BSTNode<K, V>
The first node satisfying predicate, or undefined if none found.
- Defined in data-structures/binary-tree/bst.ts:1820

`Protected`_clearNodes

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

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

`Protected`_clearValues

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

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

`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 BinaryTree._clone
- Defined in data-structures/binary-tree/binary-tree.ts:2212

`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) Space O(1)
- Defined in data-structures/binary-tree/bst.ts:1960

`Protected`_createDefaultComparator

_createDefaultComparator(): Comparator<K>
(Protected) Creates the default comparator function for keys that don't have a custom comparator.

Returns Comparator<K>
The default comparator function.

Remarks
Time O(1) Space O(1)
- Defined in data-structures/binary-tree/bst.ts:1442

`Protected`_createInstance

_createInstance<TK, TV, TR>(options?): this
(Protected) Creates a new, empty instance of the same BST constructor.
Type Parameters
- TK = K
- TV = V
- TR = R
Parameters
- Optionaloptions: Partial<BSTOptions<TK, TV, TR>>
  Options for the new BST.
Returns this
A new, empty BST.

Remarks
Time O(1)
Overrides BinaryTree._createInstance
- Defined in data-structures/binary-tree/bst.ts:1882

`Protected`_createLike

_createLike<TK, TV, TR>(iter?, options?): BST<TK, TV, TR>
(Protected) Creates a new instance of the same BST constructor, potentially with different generic types.
Type Parameters
- TK = K
- TV = V
- TR = R
Parameters
- Optionaliter: Iterable<
      | undefined
      | null
      | TK
      | TR
      | BSTNode<TK, TV>
      | [undefined | null | TK, undefined | TV], any, any> = []
  An iterable to populate the new BST.
- Optionaloptions: Partial<BSTOptions<TK, TV, TR>>
  Options for the new BST.
Returns BST<TK, TV, TR>
A new BST.

Remarks
Time O(N log N) or O(N^2) (from constructor) due to processing the iterable.
Overrides BinaryTree._createLike
- Defined in data-structures/binary-tree/bst.ts:1899

`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 BinaryTree._DEFAULT_NODE_CALLBACK
- Defined in data-structures/binary-tree/binary-tree.ts:2120

`Protected`_deleteByKey

_deleteByKey(key): boolean
(Private) Deletes a node by its key.
Parameters
- key: K
  The key of the node to delete.
Returns boolean
True if the node was found and deleted, false otherwise.

Remarks
Standard BST deletion algorithm. Time O(log N), O(N) worst-case. Space O(1).
- Defined in data-structures/binary-tree/bst.ts:1971

`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 BinaryTree._dfs
- Defined in data-structures/binary-tree/binary-tree.ts:1929

`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 BinaryTree._displayAux
- Defined in data-structures/binary-tree/binary-tree.ts:2237

`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 BinaryTree._ensurePredicate
- Defined in data-structures/binary-tree/binary-tree.ts:2391

`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 BinaryTree._extractKey
- Defined in data-structures/binary-tree/binary-tree.ts:2451

`Protected`_floorByKey

_floorByKey(key, iterationType): undefined | BSTNode<K, V>
(Protected) Binary search for floor by key with pruning optimization. Performs standard BST binary search, choosing left or right subtree based on comparator result. Finds first node where key <= target.
Parameters
- key: K
  The target key to search for.
- iterationType: IterationType
  The iteration type (RECURSIVE or ITERATIVE).
Returns undefined | BSTNode<K, V>
The first node with key <= target, or undefined if none exists.

Remarks
Time O(h) where h is tree height.
- Defined in data-structures/binary-tree/bst.ts:1474

`Protected`_floorByPredicate

_floorByPredicate(predicate, iterationType): undefined | BSTNode<K, V>
(Protected) In-order traversal search for floor by predicate. Falls back to linear in-order traversal when predicate-based search is required. Returns the last node that satisfies the predicate function.
Parameters
- predicate: NodePredicate<BSTNode<K, V>>
  The predicate function to test nodes.
- iterationType: IterationType
  The iteration type (RECURSIVE or ITERATIVE).
Returns undefined | BSTNode<K, V>
The last node satisfying predicate (highest key), or undefined if none found.

Remarks
Time Complexity: O(n) since it may visit every node. Space Complexity: O(h) for recursion, O(h) for iterative stack.
- Defined in data-structures/binary-tree/bst.ts:1527

`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 BinaryTree._getIterator
- Defined in data-structures/binary-tree/binary-tree.ts:2074

`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 BinaryTree._isPredicate
- Defined in data-structures/binary-tree/binary-tree.ts:2440

`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)
Overrides BinaryTree._keyValueNodeOrEntryToNodeAndValue
- Defined in data-structures/binary-tree/bst.ts:1932

`Protected`_lowerByKey

_lowerByKey(key, iterationType): undefined | BSTNode<K, V>
(Protected) Binary search for lower by key with pruning optimization. Performs standard BST binary search, choosing left or right subtree based on comparator result. Finds first node where key < target.
Parameters
- key: K
  The target key to search for.
- iterationType: IterationType
  The iteration type (RECURSIVE or ITERATIVE).
Returns undefined | BSTNode<K, V>
The first node with key < target, or undefined if none exists.

Remarks
Time O(h) where h is tree height.
- Defined in data-structures/binary-tree/bst.ts:1592

`Protected`_lowerByPredicate

_lowerByPredicate(predicate, iterationType): undefined | BSTNode<K, V>
(Protected) In-order traversal search for lower by predicate. Falls back to linear in-order traversal when predicate-based search is required. Returns the node that satisfies the predicate and appears last in in-order traversal.
Parameters
- predicate: NodePredicate<BSTNode<K, V>>
  The predicate function to test nodes.
- iterationType: IterationType
  The iteration type (RECURSIVE or ITERATIVE).
Returns undefined | BSTNode<K, V>
The last node satisfying predicate (highest key < target), or undefined if none found.

Remarks
Time Complexity: O(n) since it may visit every node. Space Complexity: O(h) for recursion, O(h) for iterative stack.
- Defined in data-structures/binary-tree/bst.ts:1645

`Protected`_replaceNode

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

Remarks
Time O(1)
Inherited from BinaryTree._replaceNode
- Defined in data-structures/binary-tree/binary-tree.ts:2353

`Protected`_setRoot

_setRoot(v): void
(Protected) Sets the root node and clears its parent reference.
Parameters
- v: OptNode<BSTNode<K, V>>
  The node to set as root.
Returns void
Remarks
Time O(1)
Overrides BinaryTree._setRoot
- Defined in data-structures/binary-tree/bst.ts:1947

`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 BinaryTree._setValue
- Defined in data-structures/binary-tree/binary-tree.ts:2472

`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 = R
Returns BSTOptions<TK, TV, TR>
The options object.

Remarks
Time O(1)
Overrides BinaryTree._snapshotOptions
- Defined in data-structures/binary-tree/bst.ts:1917

`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 BinaryTree._swapProperties
- Defined in data-structures/binary-tree/binary-tree.ts:2319

[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 BinaryTree.[iterator]
- Defined in data-structures/base/iterable-entry-base.ts:22

add

add(keyNodeOrEntry, value?): boolean
Adds a new node to the BST based on key comparison.
Parameters
- keyNodeOrEntry:
      | undefined
      | null
      | K
      | BSTNode<K, V>
      | [undefined | null | K, undefined | V]
  The key, node, or entry to add.
- Optionalvalue: V
  The value, if providing just a key.
Returns boolean
True if the addition was successful, false otherwise.

Remarks
Time O(log N), where H is tree height. O(N) worst-case (unbalanced tree), O(log N) average. Space O(1).
Implementation of IBinaryTree.add
Overrides BinaryTree.add
- Defined in data-structures/binary-tree/bst.ts:723

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
Overrides BinaryTree.addMany
- Defined in data-structures/binary-tree/bst.ts:779

bfs

bfs(): (undefined | K)[]
Returns (undefined | K)[]
Implementation of IBinaryTree.bfs
Overrides BinaryTree.bfs
- Defined in data-structures/binary-tree/bst.ts:488
bfs<C>(callback, startNode?, iterationType?): ReturnType<C>[]
Type Parameters
- C extends NodeCallback<BSTNode<K, V>>
Parameters
- callback: C
- OptionalstartNode:
      | null
      | K
      | BSTNode<K, V>
      | [undefined | null | K, undefined | V]
- OptionaliterationType: IterationType
Returns ReturnType<C>[]
Implementation of IBinaryTree.bfs
Overrides BinaryTree.bfs
- Defined in data-structures/binary-tree/bst.ts:489

ceiling

ceiling(keyNodeEntryOrPredicate): undefined | K
Returns the first key with a value >= target. Equivalent to Java TreeMap.ceiling. Time Complexity: O(log n) average, O(h) worst case. Space Complexity: O(h) for recursion, O(1) for iteration.
Parameters
- keyNodeEntryOrPredicate:
      | undefined
      | null
      | K
      | BSTNode<K, V>
      | [undefined | null | K, undefined | V]
      | NodePredicate<BSTNode<K, V>>
Returns undefined | K
- Defined in data-structures/binary-tree/bst.ts:876
ceiling<C>(keyNodeEntryOrPredicate, callback, iterationType?): ReturnType<C>
Returns the first node with a key >= target and applies callback. Time Complexity: O(log n) average, O(h) worst case. Space Complexity: O(h) for recursion, O(1) for iteration.
Type Parameters
- C extends NodeCallback<BSTNode<K, V>>
Parameters
- keyNodeEntryOrPredicate:
      | undefined
      | null
      | K
      | BSTNode<K, V>
      | [undefined | null | K, undefined | V]
      | NodePredicate<BSTNode<K, V>>
- callback: C
- OptionaliterationType: IterationType
Returns ReturnType<C>
- Defined in data-structures/binary-tree/bst.ts:891

clear

clear(): void
Clears the tree of all nodes and values.

Returns void
Remarks
Time O(N) if in Map mode (due to _store.clear()), O(1) otherwise. Space O(1)
Implementation of IBinaryTree.clear
Inherited from BinaryTree.clear
- Defined in data-structures/binary-tree/binary-tree.ts:1072

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 BinaryTree.clone
- Defined in data-structures/binary-tree/binary-tree.ts:1837

createNode

createNode(key, value?): BSTNode<K, V>
(Protected) Creates a new BST node.
Parameters
- key: K
  The key for the new node.
- Optionalvalue: V
  The value for the new node (used if not in Map mode).
Returns BSTNode<K, V>
The newly created BSTNode.

Remarks
Time O(1), Space O(1)
Implementation of IBinaryTree.createNode
Overrides BinaryTree.createNode
- Defined in data-structures/binary-tree/bst.ts:413

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 BinaryTree.createTree
- Defined in data-structures/binary-tree/binary-tree.ts:483

delete

delete(keyNodeOrEntry): BinaryTreeDeleteResult<BinaryTreeNode<K, V>>[]
Deletes a node from the tree.
Parameters
- keyNodeOrEntry:
      | undefined
      | null
      | K
      | BinaryTreeNode<K, V>
      | [undefined | null | K, undefined | V]
  The node to delete.
Returns BinaryTreeDeleteResult<BinaryTreeNode<K, V>>[]
An array containing deletion results (for compatibility with self-balancing trees).

Remarks
Time O(log N), For BST, Red-Black Tree, and AVL Tree subclasses, the worst-case time is O(log N). This implementation finds the node, and if it has two children, swaps it with the rightmost node of its left subtree (in-order predecessor) before deleting. Time O(N) in the worst case. O(N) to find the node (getNode) and O(H) (which is O(N) worst-case) to find the rightmost node. Space O(1) (if getNode is iterative, which it is).
Implementation of IBinaryTree.delete
Inherited from BinaryTree.delete
- Defined in data-structures/binary-tree/binary-tree.ts:804

deleteWhere

deleteWhere(keyNodeEntryOrPredicate, onlyOne?, startNode?, iterationType?): BinaryTreeDeleteResult<BSTNode<K, V>>[]
Deletes nodes that match a key, node, entry, predicate, or range.
Parameters
- keyNodeEntryOrPredicate:
      | undefined
      | null
      | K
      | BSTNode<K, V>
      | [undefined | null | K, undefined | V]
      | NodePredicate<BSTNode<K, V>>
      | Range<K>
  The search criteria. Can be one of:
  - A key (type K): searches for exact key match using the comparator.
  - A BSTNode: searches for the matching node in the tree.
  - An entry tuple: searches for the key-value pair.
  - A NodePredicate function: tests each node and returns true for matches.
  - A Range object: searches for nodes whose keys fall within the specified range (inclusive/exclusive based on range settings).
  - null or undefined: treated as no match, returns empty results.
- onlyOne: boolean = false
  If true, stops the search after finding the first match and only deletes that one node. If false (default), searches for and deletes all matching nodes.
- startNode:
      | undefined
      | null
      | K
      | BSTNode<K, V>
      | [undefined | null | K, undefined | V] = ...
  The node to start the search from. Can be:
  - A key, node, or entry: the method resolves it to a node and searches from that subtree.
  - null or undefined: defaults to the root, searching the entire tree.
  - Default value: this._root (the tree's root).
- iterationType: IterationType = ...
  Controls the internal traversal implementation:
  - 'RECURSIVE': uses recursive function calls for traversal.
  - 'ITERATIVE': uses explicit stack-based iteration.
  - Default: this.iterationType (the tree's default iteration mode).
Returns BinaryTreeDeleteResult<BSTNode<K, V>>[]
A Map<K, boolean> containing the deletion results:
- Key: the matched node's key.
- Value: true if the deletion succeeded, false if it failed (e.g., key not found during deletion phase).
- If no nodes match the search criteria, the returned map is empty.
Remarks
Time Complexity: O(N) for search + O(M log N) for M deletions, where N is tree size. Space Complexity: O(M) for storing matched nodes and result map.
- Defined in data-structures/binary-tree/bst.ts:1413

dfs

dfs(): (undefined | K)[]
Returns (undefined | K)[]
Implementation of IBinaryTree.dfs
Overrides BinaryTree.dfs
- Defined in data-structures/binary-tree/bst.ts:456
dfs<C>(callback, pattern?, onlyOne?, startNode?, iterationType?): ReturnType<C>[]
Type Parameters
- C extends NodeCallback<BSTNode<K, V>>
Parameters
- callback: C
- Optionalpattern: DFSOrderPattern
- OptionalonlyOne: boolean
- OptionalstartNode:
      | null
      | K
      | BSTNode<K, V>
      | [undefined | null | K, undefined | V]
- OptionaliterationType: IterationType
Returns ReturnType<C>[]
Implementation of IBinaryTree.dfs
Overrides BinaryTree.dfs
- Defined in data-structures/binary-tree/bst.ts:458

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.
Overrides BinaryTree.ensureNode
- Defined in data-structures/binary-tree/bst.ts:425

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 BinaryTree.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 BinaryTree.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 BinaryTree.filter
- Defined in data-structures/binary-tree/binary-tree.ts:1851

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 BinaryTree.find
- Defined in data-structures/base/iterable-entry-base.ts:114

floor

floor(keyNodeEntryOrPredicate): undefined | K
Returns the first key with a value <= target. Equivalent to Java TreeMap.floor. Time Complexity: O(log n) average, O(h) worst case. Space Complexity: O(h) for recursion, O(1) for iteration.
Parameters
- keyNodeEntryOrPredicate:
      | undefined
      | null
      | K
      | BSTNode<K, V>
      | [undefined | null | K, undefined | V]
      | NodePredicate<BSTNode<K, V>>
Returns undefined | K
- Defined in data-structures/binary-tree/bst.ts:1006
floor<C>(keyNodeEntryOrPredicate, callback, iterationType?): ReturnType<C>
Returns the first node with a key <= target and applies callback. Time Complexity: O(log n) average, O(h) worst case. Space Complexity: O(h) for recursion, O(1) for iteration.
Type Parameters
- C extends NodeCallback<BSTNode<K, V>>
Parameters
- keyNodeEntryOrPredicate:
      | undefined
      | null
      | K
      | BSTNode<K, V>
      | [undefined | null | K, undefined | V]
      | NodePredicate<BSTNode<K, V>>
- callback: C
- OptionaliterationType: IterationType
Returns ReturnType<C>
- Defined in data-structures/binary-tree/bst.ts:1021

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 BinaryTree.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 BinaryTree.get
- Defined in data-structures/binary-tree/binary-tree.ts:1020

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 BinaryTree.getDepth
- Defined in data-structures/binary-tree/binary-tree.ts:1159

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 BinaryTree.getHeight
- Defined in data-structures/binary-tree/binary-tree.ts:1184

getLeftMost

getLeftMost(): undefined | K
Returns undefined | K
Implementation of IBinaryTree.getLeftMost
Inherited from BinaryTree.getLeftMost
- Defined in data-structures/binary-tree/binary-tree.ts:1311
getLeftMost<C>(callback, startNode?, iterationType?): ReturnType<C>
Type Parameters
- C extends NodeCallback<undefined | BinaryTreeNode<K, V>>
Parameters
- callback: C
- OptionalstartNode:
      | null
      | K
      | BinaryTreeNode<K, V>
      | [undefined | null | K, undefined | V]
- OptionaliterationType: IterationType
Returns ReturnType<C>
Implementation of IBinaryTree.getLeftMost
Inherited from BinaryTree.getLeftMost
- Defined in data-structures/binary-tree/binary-tree.ts:1313

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 BinaryTree.getMinHeight
- Defined in data-structures/binary-tree/binary-tree.ts:1226

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
Overrides BinaryTree.getNode
- Defined in data-structures/binary-tree/bst.ts:548

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 BinaryTree.getNodes
- Defined in data-structures/binary-tree/binary-tree.ts:960

getPathToRoot

getPathToRoot(beginNode): (undefined | K)[]
Parameters
- beginNode:
      | undefined
      | null
      | K
      | BinaryTreeNode<K, V>
      | [undefined | null | K, undefined | V]
Returns (undefined | K)[]
Implementation of IBinaryTree.getPathToRoot
Inherited from BinaryTree.getPathToRoot
- Defined in data-structures/binary-tree/binary-tree.ts:1273
getPathToRoot<C>(beginNode, callback, isReverse?): ReturnType<C>[]
Type Parameters
- C extends NodeCallback<undefined | BinaryTreeNode<K, V>>
Parameters
- beginNode:
      | undefined
      | null
      | K
      | BinaryTreeNode<K, V>
      | [undefined | null | K, undefined | V]
- callback: C
- OptionalisReverse: boolean
Returns ReturnType<C>[]
Implementation of IBinaryTree.getPathToRoot
Inherited from BinaryTree.getPathToRoot
- Defined in data-structures/binary-tree/binary-tree.ts:1277

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 BinaryTree.getPredecessor
- Defined in data-structures/binary-tree/binary-tree.ts:1411

getRightMost

getRightMost(): undefined | K
Returns undefined | K
Implementation of IBinaryTree.getRightMost
Inherited from BinaryTree.getRightMost
- Defined in data-structures/binary-tree/binary-tree.ts:1358
getRightMost<C>(callback, startNode?, iterationType?): ReturnType<C>
Type Parameters
- C extends NodeCallback<undefined | BinaryTreeNode<K, V>>
Parameters
- callback: C
- OptionalstartNode:
      | null
      | K
      | BinaryTreeNode<K, V>
      | [undefined | null | K, undefined | V]
- OptionaliterationType: IterationType
Returns ReturnType<C>
Implementation of IBinaryTree.getRightMost
Inherited from BinaryTree.getRightMost
- Defined in data-structures/binary-tree/binary-tree.ts:1360

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 BinaryTree.getSuccessor
- Defined in data-structures/binary-tree/binary-tree.ts:1432

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 BinaryTree.has
- Defined in data-structures/binary-tree/binary-tree.ts:1042

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 BinaryTree.hasValue
- Defined in data-structures/base/iterable-entry-base.ts:143

higher

higher(keyNodeEntryOrPredicate): undefined | K
Returns the first key with a value > target. Equivalent to Java TreeMap.higher. Time Complexity: O(log n) average, O(h) worst case. Space Complexity: O(h) for recursion, O(1) for iteration.
Parameters
- keyNodeEntryOrPredicate:
      | undefined
      | null
      | K
      | BSTNode<K, V>
      | [undefined | null | K, undefined | V]
      | NodePredicate<BSTNode<K, V>>
Returns undefined | K
- Defined in data-structures/binary-tree/bst.ts:941
higher<C>(keyNodeEntryOrPredicate, callback, iterationType?): ReturnType<C>
Returns the first node with a key > target and applies callback. Time Complexity: O(log n) average, O(h) worst case. Space Complexity: O(h) for recursion, O(1) for iteration.
Type Parameters
- C extends NodeCallback<BSTNode<K, V>>
Parameters
- keyNodeEntryOrPredicate:
      | undefined
      | null
      | K
      | BSTNode<K, V>
      | [undefined | null | K, undefined | V]
      | NodePredicate<BSTNode<K, V>>
- callback: C
- OptionaliterationType: IterationType
Returns ReturnType<C>
- Defined in data-structures/binary-tree/bst.ts:956

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.
- Defined in data-structures/binary-tree/bst.ts:1306

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 BinaryTree.isBST
- Defined in data-structures/binary-tree/binary-tree.ts:1108

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 BinaryTree.isEmpty
- Defined in data-structures/binary-tree/binary-tree.ts:1083

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 BinaryTree.isEntry
- Defined in data-structures/binary-tree/binary-tree.ts:620

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 BinaryTree.isLeaf
- Defined in data-structures/binary-tree/binary-tree.ts:606

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 BinaryTree.isNIL
- Defined in data-structures/binary-tree/binary-tree.ts:575

isNode

isNode(keyNodeOrEntry): keyNodeOrEntry is BSTNode<K, V>
Checks if the given item is a BSTNode instance.
Parameters
- keyNodeOrEntry:
      | undefined
      | null
      | K
      | BSTNode<K, V>
      | [undefined | null | K, undefined | V]
  The item to check.
Returns keyNodeOrEntry is BSTNode<K, V>
True if it's a BSTNode, false otherwise.

Remarks
Time O(1), Space O(1)
Overrides BinaryTree.isNode
- Defined in data-structures/binary-tree/bst.ts:439

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 BinaryTree.isPerfectlyBalanced
- Defined in data-structures/binary-tree/binary-tree.ts:1094

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]
      | Range<K>
      | NodePredicate<BinaryTreeNode<K, V>>
  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 BinaryTree.isRange
- Defined in data-structures/binary-tree/binary-tree.ts:586

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 BinaryTree.isRaw
- Defined in data-structures/binary-tree/binary-tree.ts:535

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 BinaryTree.isRealNode
- Defined in data-structures/binary-tree/binary-tree.ts:548

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 BinaryTree.isRealNodeOrNull
- Defined in data-structures/binary-tree/binary-tree.ts:562

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)
Overrides BinaryTree.isValidKey
- Defined in data-structures/binary-tree/bst.ts:452

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 BinaryTree.keys
- Defined in data-structures/base/iterable-entry-base.ts:42

leaves

leaves(): (undefined | K)[]
Returns (undefined | K)[]
Implementation of IBinaryTree.leaves
Inherited from BinaryTree.leaves
- Defined in data-structures/binary-tree/binary-tree.ts:1577
leaves<C>(callback, startNode?, iterationType?): ReturnType<C>[]
Type Parameters
- C extends NodeCallback<BinaryTreeNode<K, V>>
Parameters
- callback: C
- OptionalstartNode:
      | null
      | K
      | BinaryTreeNode<K, V>
      | [undefined | null | K, undefined | V]
- OptionaliterationType: IterationType
Returns ReturnType<C>[]
Implementation of IBinaryTree.leaves
Inherited from BinaryTree.leaves
- Defined in data-structures/binary-tree/binary-tree.ts:1579

lesserOrGreaterTraverse

lesserOrGreaterTraverse(): (undefined | K)[]
Returns (undefined | K)[]
- Defined in data-structures/binary-tree/bst.ts:1210
lesserOrGreaterTraverse<C>(callback, lesserOrGreater?, targetNode?, iterationType?): ReturnType<C>[]
Type Parameters
- C extends NodeCallback<BSTNode<K, V>>
Parameters
- callback: C
- OptionallesserOrGreater: number
- OptionaltargetNode:
      | null
      | K
      | BSTNode<K, V>
      | [undefined | null | K, undefined | V]
- OptionaliterationType: IterationType
Returns ReturnType<C>[]
- Defined in data-structures/binary-tree/bst.ts:1212

listLevels

listLevels(): (undefined | K)[][]
Returns (undefined | K)[][]
Implementation of IBinaryTree.listLevels
Overrides BinaryTree.listLevels
- Defined in data-structures/binary-tree/bst.ts:513
listLevels<C>(callback, startNode?, iterationType?): ReturnType<C>[][]
Type Parameters
- C extends NodeCallback<BSTNode<K, V>>
Parameters
- callback: C
- OptionalstartNode:
      | null
      | K
      | BSTNode<K, V>
      | [undefined | null | K, undefined | V]
- OptionaliterationType: IterationType
Returns ReturnType<C>[][]
Implementation of IBinaryTree.listLevels
Overrides BinaryTree.listLevels
- Defined in data-structures/binary-tree/bst.ts:515

lower

lower(keyNodeEntryOrPredicate): undefined | K
Returns the first key with a value < target. Equivalent to Java TreeMap.lower. Time Complexity: O(log n) average, O(h) worst case. Space Complexity: O(h) for recursion, O(1) for iteration.
Parameters
- keyNodeEntryOrPredicate:
      | undefined
      | null
      | K
      | BSTNode<K, V>
      | [undefined | null | K, undefined | V]
      | NodePredicate<BSTNode<K, V>>
Returns undefined | K
- Defined in data-structures/binary-tree/bst.ts:1111
lower<C>(keyNodeEntryOrPredicate, callback, iterationType?): ReturnType<C>
Returns the first node with a key < target and applies callback. Time Complexity: O(log n) average, O(h) worst case. Space Complexity: O(h) for recursion, O(1) for iteration.
Type Parameters
- C extends NodeCallback<BSTNode<K, V>>
Parameters
- keyNodeEntryOrPredicate:
      | undefined
      | null
      | K
      | BSTNode<K, V>
      | [undefined | null | K, undefined | V]
      | NodePredicate<BSTNode<K, V>>
- callback: C
- OptionaliterationType: IterationType
Returns ReturnType<C>
- Defined in data-structures/binary-tree/bst.ts:1126

map

map<MK, MV, MR>(callback, options?, thisArg?): BST<MK, MV, MR>
Creates a new BST by mapping each [key, value] pair to a new entry.
Type Parameters
- MK = K
  New key type.
- MV = V
  New value type.
- MR = any
  New raw type.
Parameters
- callback: EntryCallback<K, undefined | V, [MK, MV]>
  A function to map each [key, value] pair.
- Optionaloptions: Partial<BSTOptions<MK, MV, MR>>
  Options for the new BST.
- OptionalthisArg: unknown
  this context for the callback.
Returns BST<MK, MV, MR>
A new, mapped BST.

Remarks
Time O(N * H), where N is nodes in this tree, and H is height of the new tree during insertion. Space O(N) for the new tree.
Implementation of IBinaryTree.map
Overrides BinaryTree.map
- Defined in data-structures/binary-tree/bst.ts:1363

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 BinaryTree.merge
- Defined in data-structures/binary-tree/binary-tree.ts:776

morris

morris(): (undefined | K)[]
Returns (undefined | K)[]
Implementation of IBinaryTree.morris
Inherited from BinaryTree.morris
- Defined in data-structures/binary-tree/binary-tree.ts:1713
morris<C>(callback?, pattern?, startNode?): ReturnType<C>[]
Type Parameters
- C extends NodeCallback<BinaryTreeNode<K, V>>
Parameters
- Optionalcallback: C
- Optionalpattern: DFSOrderPattern
- OptionalstartNode:
      | null
      | K
      | BinaryTreeNode<K, V>
      | [undefined | null | K, undefined | V]
Returns ReturnType<C>[]
Implementation of IBinaryTree.morris
Inherited from BinaryTree.morris
- Defined in data-structures/binary-tree/binary-tree.ts:1715

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.
- Defined in data-structures/binary-tree/bst.ts:1274

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 BinaryTree.print
- Defined in data-structures/binary-tree/binary-tree.ts:1922

rangeSearch

rangeSearch(range): (undefined | K)[]
Parameters
- range: Range<K> | [K, K]
Returns (undefined | K)[]
- Defined in data-structures/binary-tree/bst.ts:685
rangeSearch<C>(range, callback, startNode?, iterationType?): ReturnType<C>[]
Type Parameters
- C extends NodeCallback<BSTNode<K, V>>
Parameters
- range: Range<K> | [K, K]
- callback: C
- OptionalstartNode:
      | null
      | K
      | BSTNode<K, V>
      | [undefined | null | K, undefined | V]
- OptionaliterationType: IterationType
Returns ReturnType<C>[]
- Defined in data-structures/binary-tree/bst.ts:687

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 BinaryTree.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 BinaryTree.refill
- Defined in data-structures/binary-tree/binary-tree.ts:787

search

search(keyNodeEntryOrPredicate, onlyOne?): (undefined | K)[]
Parameters
- keyNodeEntryOrPredicate:
      | undefined
      | null
      | K
      | BSTNode<K, V>
      | [undefined | null | K, undefined | V]
      | NodePredicate<BSTNode<K, V>>
      | Range<K>
- OptionalonlyOne: boolean
Returns (undefined | K)[]
Implementation of IBinaryTree.search
Overrides BinaryTree.search
- Defined in data-structures/binary-tree/bst.ts:562
search<C>(keyNodeEntryOrPredicate, onlyOne, callback, startNode?, iterationType?): ReturnType<C>[]
Type Parameters
- C extends NodeCallback<BSTNode<K, V>>
Parameters
- keyNodeEntryOrPredicate:
      | undefined
      | null
      | K
      | BSTNode<K, V>
      | [undefined | null | K, undefined | V]
      | NodePredicate<BSTNode<K, V>>
      | Range<K>
- onlyOne: boolean
- callback: C
- OptionalstartNode:
      | null
      | K
      | BSTNode<K, V>
      | [undefined | null | K, undefined | V]
- OptionaliterationType: IterationType
Returns ReturnType<C>[]
Implementation of IBinaryTree.search
Overrides BinaryTree.search
- Defined in data-structures/binary-tree/bst.ts:574

set

set(keyNodeOrEntry, value?): boolean
Adds or updates a new node to the tree.
Parameters
- keyNodeOrEntry:
      | undefined
      | null
      | K
      | BinaryTreeNode<K, V>
      | [undefined | null | K, undefined | V]
  The key, node, or entry to add or update.
- Optionalvalue: V
  The value, if providing just a key.
Returns boolean
True if the addition was successful, false otherwise.

Remarks
Time O(log N), For BST, Red-Black Tree, and AVL Tree subclasses, the worst-case time is O(log N). This implementation adds the node at the first available position in a level-order (BFS) traversal. This is NOT a Binary Search Tree insertion. Time O(N), where N is the number of nodes. It must traverse level-by-level to find an empty slot. Space O(N) in the worst case for the BFS queue (e.g., a full last level).
Implementation of IBinaryTree.set
Inherited from BinaryTree.set
- Defined in data-structures/binary-tree/binary-tree.ts:709

setMany

setMany(keysNodesEntriesOrRaws, values?): boolean[]
Adds or updates multiple items to the tree.
Parameters
- keysNodesEntriesOrRaws: Iterable<
      | undefined
      | null
      | K
      | R
      | BinaryTreeNode<K, V>
      | [undefined | null | K, undefined | V], any, any>
  An iterable of items to add or update.
- Optionalvalues: Iterable<undefined | V, any, any>
  An optional parallel iterable of values.
Returns boolean[]
An array of booleans indicating the success of each individual add operation.

Remarks
Time O(N * M), where N is the number of items to add and M is the size of the tree at insertion (due to O(M) add operation). Space O(M) (from add) + O(N) (for the inserted array).
Inherited from BinaryTree.setMany
- Defined in data-structures/binary-tree/binary-tree.ts:761

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 BinaryTree.some
- Defined in data-structures/base/iterable-entry-base.ts:83

toArray

toArray(): [K, undefined | V][]
Converts data structure to [key, value] pairs.

Returns [K, undefined | V][]
Array of entries.

Remarks
Time O(n), Space O(n)
Inherited from BinaryTree.toArray
- Defined in data-structures/base/iterable-entry-base.ts:186

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 BinaryTree.toVisual
- Defined in data-structures/binary-tree/binary-tree.ts:1889

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 BinaryTree.values
- Defined in data-structures/base/iterable-entry-base.ts:53

Class BST<K, V, R>

Example

Example

Example

Example

Example

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BST<K, V, R>

Remarks

Properties

Protected_comparator

Remarks

Accessors

comparator

Returns Comparator<K>

Remarks

isDuplicate

Returns boolean

Remarks

isMapMode

Returns boolean

Remarks

NIL

Returns BinaryTreeNode<K, V>

Remarks

root

Returns OptNode<BSTNode<K, V>>

Remarks

size

Returns number

Remarks

store

Returns Map<K, undefined | V>

Remarks

toEntryFn

Returns undefined | ToEntryFn<K, V, R>

Remarks

Methods

Protected_bound

Parameters

Returns undefined | BSTNode<K, V>

Protected_boundByKey

Parameters

Returns undefined | BSTNode<K, V>

Protected_boundByPredicate

Parameters

Returns undefined | BSTNode<K, V>

Protected_clearNodes

Returns void

Remarks

Protected_clearValues

Returns void

Remarks

Protected_clone

Parameters

Returns void

Remarks

Protected_compare

Parameters

Returns number

Remarks

Protected_createDefaultComparator

Returns Comparator<K>

Remarks

Protected_createInstance

Type Parameters

Parameters

Returns this

Remarks

`Protected`_comparator

`Protected`_bound

`Protected`_boundByKey

`Protected`_boundByPredicate

`Protected`_clearNodes

`Protected`_clearValues

`Protected`_clone

`Protected`_compare

`Protected`_createDefaultComparator

`Protected`_createInstance

`Protected`_createLike

`Protected`_DEFAULT_NODE_CALLBACK

`Protected`_deleteByKey

`Protected`_dfs

`Protected`_displayAux

`Protected`_ensurePredicate

`Protected`_extractKey

`Protected`_floorByKey

`Protected`_floorByPredicate

`Protected`_getIterator

`Protected`_isPredicate

`Protected`_keyValueNodeOrEntryToNodeAndValue

`Protected`_lowerByKey

`Protected`_lowerByPredicate

`Protected`_replaceNode

`Protected`_setRoot