Class BinaryTree<K, V, R>

A general Binary Tree implementation.

Remarks

This class implements a basic Binary Tree, not a Binary Search Tree. The add operation inserts nodes level-by-level (BFS) into the first available slot.

Example

// determine loan approval using a decision tree
    // Decision tree structure
    const loanDecisionTree = new BinaryTree<string>(
      ['stableIncome', 'goodCredit', 'Rejected', 'Approved', 'Rejected'],
      { isDuplicate: true }
    );

    function determineLoanApproval(
      node?: BinaryTreeNode<string> | null,
      conditions?: { [key: string]: boolean }
    ): string {
      if (!node) throw new Error('Invalid node');

      // If it's a leaf node, return the decision result
      if (!node.left && !node.right) return node.key;

      // Check if a valid condition exists for the current node's key
      return conditions?.[node.key]
        ? determineLoanApproval(node.left, conditions)
        : determineLoanApproval(node.right, conditions);
    }

    // Test case 1: Stable income and good credit score
    console.log(determineLoanApproval(loanDecisionTree.root, { stableIncome: true, goodCredit: true })); // 'Approved'

    // Test case 2: Stable income but poor credit score
    console.log(determineLoanApproval(loanDecisionTree.root, { stableIncome: true, goodCredit: false })); // 'Rejected'

    // Test case 3: No stable income
    console.log(determineLoanApproval(loanDecisionTree.root, { stableIncome: false, goodCredit: true })); // 'Rejected'

    // Test case 4: No stable income and poor credit score
    console.log(determineLoanApproval(loanDecisionTree.root, { stableIncome: false, goodCredit: false })); // 'Rejected'

Example

// evaluate the arithmetic expression represented by the binary tree
    const expressionTree = new BinaryTree<number | string>(['+', 3, '*', null, null, 5, '-', null, null, 2, 8]);

    function evaluate(node?: BinaryTreeNode<number | string> | null): number {
      if (!node) return 0;

      if (typeof node.key === 'number') return node.key;

      const leftValue = evaluate(node.left); // Evaluate the left subtree
      const rightValue = evaluate(node.right); // Evaluate the right subtree

      // Perform the operation based on the current node's operator
      switch (node.key) {
        case '+':
          return leftValue + rightValue;
        case '-':
          return leftValue - rightValue;
        case '*':
          return leftValue * rightValue;
        case '/':
          return rightValue !== 0 ? leftValue / rightValue : 0; // Handle division by zero
        default:
          throw new Error(`Unsupported operator: ${node.key}`);
      }
    }

    console.log(evaluate(expressionTree.root)); // -27

Type Parameters

K = any
The type of the key.
V = any
The type of the value.
R extends object = object
The type of the raw data object (if using toEntryFn).
1. Two Children Maximum: Each node has at most two children.
2. Left and Right Children: Nodes have distinct left and right children.
3. Depth and Height: Depth is the number of edges from the root to a node; height is the maximum depth in the tree.
4. Subtrees: Each child of a node forms the root of a subtree.
5. Leaf Nodes: Nodes without children are leaves.

Hierarchy (view full)

IterableEntryBase<K, V | undefined>
- BinaryTree
  - BST

Implements

IBinaryTree<K, V, R>

Constructors

constructor

new BinaryTree<K, V, R>(keysNodesEntriesOrRaws?, options?): BinaryTree<K, V, R>
Creates an instance of BinaryTree.
Type Parameters
- K = any
- V = any
- R extends object = object
Parameters
- OptionalkeysNodesEntriesOrRaws: Iterable<
      | undefined
      | null
      | K
      | R
      | BinaryTreeNode<K, V>
      | [undefined | null | K, undefined | V], any, any> = []
  An iterable of items to add.
- Optionaloptions: BinaryTreeOptions<K, V, R>
  Configuration options for the tree.
Returns BinaryTree<K, V, R>
Remarks
Time O(N * M), where N is the number of items in keysNodesEntriesOrRaws and M is the tree size at insertion time (due to O(M) add operation). Space O(N) for storing the nodes.
Overrides IterableEntryBase<K, V | undefined>.constructor
- Defined in data-structures/binary-tree/binary-tree.ts:282

Accessors

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

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

root

get root(): undefined | null | BinaryTreeNode<K, V>
Gets the root node of the tree.

Returns undefined | null | BinaryTreeNode<K, V>
The root node.

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

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
Overrides IterableEntryBase.size
- Defined in data-structures/binary-tree/binary-tree.ts:357

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

`Protected`_createInstance

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

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

`Protected`_createLike

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

Remarks
Time O(N) (or as per constructor) due to processing the iterable.
- Defined in data-structures/binary-tree/binary-tree.ts:1987

_createNode

_createNode(key, value?): BinaryTreeNode<K, V>
(Protected) Creates a new 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 BinaryTreeNode<K, V>
The newly created node.

Remarks
Time O(1), Space O(1)
Implementation of IBinaryTree._createNode
- Defined in data-structures/binary-tree/binary-tree.ts:393

