data-structure-typed 2.6.0 → 2.6.2

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

@@ -5,7 +5,7 @@
  * @copyright Copyright (c) 2022 Pablo Zeng <zrwusa@gmail.com>
  * @license MIT License
  */
-import type { BTNRep, CRUD, EntryCallback, FamilyPosition, NodePredicate, RBTNColor, IterationType, RedBlackTreeOptions } from '../../types';
+import type { BTNRep, CRUD, EntryCallback, FamilyPosition, IterationType, NodePredicate, RBTNColor, RedBlackTreeOptions } from '../../types';
 import { BST } from './bst';
 import { IBinaryTree } from '../../interfaces';
 export declare class RedBlackTreeNode<K = any, V = any> {
@@ -174,8 +174,6 @@ export declare class RedBlackTreeNode<K = any, V = any> {
  *     console.log(stocksInRange.some((s: any) => s.symbol === 'MSFT')); // true;
  */
 export declare class RedBlackTree<K = any, V = any, R = any> extends BST<K, V, R> implements IBinaryTree<K, V, R> {
-    constructor(keysNodesEntriesOrRaws?: Iterable<K | RedBlackTreeNode<K, V> | [K | null | undefined, V | undefined] | null | undefined | R>, options?: RedBlackTreeOptions<K, V, R>);
-    protected _root: RedBlackTreeNode<K, V> | undefined;
     /**
      * (Internal) Header sentinel:
      * - header.parent -> root
@@ -194,6 +192,8 @@ export declare class RedBlackTree<K = any, V = any, R = any> extends BST<K, V, R
      */
     protected _minNode: RedBlackTreeNode<K, V> | undefined;
     protected _maxNode: RedBlackTreeNode<K, V> | undefined;
+    constructor(keysNodesEntriesOrRaws?: Iterable<K | RedBlackTreeNode<K, V> | [K | null | undefined, V | undefined] | null | undefined | R>, options?: RedBlackTreeOptions<K, V, R>);
+    protected _root: RedBlackTreeNode<K, V> | undefined;
     /**
      * Get the current root node.
      * @remarks Time O(1), Space O(1)
@@ -219,172 +219,104 @@ export declare class RedBlackTree<K = any, V = any, R = any> extends BST<K, V, R
     /**
      * Remove all nodes, clear the key→value store (if in map mode) and internal caches.
      * @remarks Time O(n), Space O(1)
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-      * @example
-   * // Remove all entries
-   *  const rbt = new RedBlackTree<number>([1, 2, 3]);
-   *     rbt.clear();
-   *     console.log(rbt.isEmpty()); // true;
+     * @example
+     * // Remove all entries
+     *  const rbt = new RedBlackTree<number>([1, 2, 3]);
+     *     rbt.clear();
+     *     console.log(rbt.isEmpty()); // true;
      */
     clear(): void;
+    /**
+     * Insert/update using a hint node to speed up nearby insertions.
+     *
+     * close to the expected insertion position (often the previously returned node in a loop).
+     *
+     * When the hint is a good fit (sorted / nearly-sorted insertion), this can avoid most of the
+     * normal root-to-leaf search and reduce constant factors.
+     *
+     * When the hint does not match (random workloads), this will fall back to the normal set path.
+     * @remarks Time O(log n) average, Space O(1)
+     */
+    setWithHintNode(key: K, value: V, hint?: RedBlackTreeNode<K, V>): RedBlackTreeNode<K, V> | undefined;
+    /**
+     * Boolean wrapper for setWithHintNode.
+     * @remarks Time O(log n) average, Space O(1)
+     */
+    setWithHint(key: K, value: V, hint?: RedBlackTreeNode<K, V>): boolean;
+    /**
+     * Insert or update a key/value (map mode) or key-only (set mode).
+     *
+     * This method is optimized for:
+     * - monotonic inserts via min/max boundary fast paths
+     * - updates via a single-pass search (no double walk)
+     *
+     * @remarks Time O(log n) average, Space O(1)
+     * @example
+     * // basic Red-Black Tree with simple number keys
+     *  // Create a simple Red-Black Tree with numeric keys
+     *     const tree = new RedBlackTree([5, 2, 8, 1, 9]);
+     *
+     *     tree.print();
+     *     //   _2___
+     *     //  /     \
+     *     //  1    _8_
+     *     //      /   \
+     *     //      5   9
+     *
+     *     // Verify the tree maintains sorted order
+     *     console.log([...tree.keys()]); // [1, 2, 5, 8, 9];
+     *
+     *     // Check size
+     *     console.log(tree.size); // 5;
+     */
+    set(keyNodeOrEntry: K | RedBlackTreeNode<K, V> | [K | null | undefined, V | undefined] | null | undefined, value?: V): boolean;
+    /**
+     * Delete a node by key/node/entry and rebalance as needed.
+     * @remarks Time O(log n) average, Space O(1)
+     * @param keyNodeEntryRawOrPredicate - Key, node, or [key, value] entry identifying the node to delete.
+     * @returns Array with deletion metadata (removed node, rebalancing hint if any).
+     * @example
+     * // Remove and rebalance
+     *  const rbt = new RedBlackTree<number>([10, 5, 15, 3, 7]);
+     *     rbt.delete(5);
+     *     console.log(rbt.has(5)); // false;
+     *     console.log(rbt.size); // 4;
+     */
+    delete(keyNodeEntryRawOrPredicate: BTNRep<K, V, RedBlackTreeNode<K, V>> | NodePredicate<RedBlackTreeNode<K, V> | null>): boolean;
+    /**
+     * Transform entries into a like-kind red-black tree with possibly different key/value types.
+     * @remarks Time O(n) average, Space O(n)
+     * @template MK
+     * @template MV
+     * @template MR
+     * @param callback - Mapping function from (key, value, index, tree) to a new [key, value].
+     * @param [options] - See parameter type for details.
+     * @param [thisArg] - See parameter type for details.
+     * @returns A new RedBlackTree with mapped entries.
+     */
+    /**
+     * Red-Black trees are self-balancing — `perfectlyBalance` rebuilds via
+     * sorted bulk insert, which naturally produces a balanced RBT.
+     * @remarks Time O(N), Space O(N)
+     * @example
+     * // Rebalance tree
+     *  const rbt = new RedBlackTree<number>([1, 2, 3, 4, 5]);
+     *     rbt.perfectlyBalance();
+     *     console.log(rbt.isAVLBalanced()); // true;
+     */
+    perfectlyBalance(_iterationType?: IterationType): boolean;
+    /**
+     * Transform to new tree
+     * @example
+     * // Transform to new tree
+     *  const rbt = new RedBlackTree<number, number>([
+     *       [1, 10],
+     *       [2, 20]
+     *     ]);
+     *     const doubled = rbt.map((v, k) => [k, (v ?? 0) * 2] as [number, number]);
+     *     console.log([...doubled.values()]); // [20, 40];
+     */
+    map<MK = K, MV = V, MR = any>(callback: EntryCallback<K, V | undefined, [MK, MV]>, options?: Partial<RedBlackTreeOptions<MK, MV, MR>>, thisArg?: unknown): RedBlackTree<MK, MV, MR>;
     /**
      * (Internal) Find a node by key using a tight BST walk (no allocations).
      *
@@ -459,693 +391,6 @@ export declare class RedBlackTree<K = any, V = any, R = any> extends BST<K, V, R
      * @remarks Time O(log n) average, Space O(1)
      */
     protected _setKV(key: K, nextValue?: V): boolean;
-    /**
-     * Insert/update using a hint node to speed up nearby insertions.
-     *
-     * close to the expected insertion position (often the previously returned node in a loop).
-     *
-     * When the hint is a good fit (sorted / nearly-sorted insertion), this can avoid most of the
-     * normal root-to-leaf search and reduce constant factors.
-     *
-     * When the hint does not match (random workloads), this will fall back to the normal set path.
-     * @remarks Time O(log n) average, Space O(1)
-     */
-    setWithHintNode(key: K, value: V, hint?: RedBlackTreeNode<K, V>): RedBlackTreeNode<K, V> | undefined;
-    /**
-     * Boolean wrapper for setWithHintNode.
-     * @remarks Time O(log n) average, Space O(1)
-     */
-    setWithHint(key: K, value: V, hint?: RedBlackTreeNode<K, V>): boolean;
-    /**
-     * Insert or update a key/value (map mode) or key-only (set mode).
-     *
-     * This method is optimized for:
-     * - monotonic inserts via min/max boundary fast paths
-     * - updates via a single-pass search (no double walk)
-     *
-     * @remarks Time O(log n) average, Space O(1)
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-      * @example
-   * // basic Red-Black Tree with simple number keys
-   *  // Create a simple Red-Black Tree with numeric keys
-   *     const tree = new RedBlackTree([5, 2, 8, 1, 9]);
-   *
-   *     tree.print();
-   *     //   _2___
-   *     //  /     \
-   *     //  1    _8_
-   *     //      /   \
-   *     //      5   9
-   *
-   *     // Verify the tree maintains sorted order
-   *     console.log([...tree.keys()]); // [1, 2, 5, 8, 9];
-   *
-   *     // Check size
-   *     console.log(tree.size); // 5;
-     */
-    set(keyNodeOrEntry: K | RedBlackTreeNode<K, V> | [K | null | undefined, V | undefined] | null | undefined, value?: V): boolean;
-    /**
-     * Delete a node by key/node/entry and rebalance as needed.
-     * @remarks Time O(log n) average, Space O(1)
-     * @param keyNodeEntryRawOrPredicate - Key, node, or [key, value] entry identifying the node to delete.
-     * @returns Array with deletion metadata (removed node, rebalancing hint if any).
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-      * @example
-   * // Remove and rebalance
-   *  const rbt = new RedBlackTree<number>([10, 5, 15, 3, 7]);
-   *     rbt.delete(5);
-   *     console.log(rbt.has(5)); // false;
-   *     console.log(rbt.size); // 4;
-     */
-    delete(keyNodeEntryRawOrPredicate: BTNRep<K, V, RedBlackTreeNode<K, V>> | NodePredicate<RedBlackTreeNode<K, V> | null>): boolean;
-    /**
-     * Transform entries into a like-kind red-black tree with possibly different key/value types.
-     * @remarks Time O(n) average, Space O(n)
-     * @template MK
-     * @template MV
-     * @template MR
-     * @param callback - Mapping function from (key, value, index, tree) to a new [key, value].
-     * @param [options] - See parameter type for details.
-     * @param [thisArg] - See parameter type for details.
-     * @returns A new RedBlackTree with mapped entries.
-     */
-    /**
-     * Red-Black trees are self-balancing — `perfectlyBalance` rebuilds via
-     * sorted bulk insert, which naturally produces a balanced RBT.
-     * @remarks Time O(N), Space O(N)
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-      * @example
-   * // Rebalance tree
-   *  const rbt = new RedBlackTree<number>([1, 2, 3, 4, 5]);
-   *     rbt.perfectlyBalance();
-   *     console.log(rbt.isAVLBalanced()); // true;
-     */
-    perfectlyBalance(_iterationType?: IterationType): boolean;
-    /**
-   * Transform to new tree
-  
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-    * @example
- * // Transform to new tree
- *  const rbt = new RedBlackTree<number, number>([[1, 10], [2, 20]]);
- *     const doubled = rbt.map((v, k) => [k, (v ?? 0) * 2] as [number, number]);
- *     console.log([...doubled.values()]); // [20, 40];
-   */
-    map<MK = K, MV = V, MR = any>(callback: EntryCallback<K, V | undefined, [MK, MV]>, options?: Partial<RedBlackTreeOptions<MK, MV, MR>>, thisArg?: unknown): RedBlackTree<MK, MV, MR>;
     /**
      * (Internal) Create an empty instance of the same concrete tree type.
      * @remarks Time O(1) average, Space O(1)