max-heap-typed 2.2.4 → 2.2.6

package/dist/types/data-structures/binary-tree/bst.d.ts

@@ -5,7 +5,7 @@
  * @copyright Copyright (c) 2022 Pablo Zeng <zrwusa@gmail.com>
  * @license MIT License
  */
-import type { BinaryTreeDeleteResult, BSTNOptKeyOrNode, BSTOptions, BTNRep, Comparator, CP, DFSOrderPattern, EntryCallback, FamilyPosition, IterationType, NodeCallback, NodePredicate, OptNode, RBTNColor } from '../../types';
+import type { BinaryTreeDeleteResult, BSTNOptKeyOrNode, BSTOptions, BTNRep, Comparator, DFSOrderPattern, EntryCallback, FamilyPosition, IterationType, NodeCallback, NodePredicate, OptNode, RBTNColor } from '../../types';
 import { BinaryTree } from './binary-tree';
 import { IBinaryTree } from '../../interfaces';
 import { Range } from '../../common';
@@ -257,7 +257,7 @@ export declare class BSTNode<K = any, V = any> {
  *       return findFirstCommon(path1, path2);
  *     };
  *
- *     function findFirstCommon(arr1: number[], arr2: number[]): number | undefined {
+ *     function findFirstCommon(arr1: (number | undefined)[], arr2: (number | undefined)[]): number | undefined {
  *       for (const num of arr1) {
  *         if (arr2.indexOf(num) !== -1) {
  *           return num;
@@ -288,12 +288,6 @@ export declare class BST<K = any, V = any, R = any> extends BinaryTree<K, V, R>
      * @returns The root node.
      */
     get root(): OptNode<BSTNode<K, V>>;
-    /**
-     * (Protected) Creates the default comparator function for keys that don't have a custom comparator.
-     * @remarks Time O(1) Space O(1)
-     * @returns The default comparator function.
-     */
-    protected _createDefaultComparator(): Comparator<K>;
     /**
      * The comparator function used to determine the order of keys in the tree.
   
@@ -341,41 +335,12 @@ export declare class BST<K = any, V = any, R = any> extends BinaryTree<K, V, R>
      * @returns True if the key is valid, false otherwise.
      */
     isValidKey(key: any): key is K;
-    /**
-     * Performs a Depth-First Search (DFS) traversal.
-     * @remarks Time O(N), visits every node. Space O(log N) for the call/explicit stack. O(N) worst-case.
-     *
-     * @template C - The type of the callback function.
-     * @param [callback=this._DEFAULT_NODE_CALLBACK] - Function to call on each node.
-     * @param [pattern='IN'] - The traversal order ('IN', 'PRE', 'POST').
-     * @param [onlyOne=false] - If true, stops after the first callback.
-     * @param [startNode=this._root] - The node to start from.
-     * @param [iterationType=this.iterationType] - The traversal method.
-     * @returns An array of callback results.
-     */
-    dfs<C extends NodeCallback<BSTNode<K, V>>>(callback?: C, pattern?: DFSOrderPattern, onlyOne?: boolean, startNode?: K | BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined, iterationType?: IterationType): ReturnType<C>[];
-    /**
-     * Performs a Breadth-First Search (BFS) or Level-Order traversal.
-     * @remarks Time O(N), visits every node. Space O(N) in the worst case for the queue.
-     *
-     * @template C - The type of the callback function.
-     * @param [callback=this._DEFAULT_NODE_CALLBACK] - Function to call on each node.
-     * @param [startNode=this._root] - The node to start from.
-     * @param [iterationType=this.iterationType] - The traversal method.
-     * @returns An array of callback results.
-     */
-    bfs<C extends NodeCallback<BSTNode<K, V>>>(callback?: C, startNode?: K | BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined, iterationType?: IterationType): ReturnType<C>[];
-    /**
-     * Returns a 2D array of nodes, grouped by level.
-     * @remarks Time O(N), visits every node. Space O(N) for the result array and the queue/stack.
-     *
-     * @template C - The type of the callback function.
-     * @param [callback=this._DEFAULT_NODE_CALLBACK] - Function to call on each node.
-     * @param [startNode=this._root] - The node to start from.
-     * @param [iterationType=this.iterationType] - The traversal method.
-     * @returns A 2D array of callback results.
-     */
-    listLevels<C extends NodeCallback<BSTNode<K, V>>>(callback?: C, startNode?: K | BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined, iterationType?: IterationType): ReturnType<C>[][];
+    dfs(): (K | undefined)[];
+    dfs<C extends NodeCallback<BSTNode<K, V>>>(callback: C, pattern?: DFSOrderPattern, onlyOne?: boolean, startNode?: K | BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined, iterationType?: IterationType): ReturnType<C>[];
+    bfs(): (K | undefined)[];
+    bfs<C extends NodeCallback<BSTNode<K, V>>>(callback: C, startNode?: K | BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined, iterationType?: IterationType): ReturnType<C>[];
+    listLevels(): (K | undefined)[][];
+    listLevels<C extends NodeCallback<BSTNode<K, V>>>(callback: C, startNode?: K | BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined, iterationType?: IterationType): ReturnType<C>[][];
     /**
      * Gets the first node matching a predicate.
      * @remarks Time O(log N) if searching by key, O(N) if searching by predicate. Space O(log N) or O(N).
@@ -386,33 +351,10 @@ export declare class BST<K = any, V = any, R = any> extends BinaryTree<K, V, R>
      * @returns The first matching node, or undefined if not found.
      */
     getNode(keyNodeEntryOrPredicate: K | BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined | NodePredicate<BSTNode<K, V>>, startNode?: BSTNOptKeyOrNode<K, BSTNode<K, V>>, iterationType?: IterationType): OptNode<BSTNode<K, V>>;
-    /**
-     * Searches the tree for nodes matching a predicate, key, or range.
-     * @remarks This is an optimized search for a BST. If searching by key or range, it prunes branches.
-     * Time O(H + M) for key/range search (H=height, M=matches). O(N) for predicate search.
-     * Space O(log N) for the stack.
-     *
-     * @template C - The type of the callback function.
-     * @param keyNodeEntryOrPredicate - The key, node, entry, predicate, or range to search for.
-     * @param [onlyOne=false] - If true, stops after finding the first match.
-     * @param [callback=this._DEFAULT_NODE_CALLBACK] - A function to call on matching nodes.
-     * @param [startNode=this._root] - The node to start the search from.
-     * @param [iterationType=this.iterationType] - Whether to use 'RECURSIVE' or 'ITERATIVE' search.
-     * @returns An array of results from the callback function for each matching node.
-     */
-    search<C extends NodeCallback<BSTNode<K, V>>>(keyNodeEntryOrPredicate: K | BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined | NodePredicate<BSTNode<K, V>> | Range<K>, onlyOne?: boolean, callback?: C, startNode?: K | BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined, iterationType?: IterationType): ReturnType<C>[];
-    /**
-     * Performs an optimized search for nodes within a given key range.
-     * @remarks Time O(H + M), where H is tree height and M is the number of matches.
-     *
-     * @template C - The type of the callback function.
-     * @param range - A `Range` object or a `[low, high]` tuple.
-     * @param [callback=this._DEFAULT_NODE_CALLBACK] - A function to call on matching nodes.
-     * @param [startNode=this._root] - The node to start the search from.
-     * @param [iterationType=this.iterationType] - The traversal method.
-     * @returns An array of callback results.
-     */
-    rangeSearch<C extends NodeCallback<BSTNode<K, V>>>(range: Range<K> | [K, K], callback?: C, startNode?: K | BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined, iterationType?: IterationType): ReturnType<C>[];
+    search(keyNodeEntryOrPredicate: K | BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined | NodePredicate<BSTNode<K, V>> | Range<K>, onlyOne?: boolean): (K | undefined)[];
+    search<C extends NodeCallback<BSTNode<K, V>>>(keyNodeEntryOrPredicate: K | BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined | NodePredicate<BSTNode<K, V>> | Range<K>, onlyOne: boolean, callback: C, startNode?: K | BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined, iterationType?: IterationType): ReturnType<C>[];
+    rangeSearch(range: Range<K> | [K, K]): (K | undefined)[];
+    rangeSearch<C extends NodeCallback<BSTNode<K, V>>>(range: Range<K> | [K, K], callback: C, startNode?: K | BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined, iterationType?: IterationType): ReturnType<C>[];
     /**
      * Adds a new node to the BST based on key comparison.
      * @remarks Time O(log N), where H is tree height. O(N) worst-case (unbalanced tree), O(log N) average. Space O(1).
@@ -436,39 +378,59 @@ export declare class BST<K = any, V = any, R = any> extends BinaryTree<K, V, R>
      */
     addMany(keysNodesEntriesOrRaws: Iterable<R | BTNRep<K, V, BSTNode<K, V>>>, values?: Iterable<V | undefined>, isBalanceAdd?: boolean, iterationType?: IterationType): boolean[];
     /**
-     * Returns the first node with a key greater than or equal to the given key.
-     * This is equivalent to C++ std::lower_bound on a BST.
-     * Supports RECURSIVE and ITERATIVE implementations.
-     * Time Complexity: O(log n) on average, O(h) where h is tree height.
+     * 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.
-     * @param keyNodeEntryOrPredicate - The key, node, entry, or predicate function to search for.
-     * @param iterationType The iteration type (RECURSIVE or ITERATIVE). Defaults to this.iterationType.
-     * @returns The first node with key >= given key, or undefined if no such node exists.
      */
-    lowerBound(keyNodeEntryOrPredicate: K | BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined | NodePredicate<BSTNode<K, V>>, iterationType?: IterationType): BSTNode<K, V> | undefined;
+    ceiling(keyNodeEntryOrPredicate: K | BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined | NodePredicate<BSTNode<K, V>>): K | undefined;
     /**
-     * Returns the first node with a key strictly greater than the given key.
-     * This is equivalent to C++ std::upper_bound on a BST.
-     * Supports RECURSIVE and ITERATIVE implementations.
-     * Time Complexity: O(log n) on average, O(h) where h is tree height.
+     * 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.
-     * @param keyNodeEntryOrPredicate - The key, node, entry, or predicate function to search for.
-     * @param iterationType The iteration type (RECURSIVE or ITERATIVE). Defaults to this.iterationType.
-     * @returns The first node with key > given key, or undefined if no such node exists.
      */
-    upperBound(keyNodeEntryOrPredicate: K | BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined | NodePredicate<BSTNode<K, V>>, iterationType?: IterationType): BSTNode<K, V> | undefined;
+    ceiling<C extends NodeCallback<BSTNode<K, V>>>(keyNodeEntryOrPredicate: K | BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined | NodePredicate<BSTNode<K, V>>, callback: C, iterationType?: IterationType): ReturnType<C>;
     /**
-     * Traverses the tree and returns nodes that are lesser or greater than a target node.
-     * @remarks Time O(N), as it performs a full traversal. Space O(log N) or O(N).
-     *
-     * @template C - The type of the callback function.
-     * @param [callback=this._DEFAULT_NODE_CALLBACK] - Function to call on matching nodes.
-     * @param [lesserOrGreater=-1] - -1 for lesser, 1 for greater, 0 for equal.
-     * @param [targetNode=this._root] - The node to compare against.
-     * @param [iterationType=this.iterationType] - The traversal method.
-     * @returns An array of callback results.
+     * 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.
+     */
+    higher(keyNodeEntryOrPredicate: K | BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined | NodePredicate<BSTNode<K, V>>): K | undefined;
+    /**
+     * 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.
      */
-    lesserOrGreaterTraverse<C extends NodeCallback<BSTNode<K, V>>>(callback?: C, lesserOrGreater?: CP, targetNode?: K | BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined, iterationType?: IterationType): ReturnType<C>[];
+    higher<C extends NodeCallback<BSTNode<K, V>>>(keyNodeEntryOrPredicate: K | BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined | NodePredicate<BSTNode<K, V>>, callback: C, iterationType?: IterationType): ReturnType<C>;
+    /**
+     * 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.
+     */
+    floor(keyNodeEntryOrPredicate: K | BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined | NodePredicate<BSTNode<K, V>>): K | undefined;
+    /**
+     * 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.
+     */
+    floor<C extends NodeCallback<BSTNode<K, V>>>(keyNodeEntryOrPredicate: K | BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined | NodePredicate<BSTNode<K, V>>, callback: C, iterationType?: IterationType): ReturnType<C>;
+    /**
+     * 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.
+     */
+    lower(keyNodeEntryOrPredicate: K | BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined | NodePredicate<BSTNode<K, V>>): K | undefined;
+    /**
+     * 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.
+     */
+    lower<C extends NodeCallback<BSTNode<K, V>>>(keyNodeEntryOrPredicate: K | BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined | NodePredicate<BSTNode<K, V>>, callback: C, iterationType?: IterationType): ReturnType<C>;
+    lesserOrGreaterTraverse(): (K | undefined)[];
+    lesserOrGreaterTraverse<C extends NodeCallback<BSTNode<K, V>>>(callback: C, lesserOrGreater?: number, targetNode?: K | BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined, iterationType?: IterationType): ReturnType<C>[];
     /**
      * Rebuilds the tree to be perfectly balanced.
      * @remarks Time O(N) (O(N) for DFS, O(N) for sorted build). Space O(N) for node array and recursion stack.
@@ -536,6 +498,58 @@ export declare class BST<K = any, V = any, R = any> extends BinaryTree<K, V, R>
      *   - If no nodes match the search criteria, the returned map is empty.
      */
     deleteWhere(keyNodeEntryOrPredicate: K | BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined | NodePredicate<BSTNode<K, V>> | Range<K>, onlyOne?: boolean, startNode?: K | BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined, iterationType?: IterationType): BinaryTreeDeleteResult<BSTNode<K, V>>[];
+    /**
+     * (Protected) Creates the default comparator function for keys that don't have a custom comparator.
+     * @remarks Time O(1) Space O(1)
+     * @returns The default comparator function.
+     */
+    protected _createDefaultComparator(): Comparator<K>;
+    /**
+     * (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.
+     * @remarks Time O(h) where h is tree height.
+     *
+     * @param key - The target key to search for.
+     * @param iterationType - The iteration type (RECURSIVE or ITERATIVE).
+     * @returns The first node with key <= target, or undefined if none exists.
+     */
+    protected _floorByKey(key: K, iterationType: IterationType): BSTNode<K, V> | undefined;
+    /**
+     * (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.
+     * @remarks Time Complexity: O(n) since it may visit every node.
+     * Space Complexity: O(h) for recursion, O(h) for iterative stack.
+     *
+     * @param predicate - The predicate function to test nodes.
+     * @param iterationType - The iteration type (RECURSIVE or ITERATIVE).
+     * @returns The last node satisfying predicate (highest key), or undefined if none found.
+     */
+    protected _floorByPredicate(predicate: NodePredicate<BSTNode<K, V>>, iterationType: IterationType): BSTNode<K, V> | undefined;
+    /**
+     * (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.
+     * @remarks Time O(h) where h is tree height.
+     *
+     * @param key - The target key to search for.
+     * @param iterationType - The iteration type (RECURSIVE or ITERATIVE).
+     * @returns The first node with key < target, or undefined if none exists.
+     */
+    protected _lowerByKey(key: K, iterationType: IterationType): BSTNode<K, V> | undefined;
+    /**
+     * (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.
+     * @remarks Time Complexity: O(n) since it may visit every node.
+     * Space Complexity: O(h) for recursion, O(h) for iterative stack.
+     *
+     * @param predicate - The predicate function to test nodes.
+     * @param iterationType - The iteration type (RECURSIVE or ITERATIVE).
+     * @returns The last node satisfying predicate (highest key < target), or undefined if none found.
+     */
+    protected _lowerByPredicate(predicate: NodePredicate<BSTNode<K, V>>, iterationType: IterationType): BSTNode<K, V> | undefined;
     /**
      * (Protected) Core bound search implementation supporting all parameter types.
      * Unified logic for both lowerBound and upperBound.

package/dist/umd/max-heap-typed.js

@@ -932,37 +932,6 @@ var maxHeapTyped = (() => {
     }
   };
 
-  // src/utils/utils.ts
-  function isPrimitiveComparable(value) {
-    const valueType = typeof value;
-    if (valueType === "number") return true;
-    return valueType === "bigint" || valueType === "string" || valueType === "boolean";
-  }
-  function tryObjectToPrimitive(obj) {
-    if (typeof obj.valueOf === "function") {
-      const valueOfResult = obj.valueOf();
-      if (valueOfResult !== obj) {
-        if (isPrimitiveComparable(valueOfResult)) return valueOfResult;
-        if (typeof valueOfResult === "object" && valueOfResult !== null) return tryObjectToPrimitive(valueOfResult);
-      }
-    }
-    if (typeof obj.toString === "function") {
-      const stringResult = obj.toString();
-      if (stringResult !== "[object Object]") return stringResult;
-    }
-    return null;
-  }
-  function isComparable(value, isForceObjectComparable = false) {
-    if (value === null || value === void 0) return false;
-    if (isPrimitiveComparable(value)) return true;
-    if (typeof value !== "object") return false;
-    if (value instanceof Date) return true;
-    if (isForceObjectComparable) return true;
-    const comparableValue = tryObjectToPrimitive(value);
-    if (comparableValue === null || comparableValue === void 0) return false;
-    return isPrimitiveComparable(comparableValue);
-  }
-
   // src/common/index.ts
   var DFSOperation = /* @__PURE__ */ ((DFSOperation2) => {
     DFSOperation2[DFSOperation2["VISIT"] = 0] = "VISIT";
@@ -975,8 +944,6 @@ var maxHeapTyped = (() => {
       this.high = high;
       this.includeLow = includeLow;
       this.includeHigh = includeHigh;
-      if (!(isComparable(low) && isComparable(high))) throw new RangeError("low or high is not comparable");
-      if (low > high) throw new RangeError("low must be less than or equal to high");
     }
     // Determine whether a key is within the range
     isInRange(key, comparator) {