data-structure-typed 1.51.0 → 1.51.2

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

@@ -169,19 +169,19 @@ export class BST extends BinaryTree {
      * @returns either a node object (NODE) or undefined.
      */
     ensureNode(keyOrNodeOrEntry, iterationType = 'ITERATIVE') {
-        let res;
         if (this.isRealNode(keyOrNodeOrEntry)) {
-            res = keyOrNodeOrEntry;
+            return keyOrNodeOrEntry;
         }
         else if (this.isEntry(keyOrNodeOrEntry)) {
-            if (keyOrNodeOrEntry[0])
-                res = this.getNodeByKey(keyOrNodeOrEntry[0], iterationType);
+            if (keyOrNodeOrEntry[0] === null || keyOrNodeOrEntry[0] === undefined)
+                return;
+            return this.getNodeByKey(keyOrNodeOrEntry[0], iterationType);
         }
         else {
-            if (keyOrNodeOrEntry)
-                res = this.getNodeByKey(keyOrNodeOrEntry, iterationType);
+            if (keyOrNodeOrEntry === null || keyOrNodeOrEntry === undefined)
+                return;
+            return this.getNodeByKey(keyOrNodeOrEntry, iterationType);
         }
-        return res;
     }
     /**
      * The function checks if an keyOrNodeOrEntry is an instance of BSTNode.
@@ -365,33 +365,33 @@ export class BST extends BinaryTree {
      * found in the binary tree. If no node is found, it returns `undefined`.
      */
     getNodeByKey(key, iterationType = 'ITERATIVE') {
-        // return this.getNodes(key, this._defaultOneParamCallback, true, this.root, iterationType)[0];
+        // return this.getNodes(key, this._DEFAULT_CALLBACK, true, this.root, iterationType)[0];
         if (!this.isRealNode(this.root))
-            return undefined;
+            return;
         if (iterationType === 'RECURSIVE') {
-            const _dfs = (cur) => {
+            const dfs = (cur) => {
                 if (cur.key === key)
                     return cur;
                 if (!this.isRealNode(cur.left) && !this.isRealNode(cur.right))
                     return;
-                if (this._compare(cur.key, key) === 'GT' && this.isRealNode(cur.left))
-                    return _dfs(cur.left);
-                if (this._compare(cur.key, key) === 'LT' && this.isRealNode(cur.right))
-                    return _dfs(cur.right);
+                if (this.isRealNode(cur.left) && this._compare(cur.key, key) === 'GT')
+                    return dfs(cur.left);
+                if (this.isRealNode(cur.right) && this._compare(cur.key, key) === 'LT')
+                    return dfs(cur.right);
             };
-            return _dfs(this.root);
+            return dfs(this.root);
         }
         else {
-            const queue = new Queue([this.root]);
-            while (queue.size > 0) {
-                const cur = queue.shift();
+            const stack = [this.root];
+            while (stack.length > 0) {
+                const cur = stack.pop();
                 if (this.isRealNode(cur)) {
                     if (this._compare(cur.key, key) === 'EQ')
                         return cur;
-                    if (this._compare(cur.key, key) === 'GT')
-                        this.isRealNode(cur.left) && queue.push(cur.left);
-                    if (this._compare(cur.key, key) === 'LT')
-                        this.isRealNode(cur.right) && queue.push(cur.right);
+                    if (this.isRealNode(cur.left) && this._compare(cur.key, key) === 'GT')
+                        stack.push(cur.left);
+                    if (this.isRealNode(cur.right) && this._compare(cur.key, key) === 'LT')
+                        stack.push(cur.right);
                 }
             }
         }
@@ -424,13 +424,13 @@ export class BST extends BinaryTree {
      * performed on the binary tree. It can have two possible values:
      * @returns The method returns an array of nodes (`NODE[]`).
      */
-    getNodes(identifier, callback = this._defaultOneParamCallback, onlyOne = false, beginRoot = this.root, iterationType = this.iterationType) {
+    getNodes(identifier, callback = this._DEFAULT_CALLBACK, onlyOne = false, beginRoot = this.root, iterationType = this.iterationType) {
         beginRoot = this.ensureNode(beginRoot);
         if (!beginRoot)
             return [];
         const ans = [];
         if (iterationType === 'RECURSIVE') {
-            const _traverse = (cur) => {
+            const dfs = (cur) => {
                 const callbackResult = callback(cur);
                 if (callbackResult === identifier) {
                     ans.push(cur);
@@ -440,18 +440,18 @@ export class BST extends BinaryTree {
                 if (!this.isRealNode(cur.left) && !this.isRealNode(cur.right))
                     return;
                 // TODO potential bug
-                if (callback === this._defaultOneParamCallback) {
+                if (callback === this._DEFAULT_CALLBACK) {
                     if (this.isRealNode(cur.left) && this._compare(cur.key, identifier) === 'GT')
-                        _traverse(cur.left);
+                        dfs(cur.left);
                     if (this.isRealNode(cur.right) && this._compare(cur.key, identifier) === 'LT')
-                        _traverse(cur.right);
+                        dfs(cur.right);
                 }
                 else {
-                    this.isRealNode(cur.left) && _traverse(cur.left);
-                    this.isRealNode(cur.right) && _traverse(cur.right);
+                    this.isRealNode(cur.left) && dfs(cur.left);
+                    this.isRealNode(cur.right) && dfs(cur.right);
                 }
             };
-            _traverse(beginRoot);
+            dfs(beginRoot);
         }
         else {
             const stack = [beginRoot];
@@ -465,7 +465,7 @@ export class BST extends BinaryTree {
                             return ans;
                     }
                     // TODO potential bug
-                    if (callback === this._defaultOneParamCallback) {
+                    if (callback === this._DEFAULT_CALLBACK) {
                         if (this.isRealNode(cur.right) && this._compare(cur.key, identifier) === 'LT')
                             stack.push(cur.right);
                         if (this.isRealNode(cur.left) && this._compare(cur.key, identifier) === 'GT')
@@ -486,6 +486,34 @@ export class BST extends BinaryTree {
         }
         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`.
+     */
+    getNode(identifier, callback = this._DEFAULT_CALLBACK, beginRoot = this.root, iterationType = this.iterationType) {
+        return this.getNodes(identifier, callback, true, beginRoot, iterationType)[0] ?? undefined;
+    }
     /**
      * Time complexity: O(n)
      * Space complexity: O(n)
@@ -509,7 +537,7 @@ export class BST extends BinaryTree {
      * following values:
      * @returns The method is returning an array of the return type of the callback function.
      */
-    dfs(callback = this._defaultOneParamCallback, pattern = 'IN', beginRoot = this.root, iterationType = 'ITERATIVE') {
+    dfs(callback = this._DEFAULT_CALLBACK, pattern = 'IN', beginRoot = this.root, iterationType = 'ITERATIVE') {
         return super.dfs(callback, pattern, beginRoot, iterationType, false);
     }
     /**
@@ -533,7 +561,7 @@ export class BST extends BinaryTree {
      * nodes are visited.
      * @returns The method is returning an array of the return type of the callback function.
      */
-    bfs(callback = this._defaultOneParamCallback, beginRoot = this.root, iterationType = this.iterationType) {
+    bfs(callback = this._DEFAULT_CALLBACK, beginRoot = this.root, iterationType = this.iterationType) {
         return super.bfs(callback, beginRoot, iterationType, false);
     }
     /**
@@ -558,7 +586,7 @@ export class BST extends BinaryTree {
      * @returns The method is returning a two-dimensional array of the return type of the callback
      * function.
      */
-    listLevels(callback = this._defaultOneParamCallback, beginRoot = this.root, iterationType = this.iterationType) {
+    listLevels(callback = this._DEFAULT_CALLBACK, beginRoot = this.root, iterationType = this.iterationType) {
         return super.listLevels(callback, beginRoot, iterationType, false);
     }
     /**
@@ -621,7 +649,7 @@ export class BST extends BinaryTree {
      * @returns The function `lesserOrGreaterTraverse` returns an array of values of type
      * `ReturnType<C>`, which is the return type of the callback function passed as an argument.
      */
-    lesserOrGreaterTraverse(callback = this._defaultOneParamCallback, lesserOrGreater = 'LT', targetNode = this.root, iterationType = this.iterationType) {
+    lesserOrGreaterTraverse(callback = this._DEFAULT_CALLBACK, lesserOrGreater = 'LT', targetNode = this.root, iterationType = this.iterationType) {
         targetNode = this.ensureNode(targetNode);
         const ans = [];
         if (!targetNode)
@@ -630,16 +658,16 @@ export class BST extends BinaryTree {
             return ans;
         const targetKey = targetNode.key;
         if (iterationType === 'RECURSIVE') {
-            const _traverse = (cur) => {
+            const dfs = (cur) => {
                 const compared = this._compare(cur.key, targetKey);
                 if (compared === lesserOrGreater)
                     ans.push(callback(cur));
                 if (this.isRealNode(cur.left))
-                    _traverse(cur.left);
+                    dfs(cur.left);
                 if (this.isRealNode(cur.right))
-                    _traverse(cur.right);
+                    dfs(cur.right);
             };
-            _traverse(this.root);
+            dfs(this.root);
             return ans;
         }
         else {

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

@@ -1,4 +1,4 @@
-import type { BinaryTreeDeleteResult, BSTNKeyOrNode, BTNCallback, IterationType, KeyOrNodeOrEntry, RBTreeOptions, RedBlackTreeNested, RedBlackTreeNodeNested } from '../../types';
+import type { BinaryTreeDeleteResult, BTNCallback, KeyOrNodeOrEntry, RBTreeOptions, RedBlackTreeNested, RedBlackTreeNodeNested } from '../../types';
 import { CRUD, RBTNColor } from '../../types';
 import { BST, BSTNode } from './bst';
 import { IBinaryTree } from '../../interfaces';
@@ -39,12 +39,6 @@ export declare class RedBlackTree<K = any, V = any, NODE extends RedBlackTreeNod
      * should compare keys and
      */
     constructor(keysOrNodesOrEntries?: Iterable<KeyOrNodeOrEntry<K, V, NODE>>, options?: RBTreeOptions<K>);
-    protected _SENTINEL: NODE;
-    /**
-     * The function returns the value of the _SENTINEL property.
-     * @returns The method is returning the value of the `_SENTINEL` property.
-     */
-    get SENTINEL(): NODE;
     protected _root: NODE | undefined;
     /**
      * The function returns the root node of a tree or undefined if there is no root.
@@ -101,46 +95,6 @@ export declare class RedBlackTree<K = any, V = any, NODE extends RedBlackTreeNod
      * @returns {boolean} - `true` if the object is a Red-Black Tree node, `false` otherwise.
      */
     isNode(keyOrNodeOrEntry: KeyOrNodeOrEntry<K, V, NODE>): keyOrNodeOrEntry is NODE;
-    /**
-     * 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.
-     */
-    isRealNode(node: NODE | undefined): node is NODE;
-    /**
-     * 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`.
-     */
-    getNode<C extends BTNCallback<NODE>>(identifier: ReturnType<C> | undefined, callback?: C, beginRoot?: BSTNKeyOrNode<K, NODE>, iterationType?: IterationType): NODE | null | undefined;
     /**
      * Time Complexity: O(1)
      * Space Complexity: O(1)
@@ -187,7 +141,7 @@ export declare class RedBlackTree<K = any, V = any, NODE extends RedBlackTreeNod
      * deleted is not found.
      * @param {C} callback - The `callback` parameter is a function that is used to retrieve a node from
      * the binary tree based on its identifier. It is an optional parameter and if not provided, the
-     * `_defaultOneParamCallback` function is used as the default callback. The callback function should
+     * `_DEFAULT_CALLBACK` function is used as the default callback. The callback function should
      * return the identifier of the node to
      * @returns an array of BinaryTreeDeleteResult<NODE> objects.
      */

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

@@ -44,19 +44,11 @@ export class RedBlackTree extends BST {
      */
     constructor(keysOrNodesOrEntries = [], options) {
         super([], options);
-        this._root = this.SENTINEL;
+        this._root = this.NIL;
         if (keysOrNodesOrEntries) {
             this.addMany(keysOrNodesOrEntries);
         }
     }
-    _SENTINEL = new RedBlackTreeNode(NaN);
-    /**
-     * The function returns the value of the _SENTINEL property.
-     * @returns The method is returning the value of the `_SENTINEL` property.
-     */
-    get SENTINEL() {
-        return this._SENTINEL;
-    }
     _root;
     /**
      * The function returns the root node of a tree or undefined if there is no root.
@@ -148,52 +140,6 @@ export class RedBlackTree extends BST {
     isNode(keyOrNodeOrEntry) {
         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.
-     */
-    isRealNode(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`.
-     */
-    getNode(identifier, callback = this._defaultOneParamCallback, beginRoot = this.root, iterationType = this.iterationType) {
-        return this.getNodes(identifier, callback, true, beginRoot, iterationType)[0] ?? undefined;
-    }
     /**
      * Time Complexity: O(1)
      * Space Complexity: O(1)
@@ -207,7 +153,7 @@ export class RedBlackTree extends BST {
      */
     clear() {
         super.clear();
-        this._root = this.SENTINEL;
+        this._root = this.NIL;
     }
     /**
      * Time Complexity: O(log n)
@@ -261,11 +207,11 @@ export class RedBlackTree extends BST {
      * deleted is not found.
      * @param {C} callback - The `callback` parameter is a function that is used to retrieve a node from
      * the binary tree based on its identifier. It is an optional parameter and if not provided, the
-     * `_defaultOneParamCallback` function is used as the default callback. The callback function should
+     * `_DEFAULT_CALLBACK` function is used as the default callback. The callback function should
      * return the identifier of the node to
      * @returns an array of BinaryTreeDeleteResult<NODE> objects.
      */
-    delete(identifier, callback = this._defaultOneParamCallback) {
+    delete(identifier, callback = this._DEFAULT_CALLBACK) {
         if (identifier === null)
             return [];
         const results = [];
@@ -368,10 +314,10 @@ export class RedBlackTree extends BST {
         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);
@@ -388,8 +334,8 @@ export class RedBlackTree extends BST {
         else {
             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);
         return 'CREATED';

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

@@ -145,7 +145,7 @@ export declare class TreeMultiMap<K = any, V = any, NODE extends TreeMultiMapNod
      * function. It can also be null or undefined if no node needs to be deleted.
      * @param {C} callback - The `callback` parameter is a function that takes a node of type `NODE` as
      * input and returns a value of type `ReturnType<C>`. It is used to determine if a node matches the
-     * identifier for deletion. If no callback is provided, the `_defaultOneParamCallback` function is
+     * identifier for deletion. If no callback is provided, the `_DEFAULT_CALLBACK` function is
      * used
      * @param [ignoreCount=false] - A boolean value indicating whether to ignore the count of the target
      * node when performing deletion. If set to true, the count of the target node will not be considered

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

@@ -197,7 +197,7 @@ export class TreeMultiMap extends RedBlackTree {
      * function. It can also be null or undefined if no node needs to be deleted.
      * @param {C} callback - The `callback` parameter is a function that takes a node of type `NODE` as
      * input and returns a value of type `ReturnType<C>`. It is used to determine if a node matches the
-     * identifier for deletion. If no callback is provided, the `_defaultOneParamCallback` function is
+     * identifier for deletion. If no callback is provided, the `_DEFAULT_CALLBACK` function is
      * used
      * @param [ignoreCount=false] - A boolean value indicating whether to ignore the count of the target
      * node when performing deletion. If set to true, the count of the target node will not be considered
@@ -205,7 +205,7 @@ export class TreeMultiMap extends RedBlackTree {
      * target node will be decremented
      * @returns an array of BinaryTreeDeleteResult<NODE> objects.
      */
-    delete(identifier, callback = this._defaultOneParamCallback, ignoreCount = false) {
+    delete(identifier, callback = this._DEFAULT_CALLBACK, ignoreCount = false) {
         if (identifier === null)
             return [];
         const results = [];