data-structure-typed 1.50.6 → 1.50.8

package/dist/cjs/types/common.d.ts

@@ -1,31 +1,13 @@
-export declare enum BSTVariant {
-    STANDARD = "STANDARD",
-    INVERSE = "INVERSE"
-}
-export declare enum CP {
-    lt = "lt",
-    eq = "eq",
-    gt = "gt"
-}
+export type BSTVariant = 'STANDARD' | 'INVERSE';
+export type CP = 'LT' | 'EQ' | 'GT';
 /**
  * Enum representing different loop types.
  *
  * - `iterative`: Indicates the iterative loop type (with loops that use iterations).
  * - `recursive`: Indicates the recursive loop type (with loops that call themselves).
  */
-export declare enum IterationType {
-    ITERATIVE = "ITERATIVE",
-    RECURSIVE = "RECURSIVE"
-}
-export declare enum FamilyPosition {
-    ROOT = "ROOT",
-    LEFT = "LEFT",
-    RIGHT = "RIGHT",
-    ROOT_LEFT = "ROOT_LEFT",
-    ROOT_RIGHT = "ROOT_RIGHT",
-    ISOLATED = "ISOLATED",
-    MAL_NODE = "MAL_NODE"
-}
+export type IterationType = 'ITERATIVE' | 'RECURSIVE';
+export type FamilyPosition = 'ROOT' | 'LEFT' | 'RIGHT' | 'ROOT_LEFT' | 'ROOT_RIGHT' | 'ISOLATED' | 'MAL_NODE';
 export type Comparator<K> = (a: K, b: K) => number;
 export type DFSOrderPattern = 'pre' | 'in' | 'post';
 export type NodeDisplayLayout = [string[], number, number, number];
@@ -52,3 +34,4 @@ export type BinaryTreeDeleteResult<N> = {
     deleted: N | null | undefined;
     needBalanced: N | null | undefined;
 };
+export type CRUD = 'CREATED' | 'READ' | 'UPDATED' | 'DELETED';

package/dist/cjs/types/common.js

@@ -1,36 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FamilyPosition = exports.IterationType = exports.CP = exports.BSTVariant = void 0;
-var BSTVariant;
-(function (BSTVariant) {
-    BSTVariant["STANDARD"] = "STANDARD";
-    BSTVariant["INVERSE"] = "INVERSE";
-})(BSTVariant || (exports.BSTVariant = BSTVariant = {}));
-var CP;
-(function (CP) {
-    CP["lt"] = "lt";
-    CP["eq"] = "eq";
-    CP["gt"] = "gt";
-})(CP || (exports.CP = CP = {}));
-/**
- * Enum representing different loop types.
- *
- * - `iterative`: Indicates the iterative loop type (with loops that use iterations).
- * - `recursive`: Indicates the recursive loop type (with loops that call themselves).
- */
-var IterationType;
-(function (IterationType) {
-    IterationType["ITERATIVE"] = "ITERATIVE";
-    IterationType["RECURSIVE"] = "RECURSIVE";
-})(IterationType || (exports.IterationType = IterationType = {}));
-var FamilyPosition;
-(function (FamilyPosition) {
-    FamilyPosition["ROOT"] = "ROOT";
-    FamilyPosition["LEFT"] = "LEFT";
-    FamilyPosition["RIGHT"] = "RIGHT";
-    FamilyPosition["ROOT_LEFT"] = "ROOT_LEFT";
-    FamilyPosition["ROOT_RIGHT"] = "ROOT_RIGHT";
-    FamilyPosition["ISOLATED"] = "ISOLATED";
-    FamilyPosition["MAL_NODE"] = "MAL_NODE";
-})(FamilyPosition || (exports.FamilyPosition = FamilyPosition = {}));
 //# sourceMappingURL=common.js.map

package/dist/cjs/types/common.js.map