`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)
- Defined in data-structures/binary-tree/binary-tree.ts:1942

`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.
- 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)
- 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)
- 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)
- 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.
Overrides IterableEntryBase._getIterator
- Defined in data-structures/binary-tree/binary-tree.ts:1896

`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)
- Defined in data-structures/binary-tree/binary-tree.ts:2264

`Protected`_keyValueNodeOrEntryToNodeAndValue

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

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

`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)
- Defined in data-structures/binary-tree/binary-tree.ts:2177

`Protected`_setRoot

_setRoot(v): void
(Protected) Sets the root node and clears its parent reference.
Parameters
- v: undefined | null | BinaryTreeNode<K, V>
  The node to set as root.
Returns void
Remarks
Time O(1)
- Defined in data-structures/binary-tree/binary-tree.ts:2201

`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).
- Defined in data-structures/binary-tree/binary-tree.ts:2296

`Protected`_snapshotOptions

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

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

`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)
- Defined in data-structures/binary-tree/binary-tree.ts:2143

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

add

add(keyNodeOrEntry, value?): boolean
Adds 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.
- 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.add
- Defined in data-structures/binary-tree/binary-tree.ts:567

addMany

addMany(keysNodesEntriesOrRaws, values?): boolean[]
Adds 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.
- 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).
Implementation of IBinaryTree.addMany
- Defined in data-structures/binary-tree/binary-tree.ts:630

bfs

bfs<C>(callback?, startNode?, iterationType?, includeNull?): ReturnType<C>[]
Type Parameters
- C extends NodeCallback<BinaryTreeNode<K, V>>
Parameters
- Optionalcallback: C
- OptionalstartNode:
      | null
      | K
      | BinaryTreeNode<K, V>
      | [undefined | null | K, undefined | V]
- OptionaliterationType: IterationType
- OptionalincludeNull: false
Returns ReturnType<C>[]
Implementation of IBinaryTree.bfs
- Defined in data-structures/binary-tree/binary-tree.ts:1329
bfs<C>(callback?, startNode?, iterationType?, includeNull?): ReturnType<C>[]
Type Parameters
- C extends NodeCallback<null | BinaryTreeNode<K, V>>
Parameters
- Optionalcallback: C
- OptionalstartNode:
      | null
      | K
      | BinaryTreeNode<K, V>
      | [undefined | null | K, undefined | V]
- OptionaliterationType: IterationType
- OptionalincludeNull: true
Returns ReturnType<C>[]
Implementation of IBinaryTree.bfs
- Defined in data-structures/binary-tree/binary-tree.ts:1336

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
Overrides IterableEntryBase.clear
- Defined in data-structures/binary-tree/binary-tree.ts:936

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
Overrides IterableEntryBase.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
- Defined in data-structures/binary-tree/binary-tree.ts:404

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

dfs

dfs<C>(callback?, pattern?, onlyOne?, startNode?, iterationType?): ReturnType<C>[]
Type Parameters
- C extends NodeCallback<BinaryTreeNode<K, V>>
Parameters
- Optionalcallback: C
- Optionalpattern: DFSOrderPattern
- OptionalonlyOne: boolean
- OptionalstartNode:
      | null
      | K
      | BinaryTreeNode<K, V>
      | [undefined | null | K, undefined | V]
- OptionaliterationType: IterationType
Returns ReturnType<C>[]
Implementation of IBinaryTree.dfs
- Defined in data-structures/binary-tree/binary-tree.ts:1286
dfs<C>(callback?, pattern?, onlyOne?, startNode?, iterationType?, includeNull?): ReturnType<C>[]
Type Parameters
- C extends NodeCallback<null | BinaryTreeNode<K, V>>
Parameters
- Optionalcallback: C
- Optionalpattern: DFSOrderPattern
- OptionalonlyOne: boolean
- OptionalstartNode:
      | null
      | K
      | BinaryTreeNode<K, V>
      | [undefined | null | K, undefined | V]
- OptionaliterationType: IterationType
- OptionalincludeNull: boolean
Returns ReturnType<C>[]
Implementation of IBinaryTree.dfs
- Defined in data-structures/binary-tree/binary-tree.ts:1294

ensureNode

ensureNode(keyNodeOrEntry, iterationType?): undefined | null | BinaryTreeNode<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
      | BinaryTreeNode<K, V>
      | [undefined | null | K, undefined | V]
  The item to resolve to a node.
- OptionaliterationType: IterationType = ...
  The traversal method to use if searching.
Returns undefined | null | BinaryTreeNode<K, V>
The resolved node, or null/undefined if not found or input is null/undefined.

Remarks
Time O(1) if a node is passed. O(N) if a key or entry is passed (due to getNode performing a full search). Space O(1) if iterative search, O(H) if recursive (where H is height, O(N) worst-case).
- Defined in data-structures/binary-tree/binary-tree.ts:416

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 IterableEntryBase.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 IterableEntryBase.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
Overrides IterableEntryBase.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 IterableEntryBase.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 IterableEntryBase.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
Overrides IterableEntryBase.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
- 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
- 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
- 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
- Defined in data-structures/binary-tree/binary-tree.ts:1090

