data-structure-typed 1.51.1 → 1.51.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "data-structure-typed",
-  "version": "1.51.1",
+  "version": "1.51.3",
   "description": "Javascript Data Structure. Heap, Binary Tree, Red Black Tree, Linked List, Deque, Trie, HashMap, Directed Graph, Undirected Graph, Binary Search Tree(BST), AVL Tree, Priority Queue, Graph, Queue, Tree Multiset, Singly Linked List, Doubly Linked List, Max Heap, Max Priority Queue, Min Heap, Min Priority Queue, Stack. Benchmark compared with C++ STL. API aligned with ES6 and Java.util. Usability is comparable to Python",
   "main": "dist/cjs/index.js",
   "module": "dist/mjs/index.js",
@@ -66,11 +66,11 @@
     "@typescript-eslint/eslint-plugin": "^6.7.4",
     "@typescript-eslint/parser": "^6.7.4",
     "auto-changelog": "^2.4.0",
-    "avl-tree-typed": "^1.51.0",
+    "avl-tree-typed": "^1.51.2",
     "benchmark": "^2.1.4",
-    "binary-tree-typed": "^1.51.0",
-    "bst-typed": "^1.51.0",
-    "data-structure-typed": "^1.51.0",
+    "binary-tree-typed": "^1.51.2",
+    "bst-typed": "^1.51.2",
+    "data-structure-typed": "^1.51.2",
     "dependency-cruiser": "^14.1.0",
     "doctoc": "^2.2.1",
     "eslint": "^8.50.0",
@@ -79,7 +79,7 @@
     "eslint-import-resolver-typescript": "^3.6.1",
     "eslint-plugin-import": "^2.28.1",
     "fast-glob": "^3.3.1",
-    "heap-typed": "^1.51.0",
+    "heap-typed": "^1.51.2",
     "istanbul-badges-readme": "^1.8.5",
     "jest": "^29.7.0",
     "js-sdsl": "^4.4.2",