@@ -1 +1 @@
-{"version":3,"file":"common.js","sourceRoot":"","sources":["../../../src/types/common.ts"],"names":[],"mappings":";;;AAAA,IAAY,UAGX;AAHD,WAAY,UAAU;IACpB,mCAAqB,CAAA;IACrB,iCAAmB,CAAA;AACrB,CAAC,EAHW,UAAU,0BAAV,UAAU,QAGrB;AAED,IAAY,EAIX;AAJD,WAAY,EAAE;IACZ,eAAS,CAAA;IACT,eAAS,CAAA;IACT,eAAS,CAAA;AACX,CAAC,EAJW,EAAE,kBAAF,EAAE,QAIb;AAED;;;;;GAKG;AACH,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,wCAAuB,CAAA;IACvB,wCAAuB,CAAA;AACzB,CAAC,EAHW,aAAa,6BAAb,aAAa,QAGxB;AAED,IAAY,cAQX;AARD,WAAY,cAAc;IACxB,+BAAa,CAAA;IACb,+BAAa,CAAA;IACb,iCAAe,CAAA;IACf,yCAAuB,CAAA;IACvB,2CAAyB,CAAA;IACzB,uCAAqB,CAAA;IACrB,uCAAqB,CAAA;AACvB,CAAC,EARW,cAAc,8BAAd,cAAc,QAQzB"}
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../../../src/types/common.ts"],"names":[],"mappings":""}

package/dist/mjs/data-structures/binary-tree/avl-tree-multi-map.d.ts

@@ -6,7 +6,6 @@
  * @license MIT License
  */
 import type { AVLTreeMultiMapNested, AVLTreeMultiMapNodeNested, AVLTreeMultiMapOptions, BinaryTreeDeleteResult, BSTNKeyOrNode, BTNCallback, KeyOrNodeOrEntry } from '../../types';
