avl-tree-typed 2.1.0 → 2.1.2

package/dist/data-structures/binary-tree/segment-tree.js

@@ -1,297 +0,0 @@
-"use strict";
-/**
- * data-structure-typed
- *
- * @author Pablo Zeng
- * @copyright Copyright (c) 2022 Pablo Zeng <zrwusa@gmail.com>
- * @license MIT License
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SegmentTree = exports.SegmentTreeNode = void 0;
-class SegmentTreeNode {
-    /**
-     * The constructor initializes the properties of a SegmentTreeNode object.
-     * @param {number} start - The `start` parameter represents the starting index of the segment covered
-     * by this node in a segment tree.
-     * @param {number} end - The `end` parameter represents the end index of the segment covered by this
-     * node in a segment tree.
-     * @param {number} sum - The `sum` parameter represents the sum of the values in the range covered by
-     * the segment tree node.
-     * @param {SegmentTreeNodeVal | undefined} [value] - The `value` parameter is an optional parameter
-     * of type `SegmentTreeNodeVal`. It represents the value associated with the segment tree node.
-     */
-    constructor(start, end, sum, value) {
-        this._start = 0;
-        this._end = 0;
-        this._value = undefined;
-        this._sum = 0;
-        this._left = undefined;
-        this._right = undefined;
-        this._start = start;
-        this._end = end;
-        this._sum = sum;
-        this._value = value || undefined;
-    }
-    /**
-     * The function returns the value of the protected variable _start.
-     * @returns The start value, which is of type number.
-     */
-    get start() {
-        return this._start;
-    }
-    /**
-     * The above function sets the value of the "start" property.
-     * @param {number} value - The value parameter is of type number.
-     */
-    set start(value) {
-        this._start = value;
-    }
-    /**
-     * The function returns the value of the protected variable `_end`.
-     * @returns The value of the protected property `_end`.
-     */
-    get end() {
-        return this._end;
-    }
-    /**
-     * The above function sets the value of the "end" property.
-     * @param {number} value - The value parameter is a number that represents the new value for the end
-     * property.
-     */
-    set end(value) {
-        this._end = value;
-    }
-    /**
-     * The function returns the value of a segment tree node.
-     * @returns The value being returned is either a `SegmentTreeNodeVal` object or `undefined`.
-     */
-    get value() {
-        return this._value;
-    }
-    /**
-     * The function sets the value of a segment tree node.
-     * @param {SegmentTreeNodeVal | undefined} value - The `value` parameter is of type
-     * `SegmentTreeNodeVal` or `undefined`.
-     */
-    set value(value) {
-        this._value = value;
-    }
-    /**
-     * The function returns the value of the sum property.
-     * @returns The method is returning the value of the variable `_sum`.
-     */
-    get sum() {
-        return this._sum;
-    }
-    /**
-     * The above function sets the value of the sum property.
-     * @param {number} value - The parameter "value" is of type "number".
-     */
-    set sum(value) {
-        this._sum = value;
-    }
-    /**
-     * The function returns the left child of a segment tree node.
-     * @returns The `left` property of the `SegmentTreeNode` object is being returned. It is of type
-     * `SegmentTreeNode` or `undefined`.
-     */
-    get left() {
-        return this._left;
-    }
-    /**
-     * The function sets the value of the left property of a SegmentTreeNode object.
-     * @param {SegmentTreeNode | undefined} value - The value parameter is of type SegmentTreeNode or
-     * undefined.
-     */
-    set left(value) {
-        this._left = value;
-    }
-    /**
-     * The function returns the right child of a segment tree node.
-     * @returns The `getRight()` method is returning a value of type `SegmentTreeNode` or `undefined`.
-     */
-    get right() {
-        return this._right;
-    }
-    /**
-     * The function sets the right child of a segment tree node.
-     * @param {SegmentTreeNode | undefined} value - The `value` parameter is of type `SegmentTreeNode |
-     * undefined`. This means that it can accept either a `SegmentTreeNode` object or `undefined` as its
-     * value.
-     */
-    set right(value) {
-        this._right = value;
-    }
-}
-exports.SegmentTreeNode = SegmentTreeNode;
-class SegmentTree {
-    /**
-     * The constructor initializes the values, start, end, and root properties of an object.
-     * @param {number[]} values - An array of numbers that will be used to build a binary search tree.
-     * @param {number} [start] - The `start` parameter is the index of the first element in the `values` array that should
-     * be included in the range. If no value is provided for `start`, it defaults to 0, which means the range starts from
-     * the beginning of the array.
-     * @param {number} [end] - The "end" parameter is the index of the last element in the "values" array that should be
-     * included in the range. If not provided, it defaults to the index of the last element in the "values" array.
-     */
-    constructor(values, start, end) {
-        this._values = [];
-        this._start = 0;
-        start = start || 0;
-        end = end || values.length - 1;
-        this._values = values;
-        this._start = start;
-        this._end = end;
-        if (values.length > 0) {
-            this._root = this.build(start, end);
-        }
-        else {
-            this._root = undefined;
-            this._values = [];
-        }
-    }
-    /**
-     * The function returns an array of numbers.
-     * @returns An array of numbers is being returned.
-     */
-    get values() {
-        return this._values;
-    }
-    /**
-     * The function returns the value of the protected variable _start.
-     * @returns The start value, which is of type number.
-     */
-    get start() {
-        return this._start;
-    }
-    /**
-     * The function returns the value of the protected variable `_end`.
-     * @returns The value of the protected property `_end`.
-     */
-    get end() {
-        return this._end;
-    }
-    /**
-     * The function returns the root node of a segment tree.
-     * @returns The `root` property of the class `SegmentTreeNode` or `undefined` if it is not defined.
-     */
-    get root() {
-        return this._root;
-    }
-    /**
-     * The build function creates a segment tree by recursively dividing the given range into smaller segments and assigning
-     * the sum of values to each segment.
-     * @param {number} start - The `start` parameter represents the starting index of the segment or range for which we are
-     * building the segment tree.
-     * @param {number} end - The "end" parameter represents the ending index of the segment or range for which we want to
-     * build a segment tree.
-     * @returns a SegmentTreeNode object.
-     */
-    build(start, end) {
-        if (start > end) {
-            return new SegmentTreeNode(start, end, 0);
-        }
-        if (start === end)
-            return new SegmentTreeNode(start, end, this._values[start]);
-        const mid = start + Math.floor((end - start) / 2);
-        const left = this.build(start, mid);
-        const right = this.build(mid + 1, end);
-        const cur = new SegmentTreeNode(start, end, left.sum + right.sum);
-        cur.left = left;
-        cur.right = right;
-        return cur;
-    }
-    /**
-     * The function updates the value of a node in a segment tree and recalculates the sum of its children if they exist.
-     * @param {number} index - The index parameter represents the index of the node in the segment tree that needs to be
-     * updated.
-     * @param {number} sum - The `sum` parameter represents the new value that should be assigned to the `sum` property of
-     * the `SegmentTreeNode` at the specified `index`.
-     * @param {SegmentTreeNodeVal} [value] - The `value` parameter is an optional value that can be assigned to the `value`
-     * property of the `SegmentTreeNode` object. It is not currently used in the code, but you can uncomment the line `//
-     * cur.value = value;` and pass a value for `value` in the
-     * @returns The function does not return anything.
-     */
-    updateNode(index, sum, value) {
-        const root = this.root || undefined;
-        if (!root) {
-            return;
-        }
-        const dfs = (cur, index, sum, value) => {
-            if (cur.start === cur.end && cur.start === index) {
-                cur.sum = sum;
-                if (value !== undefined)
-                    cur.value = value;
-                return;
-            }
-            const mid = cur.start + Math.floor((cur.end - cur.start) / 2);
-            if (index <= mid) {
-                if (cur.left) {
-                    dfs(cur.left, index, sum, value);
-                }
-            }
-            else {
-                if (cur.right) {
-                    dfs(cur.right, index, sum, value);
-                }
-            }
-            if (cur.left && cur.right) {
-                cur.sum = cur.left.sum + cur.right.sum;
-            }
-        };
-        dfs(root, index, sum, value);
-    }
-    /**
-     * The function `querySumByRange` calculates the sum of values within a given range in a segment tree.
-     * @param {number} indexA - The starting index of the range for which you want to calculate the sum.
-     * @param {number} indexB - The parameter `indexB` represents the ending index of the range for which you want to
-     * calculate the sum.
-     * @returns The function `querySumByRange` returns a number.
-     */
-    querySumByRange(indexA, indexB) {
-        const root = this.root || undefined;
-        if (!root) {
-            return 0;
-        }
-        if (indexA < 0 || indexB >= this.values.length || indexA > indexB) {
-            return NaN;
-        }
-        const dfs = (cur, i, j) => {
-            if (i <= cur.start && j >= cur.end) {
-                // The range [i, j] completely covers the current node's range [cur.start, cur.end]
-                return cur.sum;
-            }
-            const mid = cur.start + Math.floor((cur.end - cur.start) / 2);
-            if (j <= mid) {
-                if (cur.left) {
-                    return dfs(cur.left, i, j);
-                }
-                else {
-                    return NaN;
-                }
-            }
-            else if (i > mid) {
-                if (cur.right) {
-                    return dfs(cur.right, i, j);
-                }
-                else {
-                    return NaN;
-                }
-            }
-            else {
-                // Query both left and right subtrees
-                let leftSum = 0;
-                let rightSum = 0;
-                if (cur.left) {
-                    leftSum = dfs(cur.left, i, mid);
-                }
-                if (cur.right) {
-                    rightSum = dfs(cur.right, mid + 1, j);
-                }
-                return leftSum + rightSum;
-            }
-        };
-        return dfs(root, indexA, indexB);
-    }
-}
-exports.SegmentTree = SegmentTree;