@@ -92,54 +92,17 @@
     "typescript": "^5.3.2"
   },
   "keywords": [
-    "data structure",
-    "data structures",
-    "datastructure",
-    "datastructures",
     "data",
     "structure",
     "structures",
-    "min",
-    "max",
-    "heap",
-    "priority",
-    "queue",
-    "min heap",
-    "min-heap",
-    "max heap",
-    "max-heap",
-    "priority queue",
-    "priority-queue",
-    "max priority queue",
-    "max-priority-queue",
-    "min priority queue",
-    "min-priority-queue",
-    "binary search tree",
-    "binary-search-tree",
-    "BST",
-    "binary tree",
-    "binary-tree",
-    "red black tree",
-    "red black tree",
-    "red-black-tree",
-    "rb tree",
-    "trie",
-    "prefix tree",
-    "prefix-tree",
-    "avl tree",
-    "avl-tree",
-    "tree set",
-    "tree-set",
-    "tree multiset",
-    "tree-multiset",
-    "tree map",
-    "tree-map",
-    "tree multimap",
-    "tree-multimap",
-    "binary indexed tree",
-    "binary-indexed-tree",
-    "segment tree",
-    "segment-tree",
+    "data structure",
+    "datastructure",
+    "data-structure",
+    "data structures",
+    "datastructures",
+    "data-structures",
+    "in data structures",
+    "in data structure",
     "binary",
     "depth",
     "breadth",
@@ -149,7 +112,7 @@
     "avl",
     "red",
     "black",
-    "red black",
+    "redblack",
     "RB",
     "segment",
     "prefix",
@@ -159,26 +122,18 @@
     "set",
     "multiset",
     "multimap",
+    "directed",
+    "undirected",
+    "graph",
+    "min",
+    "max",
+    "heap",
+    "priority",
+    "queue",
     "singly",
     "doubly",
     "linked",
     "list",
-    "linked list",
-    "linked-list",
-    "singly linked list",
-    "singly-linked-list",
-    "doubly linked list",
-    "doubly-linked-list",
-    "javascript data structure",
-    "javascript data structures",
-    "typescript data structures",
-    "js data structure",
-    "js data structures",
-    "data-structure",
-    "data-structures",
-    "directed",
-    "undirected",
-    "graph",
     "js",
     "ts",
     "javascript",
@@ -195,6 +150,7 @@
     "Python",
     "collections",
     "Python Collections",
+    "pythoncollections",
     "python-collections",
     "C#",
     "System.Collections.Generic",
@@ -202,6 +158,43 @@
     "java.util",
     "Java",
     "util",
+    "binary search tree",
+    "binarysearchtree",
+    "binary-search-tree",
+    "BST",
+    "binary tree",
+    "binarytree",
+    "binary-tree",
+    "red black tree",
+    "redblacktree",
+    "redblack tree",
+    "red-black-tree",
+    "redblack-tree",
+    "trie",
+    "prefix tree",
+    "prefixtree",
+    "prefix-tree",
+    "avl tree",
+    "avltree",
+    "avl-tree",
+    "tree set",
+    "treeset",
+    "tree-set",
+    "tree multiset",
+    "treemultiset",
+    "tree-multiset",
+    "tree map",
+    "treemap",
+    "tree-map",
+    "tree multimap",
+    "treemultimap",
+    "tree-multimap",
+    "binary indexed tree",
+    "binaryindexedtree",
+    "binary-indexed-tree",
+    "segment tree",
+    "segmenttree",
+    "segment-tree",
     "sort",
     "sorted",
     "order",
@@ -210,31 +203,61 @@
     "morris",
     "Morris",
     "bellman ford",
+    "bellmanford",
     "bellman-ford",
     "dijkstra",
     "Dijkstra",
     "floyd warshall",
+    "floydwarshall",
     "floyd-warshall",
     "tarjan",
     "tarjan's",
     "dfs",
     "depth first Search",
+    "depthfirstSearch",
     "depth-first-Search",
     "bfs",
     "breadth first search",
+    "breadthfirstsearch",
     "dfs iterative",
     "recursive",
     "iterative",
     "directed graph",
+    "directedgraph",
     "directed-graph",
     "undirected graph",
+    "undirectedgraph",
     "undirected-graph",
+    "min heap",
+    "minheap",
+    "min-heap",
+    "max heap",
+    "maxheap",
+    "max-heap",
+    "priority queue",
+    "priorityqueue",
+    "priority-queue",
+    "max priority queue",
+    "maxpriorityqueue",
+    "max-priority-queue",
+    "min priority queue",
+    "minpriorityqueue",
+    "min-priority-queue",
     "hash",
     "map",
-    "hashmap",
     "hash map",
+    "hashmap",
     "hash-map",
     "deque",
+    "linked list",
+    "linkedlist",
+    "linked-list",
+    "singly linked list",
+    "singlylinkedlist",
+    "singly-linked-list",
+    "doubly linked list",
+    "doublylinkedlist",
+    "doubly-linked-list",
     "stack",
     "CommonJS",
     "ES6",

package/src/data-structures/binary-tree/binary-tree.ts

@@ -191,6 +191,16 @@ export class BinaryTree<
     return this._size;
   }
 
+  protected _NIL: NODE = new BinaryTreeNode<K, V>(NaN as K) as unknown as NODE;
+
+  /**
+   * The function returns the value of the _NIL property.
+   * @returns The method is returning the value of the `_NIL` property.
+   */
+  get NIL(): NODE {
+    return this._NIL;
+  }
+
   /**
    * Creates a new instance of BinaryTreeNode with the given key and value.
    * @param {K} key - The key for the new node.
@@ -281,6 +291,15 @@ export class BinaryTree<
     }
   }
 
+  /**
+   * The function checks if a given node is a real node or null.
+   * @param {any} node - The parameter `node` is of type `any`, which means it can be any data type.
+   * @returns a boolean value.
+   */
+  isNodeOrNull(node: KeyOrNodeOrEntry<K, V, NODE>): node is NODE | null {
+    return this.isRealNode(node) || node === null;
+  }
+
   /**
    * 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>`.
@@ -290,16 +309,6 @@ export class BinaryTree<
     return keyOrNodeOrEntry instanceof BinaryTreeNode;
   }
 
-  /**
-   * The function checks if a given value is an entry in a binary tree node.
-   * @param keyOrNodeOrEntry - KeyOrNodeOrEntry<K, V,NODE> - A generic type representing a node in a binary tree. It has
-   * two type parameters V and NODE, representing the value and node type respectively.
-   * @returns a boolean value.
-   */
-  isEntry(keyOrNodeOrEntry: KeyOrNodeOrEntry<K, V, NODE>): keyOrNodeOrEntry is BTNEntry<K, V> {
-    return Array.isArray(keyOrNodeOrEntry) && keyOrNodeOrEntry.length === 2;
-  }
-
   /**
    * The function checks if a given node is a real node by verifying if it is an instance of
    * BinaryTreeNode and its key is not NaN.
@@ -307,7 +316,8 @@ export class BinaryTree<
    * @returns a boolean value.
    */
   isRealNode(node: KeyOrNodeOrEntry<K, V, NODE>): node is NODE {
-    return node instanceof BinaryTreeNode && String(node.key) !== 'NaN';
+    if (!this.isNode(node)) return false;
+    return node !== this.NIL;
   }
 
   /**
@@ -316,16 +326,17 @@ export class BinaryTree<
    * @returns a boolean value.
    */
   isNIL(node: KeyOrNodeOrEntry<K, V, NODE>) {
-    return node instanceof BinaryTreeNode && String(node.key) === 'NaN';
+    return node === this.NIL;
   }
 
   /**
-   * The function checks if a given node is a real node or null.
-   * @param {any} node - The parameter `node` is of type `any`, which means it can be any data type.
+   * The function checks if a given value is an entry in a binary tree node.
+   * @param keyOrNodeOrEntry - KeyOrNodeOrEntry<K, V,NODE> - A generic type representing a node in a binary tree. It has
+   * two type parameters V and NODE, representing the value and node type respectively.
    * @returns a boolean value.
    */