-import { IterationType } from '../../types';
 import { IBinaryTree } from '../../interfaces';
 import { AVLTree, AVLTreeNode } from './avl-tree';
 export declare class AVLTreeMultiMapNode<K = any, V = any, NODE extends AVLTreeMultiMapNode<K, V, NODE> = AVLTreeMultiMapNodeNested<K, V>> extends AVLTreeNode<K, V, NODE> {
@@ -46,6 +45,7 @@ export declare class AVLTreeMultiMap<K = any, V = any, NODE extends AVLTreeMulti
      * @returns the sum of the count property of all nodes in the tree.
      */
     get count(): number;
+    getMutableCount(): number;
     /**
      * The function creates a new BSTNode with the given key, value, and count.
      * @param {K} key - The key parameter is the unique identifier for the binary tree node. It is used to
@@ -156,7 +156,7 @@ export declare class AVLTreeMultiMap<K = any, V = any, NODE extends AVLTreeMulti
      * values:
      * @returns a boolean value.
      */
-    perfectlyBalance(iterationType?: IterationType): boolean;
+    perfectlyBalance(iterationType?: import("../../types").IterationType): boolean;
     /**
      * Time complexity: O(n)
      * Space complexity: O(n)

package/dist/mjs/data-structures/binary-tree/avl-tree-multi-map.js

@@ -1,4 +1,3 @@
-import { FamilyPosition, IterationType } from '../../types';
 import { AVLTree, AVLTreeNode } from './avl-tree';
 export class AVLTreeMultiMapNode extends AVLTreeNode {
     /**
@@ -49,6 +48,9 @@ export class AVLTreeMultiMap extends AVLTree {
      * @returns the sum of the count property of all nodes in the tree.
      */
     get count() {
+        return this._count;
+    }
+    getMutableCount() {
         let sum = 0;
         this.dfs(node => (sum += node.count));
         return sum;
@@ -201,10 +203,10 @@ export class AVLTreeMultiMap extends AVLTree {
                 }
                 else {
                     const { familyPosition: fp } = curr;
-                    if (fp === FamilyPosition.LEFT || fp === FamilyPosition.ROOT_LEFT) {
+                    if (fp === 'LEFT' || fp === 'ROOT_LEFT') {
                         parent.left = curr.right;
                     }
-                    else if (fp === FamilyPosition.RIGHT || fp === FamilyPosition.ROOT_RIGHT) {
+                    else if (fp === 'RIGHT' || fp === 'ROOT_RIGHT') {
                         parent.right = curr.right;
                     }
                     needBalanced = parent;
@@ -271,7 +273,7 @@ export class AVLTreeMultiMap extends AVLTree {
         if (sorted.length < 1)
             return false;
         this.clear();
-        if (iterationType === IterationType.RECURSIVE) {
+        if (iterationType === 'RECURSIVE') {
             const buildBalanceBST = (l, r) => {
                 if (l > r)
                     return;

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

@@ -135,11 +135,11 @@ export declare class BinaryTree<K = any, V = any, NODE extends BinaryTreeNode<K,
      * `null`, or `undefined`. It represents a key used to identify a node in a binary tree.
      * @param iterationType - The `iterationType` parameter is an optional parameter that specifies the
      * type of iteration to be used when searching for a node by key. It has a default value of
-     * `IterationType.ITERATIVE`.
+     * `'ITERATIVE'`.
      * @returns either the node corresponding to the given key if it is a valid node key, or the key
      * itself if it is not a valid node key.
      */
-    ensureNode(keyOrNodeOrEntry: KeyOrNodeOrEntry<K, V, NODE>, iterationType?: IterationType): NODE | null | undefined;
+    ensureNode(keyOrNodeOrEntry: KeyOrNodeOrEntry<K, V, NODE>, iterationType?: string): NODE | null | undefined;
     /**
      * The function "isNode" checks if an keyOrNodeOrEntry is an instance of the BinaryTreeNode class.
      * @param keyOrNodeOrEntry - The `keyOrNodeOrEntry` parameter is a variable of type `KeyOrNodeOrEntry<K, V,NODE>`.
@@ -248,7 +248,7 @@ export declare class BinaryTree<K = any, V = any, NODE extends BinaryTreeNode<K,
      * @returns The function `getNodeByKey` returns a node (`NODE`) if a node with the specified key is
      * found in the binary tree. If no node is found, it returns `undefined`.
      */
-    getNodeByKey(key: K, iterationType?: IterationType): NODE | undefined;
+    getNodeByKey(key: K, iterationType?: string): NODE | undefined;
     get<C extends BTNCallback<NODE, K>>(identifier: K, callback?: C, beginRoot?: KeyOrNodeOrEntry<K, V, NODE>, iterationType?: IterationType): V | undefined;
     get<C extends BTNCallback<NODE, NODE>>(identifier: NODE | null | undefined, callback?: C, beginRoot?: KeyOrNodeOrEntry<K, V, NODE>, iterationType?: IterationType): V | undefined;
     get<C extends BTNCallback<NODE>>(identifier: ReturnType<C>, callback: C, beginRoot?: KeyOrNodeOrEntry<K, V, NODE>, iterationType?: IterationType): V | undefined;

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

@@ -5,7 +5,6 @@
  * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
  * @license MIT License
  */
-import { FamilyPosition, IterationType } from '../../types';
 import { trampoline } from '../../utils';
 import { Queue } from '../queue';
 import { IterableEntryBase } from '../base';
@@ -77,15 +76,15 @@ export class BinaryTreeNode {
     get familyPosition() {
         const that = this;
         if (!this.parent) {
-            return this.left || this.right ? FamilyPosition.ROOT : FamilyPosition.ISOLATED;
+            return this.left || this.right ? 'ROOT' : 'ISOLATED';
         }
         if (this.parent.left === that) {
-            return this.left || this.right ? FamilyPosition.ROOT_LEFT : FamilyPosition.LEFT;
+            return this.left || this.right ? 'ROOT_LEFT' : 'LEFT';
         }
         else if (this.parent.right === that) {
-            return this.left || this.right ? FamilyPosition.ROOT_RIGHT : FamilyPosition.RIGHT;
+            return this.left || this.right ? 'ROOT_RIGHT' : 'RIGHT';
         }
-        return FamilyPosition.MAL_NODE;
+        return 'MAL_NODE';
     }
 }
 /**
@@ -96,7 +95,7 @@ export class BinaryTreeNode {
  * 5. Leaf Nodes: Nodes without children are leaves.
  */
 export class BinaryTree extends IterableEntryBase {
-    iterationType = IterationType.ITERATIVE;
+    iterationType = 'ITERATIVE';
     /**
      * The constructor function initializes a binary tree object with optional keysOrNodesOrEntries and options.
      * @param [keysOrNodesOrEntries] - An optional iterable of KeyOrNodeOrEntry objects. These objects represent the
@@ -119,7 +118,7 @@ export class BinaryTree extends IterableEntryBase {
         if (keysOrNodesOrEntries)
             this.addMany(keysOrNodesOrEntries);
     }
-    _extractor = (key) => Number(key);
+    _extractor = (key) => (typeof key === 'number' ? key : Number(key));
     /**
      * The function returns the value of the `_extractor` property.
      * @returns The `_extractor` property is being returned.
@@ -215,11 +214,11 @@ export class BinaryTree extends IterableEntryBase {
      * `null`, or `undefined`. It represents a key used to identify a node in a binary tree.
      * @param iterationType - The `iterationType` parameter is an optional parameter that specifies the
      * type of iteration to be used when searching for a node by key. It has a default value of
-     * `IterationType.ITERATIVE`.
+     * `'ITERATIVE'`.
      * @returns either the node corresponding to the given key if it is a valid node key, or the key
      * itself if it is not a valid node key.
      */
-    ensureNode(keyOrNodeOrEntry, iterationType = IterationType.ITERATIVE) {
+    ensureNode(keyOrNodeOrEntry, iterationType = 'ITERATIVE') {
         let res;
         if (this.isRealNode(keyOrNodeOrEntry)) {
             res = keyOrNodeOrEntry;
@@ -446,10 +445,10 @@ export class BinaryTree extends IterableEntryBase {
         }
         else if (parent) {
             const { familyPosition: fp } = curr;
-            if (fp === FamilyPosition.LEFT || fp === FamilyPosition.ROOT_LEFT) {
+            if (fp === 'LEFT' || fp === 'ROOT_LEFT') {
                 parent.left = curr.right;
             }
-            else if (fp === FamilyPosition.RIGHT || fp === FamilyPosition.ROOT_RIGHT) {
+            else if (fp === 'RIGHT' || fp === 'ROOT_RIGHT') {
                 parent.right = curr.right;
             }
             needBalanced = parent;
@@ -498,7 +497,7 @@ export class BinaryTree extends IterableEntryBase {
         if (!beginRoot)
             return [];
         const ans = [];
-        if (iterationType === IterationType.RECURSIVE) {
+        if (iterationType === 'RECURSIVE') {
             const _traverse = (cur) => {
                 if (callback(cur) === identifier) {
                     ans.push(cur);
@@ -577,10 +576,10 @@ export class BinaryTree extends IterableEntryBase {
      * @returns The function `getNodeByKey` returns a node (`NODE`) if a node with the specified key is
      * found in the binary tree. If no node is found, it returns `undefined`.
      */
-    getNodeByKey(key, iterationType = IterationType.ITERATIVE) {
+    getNodeByKey(key, iterationType = 'ITERATIVE') {
         if (!this.root)
             return undefined;
-        if (iterationType === IterationType.RECURSIVE) {
+        if (iterationType === 'RECURSIVE') {
             const _dfs = (cur) => {
                 if (cur.key === key)
                     return cur;
@@ -734,7 +733,7 @@ export class BinaryTree extends IterableEntryBase {
         beginRoot = this.ensureNode(beginRoot);
         if (!beginRoot)
             return true;
-        if (iterationType === IterationType.RECURSIVE) {
+        if (iterationType === 'RECURSIVE') {
             const dfs = (cur, min, max) => {
                 if (!this.isRealNode(cur))
                     return true;
@@ -821,9 +820,9 @@ export class BinaryTree extends IterableEntryBase {
      */
     getHeight(beginRoot = this.root, iterationType = this.iterationType) {
         beginRoot = this.ensureNode(beginRoot);
-        if (!beginRoot)
+        if (!this.isRealNode(beginRoot))
             return -1;
-        if (iterationType === IterationType.RECURSIVE) {
+        if (iterationType === 'RECURSIVE') {
             const _getMaxHeight = (cur) => {
                 if (!this.isRealNode(cur))
                     return -1;
@@ -868,11 +867,11 @@ export class BinaryTree extends IterableEntryBase {
         beginRoot = this.ensureNode(beginRoot);
         if (!beginRoot)
             return -1;
-        if (iterationType === IterationType.RECURSIVE) {
+        if (iterationType === 'RECURSIVE') {
             const _getMinHeight = (cur) => {
-                if (!cur)
+                if (!this.isRealNode(cur))
                     return 0;
-                if (!cur.left && !cur.right)
+                if (!this.isRealNode(cur.left) && !this.isRealNode(cur.right))
                     return 0;
                 const leftMinHeight = _getMinHeight(cur.left);
                 const rightMinHeight = _getMinHeight(cur.right);
@@ -885,17 +884,17 @@ export class BinaryTree extends IterableEntryBase {
             let node = beginRoot, last = null;
             const depths = new Map();
             while (stack.length > 0 || node) {
-                if (node) {
+                if (this.isRealNode(node)) {
                     stack.push(node);
                     node = node.left;
                 }
                 else {
                     node = stack[stack.length - 1];
-                    if (!node.right || last === node.right) {
+                    if (!this.isRealNode(node.right) || last === node.right) {
                         node = stack.pop();
-                        if (node) {
-                            const leftMinHeight = node.left ? depths.get(node.left) ?? -1 : -1;
-                            const rightMinHeight = node.right ? depths.get(node.right) ?? -1 : -1;
+                        if (this.isRealNode(node)) {
+                            const leftMinHeight = this.isRealNode(node.left) ? depths.get(node.left) ?? -1 : -1;
+                            const rightMinHeight = this.isRealNode(node.right) ? depths.get(node.right) ?? -1 : -1;
                             depths.set(node, 1 + Math.min(leftMinHeight, rightMinHeight));
                             last = node;
                             node = null;
@@ -961,10 +960,12 @@ export class BinaryTree extends IterableEntryBase {
      * is no leftmost node, it returns `null` or `undefined` depending on the input.
      */
     getLeftMost(beginRoot = this.root, iterationType = this.iterationType) {
+        if (this.isNIL(beginRoot))
+            return beginRoot;
         beginRoot = this.ensureNode(beginRoot);
-        if (!beginRoot)
+        if (!this.isRealNode(beginRoot))
             return beginRoot;
-        if (iterationType === IterationType.RECURSIVE) {
+        if (iterationType === 'RECURSIVE') {
             const _traverse = (cur) => {
                 if (!this.isRealNode(cur.left))
                     return cur;
@@ -1002,11 +1003,13 @@ export class BinaryTree extends IterableEntryBase {
      * is no rightmost node, it returns `null` or `undefined`, depending on the input.
      */
     getRightMost(beginRoot = this.root, iterationType = this.iterationType) {
+        if (this.isNIL(beginRoot))
+            return beginRoot;
         // TODO support get right most by passing key in
         beginRoot = this.ensureNode(beginRoot);
         if (!beginRoot)
             return beginRoot;
-        if (iterationType === IterationType.RECURSIVE) {
+        if (iterationType === 'RECURSIVE') {
             const _traverse = (cur) => {
                 if (!this.isRealNode(cur.right))
                     return cur;
@@ -1106,12 +1109,12 @@ export class BinaryTree extends IterableEntryBase {
      * `false`, null or undefined
      * @returns an array of values that are the return values of the callback function.
      */
-    dfs(callback = this._defaultOneParamCallback, pattern = 'in', beginRoot = this.root, iterationType = IterationType.ITERATIVE, includeNull = false) {
+    dfs(callback = this._defaultOneParamCallback, pattern = 'in', beginRoot = this.root, iterationType = 'ITERATIVE', includeNull = false) {
         beginRoot = this.ensureNode(beginRoot);
         if (!beginRoot)
             return [];
         const ans = [];
-        if (iterationType === IterationType.RECURSIVE) {
+        if (iterationType === 'RECURSIVE') {
             const _traverse = (node) => {
                 switch (pattern) {
                     case 'in':
@@ -1242,7 +1245,7 @@ export class BinaryTree extends IterableEntryBase {
         if (!beginRoot)
             return [];
         const ans = [];
-        if (iterationType === IterationType.RECURSIVE) {
+        if (iterationType === 'RECURSIVE') {
             const queue = new Queue([beginRoot]);
             const traverse = (level) => {
                 if (queue.size === 0)
@@ -1319,7 +1322,7 @@ export class BinaryTree extends IterableEntryBase {
         const levelsNodes = [];
         if (!beginRoot)
             return levelsNodes;
-        if (iterationType === IterationType.RECURSIVE) {
+        if (iterationType === 'RECURSIVE') {
             const _recursive = (node, level) => {
                 if (!levelsNodes[level])
                     levelsNodes[level] = [];
@@ -1606,7 +1609,7 @@ export class BinaryTree extends IterableEntryBase {
     *_getIterator(node = this.root) {
         if (!node)
             return;
-        if (this.iterationType === IterationType.ITERATIVE) {
+        if (this.iterationType === 'ITERATIVE') {
             const stack = [];
             let current = node;
             while (current || stack.length > 0) {

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

@@ -109,10 +109,10 @@ export declare class BST<K = any, V = any, NODE extends BSTNode<K, V, NODE> = BS
      * @param {K | NODE | undefined} keyOrNodeOrEntry - The `key` parameter can be of type `K`, `NODE`, or
      * `undefined`.
      * @param iterationType - The `iterationType` parameter is an optional parameter that specifies the
-     * type of iteration to be performed. It has a default value of `IterationType.ITERATIVE`.
+     * type of iteration to be performed. It has a default value of `'ITERATIVE'`.
      * @returns either a node object (NODE) or undefined.
      */
-    ensureNode(keyOrNodeOrEntry: KeyOrNodeOrEntry<K, V, NODE>, iterationType?: IterationType): NODE | undefined;
+    ensureNode(keyOrNodeOrEntry: KeyOrNodeOrEntry<K, V, NODE>, iterationType?: string): NODE | undefined;
     /**
      * The function checks if an keyOrNodeOrEntry is an instance of BSTNode.
      * @param keyOrNodeOrEntry - The `keyOrNodeOrEntry` parameter is a variable of type `KeyOrNodeOrEntry<K, V, NODE>`.
@@ -179,7 +179,7 @@ export declare class BST<K = any, V = any, NODE extends BSTNode<K, V, NODE> = BS
      * @returns The function `getNodeByKey` returns a node (`NODE`) if a node with the specified key is
      * found in the binary tree. If no node is found, it returns `undefined`.
      */
-    getNodeByKey(key: K, iterationType?: IterationType): NODE | undefined;
+    getNodeByKey(key: K, iterationType?: string): NODE | undefined;
     /**
      * Time Complexity: O(log n)
      * Space Complexity: O(k + log n)
@@ -372,8 +372,10 @@ export declare class BST<K = any, V = any, NODE extends BSTNode<K, V, NODE> = BS
      * is greater than, less than, or equal to the second value.
      * @param {K} a - The parameter "a" is of type K.
      * @param {K} b - The parameter "b" in the above code represents a K.
-     * @returns a value of type CP (ComparisonResult). The possible return values are CP.gt (greater
-     * than), CP.lt (less than), or CP.eq (equal).
+     * @returns a value of type CP (ComparisonResult). The possible return values are 'GT' (greater
+     * than), 'LT' (less than), or 'EQ' (equal).
      */
     protected _compare(a: K, b: K): CP;
+    protected _lt(a: K, b: K): boolean;
+    protected _gt(a: K, b: K): boolean;
 }