getNode

getNode(keyNodeEntryOrPredicate, startNode?, iterationType?): undefined | null | BinaryTreeNode<K, V>
Gets the first node matching a predicate.
Parameters
- keyNodeEntryOrPredicate:
      | undefined
      | null
      | K
      | BinaryTreeNode<K, V>
      | [undefined | null | K, undefined | V]
      | NodePredicate<null | BinaryTreeNode<K, V>>
  The key, node, entry, or predicate function to search 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 undefined | null | BinaryTreeNode<K, V>
The first matching node, or undefined if not found.

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

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

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
- 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
Overrides IterableEntryBase.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)
- 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).
- 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)
- Defined in data-structures/binary-tree/binary-tree.ts:496

isNode

isNode(keyNodeOrEntry): keyNodeOrEntry is BinaryTreeNode<K, V>
Checks if the given item is a BinaryTreeNode instance.
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 node, false otherwise.

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

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

isValidKey

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

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

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

listLevels

listLevels<C>(callback?, startNode?, iterationType?, includeNull?): ReturnType<C>[][]
Type Parameters
- C extends NodeCallback<BinaryTreeNode<K, V>>
Parameters
- Optionalcallback: C
- OptionalstartNode:
      | null
      | K
      | BinaryTreeNode<K, V>
      | [undefined | null | K, undefined | V]
- OptionaliterationType: IterationType
- OptionalincludeNull: false
Returns ReturnType<C>[][]
Implementation of IBinaryTree.listLevels
- Defined in data-structures/binary-tree/binary-tree.ts:1462
listLevels<C>(callback?, startNode?, iterationType?, includeNull?): ReturnType<C>[][]
Type Parameters
- C extends NodeCallback<null | BinaryTreeNode<K, V>>
Parameters
- Optionalcallback: C
- OptionalstartNode:
      | null
      | K
      | BinaryTreeNode<K, V>
      | [undefined | null | K, undefined | V]
- OptionaliterationType: IterationType
- OptionalincludeNull: true
Returns ReturnType<C>[][]
Implementation of IBinaryTree.listLevels
- Defined in data-structures/binary-tree/binary-tree.ts:1469

map

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

Remarks
Time O(N * M), where N is nodes in this tree, and M is size of the new tree during insertion. Space O(N) for the new tree.
Implementation of IBinaryTree.map
Overrides IterableEntryBase.map
- Defined in data-structures/binary-tree/binary-tree.ts:1692

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

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).
Overrides IterableEntryBase.print
- Defined in data-structures/binary-tree/binary-tree.ts:1744

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 IterableEntryBase.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
- 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.
Type Parameters
- C extends NodeCallback<null | BinaryTreeNode<K, V>>
  The type of the callback function.
Parameters
- keyNodeEntryOrPredicate:
      | undefined
      | null
      | K
      | BinaryTreeNode<K, V>
      | [undefined | null | K, undefined | V]
      | NodePredicate<null | BinaryTreeNode<K, V>>
  The key, node, entry, or predicate function 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
      | BinaryTreeNode<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
Time O(log N), For BST, Red-Black Tree, and AVL Tree subclasses, the worst-case time is O(log N). Performs a full DFS (pre-order) scan of the tree. Time O(N), as it may 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.search
- Defined in data-structures/binary-tree/binary-tree.ts:762

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

Class BinaryTree<K, V, R>

Remarks

Example

Example

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BinaryTree<K, V, R>

Remarks

Accessors

isDuplicate

Returns boolean

Remarks

isMapMode

Returns boolean

Remarks

NIL

Returns BinaryTreeNode<K, V>

Remarks

root

Returns undefined | null | BinaryTreeNode<K, V>

Remarks

size

Returns number

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_createInstance

Type Parameters

Parameters

Returns this

Remarks

Protected_createLike

Type Parameters

Parameters

Returns BinaryTree<TK, TV, TR>

Remarks

_createNode

Parameters

Returns BinaryTreeNode<K, V>

Remarks

Protected_DEFAULT_NODE_CALLBACK

Parameters

Returns undefined | K

Remarks

Protected_dfs

Type Parameters

Parameters

Parameters

Returns boolean

Parameters

Returns boolean

Parameters

Returns boolean

Parameters

Returns boolean

Returns ReturnType<C>[]

`Protected`_clearNodes

`Protected`_clearValues

`Protected`_clone

`Protected`_createInstance

`Protected`_createLike

`Protected`_DEFAULT_NODE_CALLBACK

`Protected`_dfs

`Protected`_displayAux

`Protected`_ensurePredicate

`Protected`_extractKey

`Protected`_getIterator

`Protected`_isPredicate

`Protected`_keyValueNodeOrEntryToNodeAndValue

`Protected`_replaceNode

`Protected`_setRoot

`Protected`_setValue

`Protected`_snapshotOptions

`Protected`_swapProperties