-  isNodeOrNull(node: KeyOrNodeOrEntry<K, V, NODE>): node is NODE | null {
-    return this.isRealNode(node) || node === null;
+  isEntry(keyOrNodeOrEntry: KeyOrNodeOrEntry<K, V, NODE>): keyOrNodeOrEntry is BTNEntry<K, V> {
+    return Array.isArray(keyOrNodeOrEntry) && keyOrNodeOrEntry.length === 2;
   }
 
   /**
@@ -612,9 +623,9 @@ export class BinaryTree<
           ans.push(cur);
           if (onlyOne) return;
         }
-        if (!cur.left && !cur.right) return;
-        cur.left && dfs(cur.left);
-        cur.right && dfs(cur.right);
+        if (!this.isRealNode(cur.left) && !this.isRealNode(cur.right)) return;
+        this.isRealNode(cur.left) && dfs(cur.left);
+        this.isRealNode(cur.right) && dfs(cur.right);
       };
 
       dfs(beginRoot);
@@ -622,13 +633,13 @@ export class BinaryTree<
       const stack = [beginRoot];
       while (stack.length > 0) {
         const cur = stack.pop();
-        if (cur) {
+        if (this.isRealNode(cur)) {
           if (callback(cur) === identifier) {
             ans.push(cur);
             if (onlyOne) return ans;
           }
-          cur.left && stack.push(cur.left);
-          cur.right && stack.push(cur.right);
+          this.isRealNode(cur.left) && stack.push(cur.left);
+          this.isRealNode(cur.right) && stack.push(cur.right);
         }
       }
     }
@@ -689,9 +700,6 @@ export class BinaryTree<
     beginRoot: KeyOrNodeOrEntry<K, V, NODE> = this.root,
     iterationType: IterationType = this.iterationType
   ): NODE | null | undefined {
-    if ((!callback || callback === this._DEFAULT_CALLBACK) && (identifier as any) instanceof BinaryTreeNode)
-      callback = (node => node) as C;
-
     return this.getNodes(identifier, callback, true, beginRoot, iterationType)[0] ?? null;
   }
 
@@ -793,9 +801,6 @@ export class BinaryTree<
     beginRoot: KeyOrNodeOrEntry<K, V, NODE> = this.root,
     iterationType: IterationType = this.iterationType
   ): V | undefined {
-    if ((!callback || callback === this._DEFAULT_CALLBACK) && (identifier as any) instanceof BinaryTreeNode)
-      callback = (node => node) as C;
-
     return this.getNode(identifier, callback, beginRoot, iterationType)?.value ?? undefined;
   }
 

package/src/data-structures/binary-tree/bst.ts

@@ -13,7 +13,7 @@ import type {
   BTNodePureExemplar,
   KeyOrNodeOrEntry
 } from '../../types';
-import { BSTVariant, CP, DFSOrderPattern, IterationType } from '../../types';
+import { BSTNKeyOrNode, BSTVariant, CP, DFSOrderPattern, IterationType } from '../../types';
 import { BinaryTree, BinaryTreeNode } from './binary-tree';
 import { IBinaryTree } from '../../interfaces';
 import { Queue } from '../queue';
@@ -543,6 +543,41 @@ export class BST<
     return ans;
   }
 
+  /**
+   * Time Complexity: O(log n)
+   * Space Complexity: O(1)
+   */
+
+  /**
+   * Time Complexity: O(log n)
+   * Space Complexity: O(1)
+   *
+   * The `getNode` function retrieves a node from a Red-Black Tree based on the provided identifier and
+   * callback function.
+   * @param {ReturnType<C> | undefined} identifier - The `identifier` parameter is the value or key
+   * that you want to search for in the binary search tree. It can be of any type that is compatible
+   * with the type of nodes in the tree.
+   * @param {C} callback - The `callback` parameter is a function that will be called for each node in
+   * the tree. It is used to determine whether a node matches the given identifier. The `callback`
+   * function should take a node as its parameter and return a value that can be compared to the
+   * `identifier` parameter.
+   * @param beginRoot - The `beginRoot` parameter is the starting point for the search in the binary
+   * search tree. It can be either a key or a node. If it is a key, it will be converted to a node
+   * using the `ensureNode` method. If it is not provided, the `root`
+   * @param iterationType - The `iterationType` parameter is used to specify the type of iteration to
+   * be performed when searching for nodes in the binary search tree. It is an optional parameter and
+   * its default value is taken from the `iterationType` property of the class.
+   * @returns The method is returning a value of type `NODE | null | undefined`.
+   */
+  override getNode<C extends BTNCallback<NODE>>(
+    identifier: ReturnType<C> | undefined,
+    callback: C = this._DEFAULT_CALLBACK as C,
+    beginRoot: BSTNKeyOrNode<K, NODE> = this.root,
+    iterationType: IterationType = this.iterationType
+  ): NODE | undefined {
+    return this.getNodes(identifier, callback, true, beginRoot, iterationType)[0] ?? undefined;
+  }
+
   /**
    * Time complexity: O(n)
    * Space complexity: O(n)

package/src/data-structures/binary-tree/rb-tree.ts

@@ -1,8 +1,6 @@
 import type {
   BinaryTreeDeleteResult,
-  BSTNKeyOrNode,
   BTNCallback,
-  IterationType,
   KeyOrNodeOrEntry,
   RBTreeOptions,
   RedBlackTreeNested,
@@ -73,23 +71,13 @@ export class RedBlackTree<
   constructor(keysOrNodesOrEntries: Iterable<KeyOrNodeOrEntry<K, V, NODE>> = [], options?: RBTreeOptions<K>) {
     super([], options);
 
-    this._root = this.SENTINEL;
+    this._root = this.NIL;
 
     if (keysOrNodesOrEntries) {
       this.addMany(keysOrNodesOrEntries);
     }
   }
 
-  protected _SENTINEL: NODE = new RedBlackTreeNode<K, V>(NaN as K) as unknown as NODE;
-
-  /**
-   * The function returns the value of the _SENTINEL property.
-   * @returns The method is returning the value of the `_SENTINEL` property.
-   */
-  get SENTINEL(): NODE {
-    return this._SENTINEL;
-  }
-
   protected override _root: NODE | undefined;
 
   /**
@@ -184,60 +172,6 @@ export class RedBlackTree<
     return keyOrNodeOrEntry instanceof RedBlackTreeNode;
   }
 
-  /**
-   * Time Complexity: O(1)
-   * Space Complexity: O(1)
-   */
-
-  /**
-   * Time Complexity: O(1)
-   * Space Complexity: O(1)
-   *
-   * The function checks if a given node is a real node in a Red-Black Tree.
-   * @param {NODE | undefined} node - The `node` parameter is of type `NODE | undefined`, which means
-   * it can either be of type `NODE` or `undefined`.
-   * @returns a boolean value.
-   */
-  override isRealNode(node: NODE | undefined): node is NODE {
-    if (node === this.SENTINEL || node === undefined) return false;
-    return node instanceof RedBlackTreeNode;
-  }
-
-  /**
-   * Time Complexity: O(log n)
-   * Space Complexity: O(1)
-   */
-
-  /**
-   * Time Complexity: O(log n)
-   * Space Complexity: O(1)
-   *
-   * The `getNode` function retrieves a node from a Red-Black Tree based on the provided identifier and
-   * callback function.
-   * @param {ReturnType<C> | undefined} identifier - The `identifier` parameter is the value or key
-   * that you want to search for in the binary search tree. It can be of any type that is compatible
-   * with the type of nodes in the tree.
-   * @param {C} callback - The `callback` parameter is a function that will be called for each node in
-   * the tree. It is used to determine whether a node matches the given identifier. The `callback`
-   * function should take a node as its parameter and return a value that can be compared to the
-   * `identifier` parameter.
-   * @param beginRoot - The `beginRoot` parameter is the starting point for the search in the binary
-   * search tree. It can be either a key or a node. If it is a key, it will be converted to a node
-   * using the `ensureNode` method. If it is not provided, the `root`
-   * @param iterationType - The `iterationType` parameter is used to specify the type of iteration to
-   * be performed when searching for nodes in the binary search tree. It is an optional parameter and
-   * its default value is taken from the `iterationType` property of the class.
-   * @returns The method is returning a value of type `NODE | null | undefined`.
-   */
-  override getNode<C extends BTNCallback<NODE>>(
-    identifier: ReturnType<C> | undefined,
-    callback: C = this._DEFAULT_CALLBACK as C,
-    beginRoot: BSTNKeyOrNode<K, NODE> = this.root,
-    iterationType: IterationType = this.iterationType
-  ): NODE | null | undefined {
-    return this.getNodes(identifier, callback, true, beginRoot, iterationType)[0] ?? undefined;
-  }
-
   /**
    * Time Complexity: O(1)
    * Space Complexity: O(1)
@@ -252,7 +186,7 @@ export class RedBlackTree<
    */
   override clear() {
     super.clear();
-    this._root = this.SENTINEL;
+    this._root = this.NIL;
   }
 
   /**
@@ -430,9 +364,9 @@ export class RedBlackTree<
     while (this.isRealNode(current)) {
       parent = current;
       if (node.key < current.key) {
-        current = current.left ?? this.SENTINEL;
+        current = current.left ?? this.NIL;
       } else if (node.key > current.key) {
-        current = current.right ?? this.SENTINEL;
+        current = current.right ?? this.NIL;
       } else {
         this._replaceNode(current, node);
         return 'UPDATED';
@@ -449,8 +383,8 @@ export class RedBlackTree<
       parent.right = node;
     }
 
-    node.left = this.SENTINEL;
-    node.right = this.SENTINEL;
+    node.left = this.NIL;
+    node.right = this.NIL;
     node.color = 'RED';
 
     this._insertFixup(node);

package/test/performance/data-structures/binary-tree/avl-tree.test.ts

@@ -12,6 +12,10 @@ suite
     avlTree.clear();
     for (let i = 0; i < randomArray.length; i++) avlTree.add(i);
   })
+  .add(`${HUNDRED_THOUSAND.toLocaleString()} add randomly`, () => {
+    avlTree.clear();
+    for (let i = 0; i < randomArray.length; i++) avlTree.add(randomArray[i]);
+  })
   .add(`${HUNDRED_THOUSAND.toLocaleString()} get`, () => {
     for (let i = 0; i < randomArray.length; i++) avlTree.get(randomArray[i]);
   })

package/test/performance/data-structures/binary-tree/rb-tree.test.ts

@@ -15,6 +15,10 @@ suite
     rbTree.clear();
     for (let i = 0; i < randomArray.length; i++) rbTree.add(i);
   })
+  .add(`${HUNDRED_THOUSAND.toLocaleString()} add randomly`, () => {
+    rbTree.clear();
+    for (let i = 0; i < randomArray.length; i++) rbTree.add(randomArray[i]);
+  })
   .add(`${HUNDRED_THOUSAND.toLocaleString()} get`, () => {
     for (let i = 0; i < randomArray.length; i++) rbTree.get(randomArray[i]);
   })

package/test/unit/data-structures/binary-tree/overall.test.ts

@@ -20,8 +20,8 @@ describe('Overall BinaryTree Test', () => {
     leftMost?.key === 1; // true
     expect(leftMost?.key).toBe(1);
     bst.delete(6);
-    bst.getNode(6); // null
-    expect(bst.getNode(6)).toBeNull();
+    bst.getNode(6); // undefined
+    expect(bst.getNode(6)).toBe(undefined);
     bst.isAVLBalanced(); // true or false
     expect(bst.isAVLBalanced()).toBe(true);
     const bfsIDs: number[] = [];