package/dist/data-structures/binary-tree/tree-counter.d.ts

@@ -1,190 +0,0 @@
-/**
- * data-structure-typed
- *
- * @author Pablo Zeng
- * @copyright Copyright (c) 2022 Pablo Zeng <zrwusa@gmail.com>
- * @license MIT License
- */
-import type { BinaryTreeDeleteResult, BinaryTreeOptions, BSTNOptKeyOrNode, EntryCallback, IterationType, RBTNColor, TreeCounterOptions } from '../../types';
-import { BSTOptions } from '../../types';
-import { BSTNode } from './bst';
-import { IBinaryTree } from '../../interfaces';
-import { RedBlackTree, RedBlackTreeNode } from './red-black-tree';
-/**
- * RB-tree node with an extra 'count' field; keeps parent/child links.
- * @remarks Time O(1), Space O(1)
- * @template K
- * @template V
- */
-export declare class TreeCounterNode<K = any, V = any> extends RedBlackTreeNode<K, V> {
-    parent?: TreeCounterNode<K, V>;
-    /**
-     * Create a tree counter node.
-     * @remarks Time O(1), Space O(1)
-     * @param key - Key of the node.
-     * @param [value] - Value associated with the key (ignored in map mode).
-     * @param [count] - Initial count for this node (default 1).
-     * @param color - Initial color ('RED' or 'BLACK').
-     * @returns New TreeCounterNode instance.
-     */
-    constructor(key: K, value?: V, count?: number, color?: RBTNColor);
-    _left?: TreeCounterNode<K, V> | null | undefined;
-    /**
-     * Get the left child pointer.
-     * @remarks Time O(1), Space O(1)
-     * @returns Left child node, or null/undefined.
-     */
-    get left(): TreeCounterNode<K, V> | null | undefined;
-    /**
-     * Set the left child and update its parent pointer.
-     * @remarks Time O(1), Space O(1)
-     * @param v - New left child node, or null/undefined.
-     * @returns void
-     */
-    set left(v: TreeCounterNode<K, V> | null | undefined);
-    _right?: TreeCounterNode<K, V> | null | undefined;
-    /**
-     * Get the right child pointer.
-     * @remarks Time O(1), Space O(1)
-     * @returns Right child node, or null/undefined.
-     */
-    get right(): TreeCounterNode<K, V> | null | undefined;
-    /**
-     * Set the right child and update its parent pointer.
-     * @remarks Time O(1), Space O(1)
-     * @param v - New right child node, or null/undefined.
-     * @returns void
-     */
-    set right(v: TreeCounterNode<K, V> | null | undefined);
-}
-/**
- * Red-Black Tree–based counter map (key → value with per-node count). Supports O(log N) updates and map-like mode.
- * @remarks Time O(1), Space O(1)
- * @template K
- * @template V
- * @template R
- */
-export declare class TreeCounter<K = any, V = any, R extends object = object> extends RedBlackTree<K, V, R> implements IBinaryTree<K, V, R> {
-    /**
-     * Create a TreeCounter and optionally bulk-insert items.
-     * @remarks Time O(N log N), Space O(N)
-     * @param [keysNodesEntriesOrRaws] - Iterable of keys/nodes/entries/raw items to insert.
-     * @param [options] - Options for TreeCounter (comparator, reverse, map mode).
-     * @returns New TreeCounter instance.
-     */
-    constructor(keysNodesEntriesOrRaws?: Iterable<K | TreeCounterNode<K, V> | [K | null | undefined, V | undefined] | null | undefined | R>, options?: TreeCounterOptions<K, V, R>);
-    protected _count: number;
-    /**
-     * Get the total aggregate count across all nodes.
-     * @remarks Time O(1), Space O(1)
-     * @returns Total count.
-     */
-    get count(): number;
-    /**
-     * Compute the total count by traversing the tree (sums node.count).
-     * @remarks Time O(N), Space O(H)
-     * @returns Total count recomputed from nodes.
-     */
-    getComputedCount(): number;
-    _createNode(key: K, value?: V, color?: RBTNColor, count?: number): TreeCounterNode<K, V>;
-    /**
-     * Type guard: check whether the input is a TreeCounterNode.
-     * @remarks Time O(1), Space O(1)
-     * @returns True if the value is a TreeCounterNode.
-     */
-    isNode(keyNodeOrEntry: K | TreeCounterNode<K, V> | [K | null | undefined, V | undefined] | null | undefined): keyNodeOrEntry is TreeCounterNode<K, V>;
-    /**
-     * Insert or increment a node and update aggregate count.
-     * @remarks Time O(log N), Space O(1)
-     * @param keyNodeOrEntry - Key, node, or [key, value] entry to insert.
-     * @param [value] - Value when a bare key is provided (ignored in map mode).
-     * @param [count] - How much to increase the node's count (default 1).
-     * @returns True if inserted/updated; false if ignored.
-     */
-    add(keyNodeOrEntry: K | TreeCounterNode<K, V> | [K | null | undefined, V | undefined] | null | undefined, value?: V, count?: number): boolean;
-    /**
-     * Delete a node (or decrement its count) and rebalance if needed.
-     * @remarks Time O(log N), Space O(1)
-     * @param keyNodeOrEntry - Key, node, or [key, value] entry identifying the node.
-     * @param [ignoreCount] - If true, remove the node regardless of its count.
-     * @returns Array of deletion results including deleted node and a rebalance hint when present.
-     */
-    delete(keyNodeOrEntry: K | TreeCounterNode<K, V> | [K | null | undefined, V | undefined] | null | undefined, ignoreCount?: boolean): BinaryTreeDeleteResult<TreeCounterNode<K, V>>[];
-    /**
-     * Remove all nodes and reset aggregate counters.
-     * @remarks Time O(N), Space O(1)
-     * @returns void
-     */
-    clear(): void;
-    /**
-     * Rebuild the tree into a perfectly balanced form using in-order nodes.
-     * @remarks Time O(N), Space O(N)
-     * @param [iterationType] - Traversal style to use when constructing the balanced tree.
-     * @returns True if rebalancing succeeded (tree not empty).
-     */
-    perfectlyBalance(iterationType?: IterationType): boolean;
-    /**
-     * Create a new TreeCounter by mapping each [key, value] entry.
-     * @remarks Time O(N log N), Space O(N)
-     * @template MK
-     * @template MV
-     * @template MR
-     * @param callback - Function mapping (key, value, index, tree) → [newKey, newValue].
-     * @param [options] - Options for the output tree.
-     * @param [thisArg] - Value for `this` inside the callback.
-     * @returns A new TreeCounter with mapped entries.
-     */
-    map<MK = K, MV = V, MR extends object = object>(callback: EntryCallback<K, V | undefined, [MK, MV]>, options?: Partial<BinaryTreeOptions<MK, MV, MR>>, thisArg?: unknown): TreeCounter<MK, MV, MR>;
-    /**
-     * Deep copy this tree, preserving map mode and aggregate counts.
-     * @remarks Time O(N), Space O(N)
-     * @returns A deep copy of this tree.
-     */
-    clone(): this;
-    /**
-     * (Protected) Create an empty instance of the same concrete class.
-     * @remarks Time O(1), Space O(1)
-     * @template TK
-     * @template TV
-     * @template TR
-     * @param [options] - Optional constructor options for the like-kind instance.
-     * @returns An empty like-kind instance.
-     */
-    protected _createInstance<TK = K, TV = V, TR extends object = R>(options?: Partial<BSTOptions<TK, TV, TR>>): this;
-    /**
-     * (Protected) Create a like-kind instance and seed it from an iterable.
-     * @remarks Time O(N log N), Space O(N)
-     * @template TK
-     * @template TV
-     * @template TR
-     * @param iter - Iterable used to seed the new tree.
-     * @param [options] - Options merged with the current snapshot.
-     * @returns A like-kind TreeCounter built from the iterable.
-     */
-    protected _createLike<TK = K, TV = V, TR extends object = R>(iter?: Iterable<TK | BSTNode<TK, TV> | [TK | null | undefined, TV | undefined] | null | undefined | TR>, options?: Partial<BSTOptions<TK, TV, TR>>): TreeCounter<TK, TV, TR>;
-    /**
-     * (Protected) Normalize input into a node plus its effective value and count.
-     * @remarks Time O(1), Space O(1)
-     * @param keyNodeOrEntry - Key, node, or [key, value] entry.
-     * @param [value] - Value used when a bare key is provided.
-     * @param [count] - Count increment to apply (default 1).
-     * @returns Tuple [node, value] where node may be undefined.
-     */
-    protected _keyValueNodeOrEntryToNodeAndValue(keyNodeOrEntry: K | TreeCounterNode<K, V> | [K | null | undefined, V | undefined] | null | undefined, value?: V, count?: number): [TreeCounterNode<K, V> | undefined, V | undefined];
-    /**
-     * (Protected) Swap keys/values/counters between the source and destination nodes.
-     * @remarks Time O(1), Space O(1)
-     * @param srcNode - Source node (or key) whose properties will be moved.
-     * @param destNode - Destination node (or key) to receive properties.
-     * @returns Destination node after swap, or undefined.
-     */
-    protected _swapProperties(srcNode: BSTNOptKeyOrNode<K, TreeCounterNode<K, V>>, destNode: BSTNOptKeyOrNode<K, TreeCounterNode<K, V>>): TreeCounterNode<K, V> | undefined;
-    /**
-     * (Protected) Replace one node by another and adjust counters accordingly.
-     * @remarks Time O(1), Space O(1)
-     * @param oldNode - Node being replaced.
-     * @param newNode - Replacement node.
-     * @returns The new node after replacement.
-     */
-    protected _replaceNode(oldNode: TreeCounterNode<K, V>, newNode: TreeCounterNode<K, V>): TreeCounterNode<K, V>;
-}