data-structure-typed 1.37.1 → 1.37.2

package/lib/data-structures/binary-tree/bst.js

@@ -199,13 +199,13 @@ export class BST extends BinaryTree {
      * The function returns the first node in a binary tree that matches the given property name and value.
      * @param {BinaryTreeNodeKey | N} nodeProperty - The `nodeProperty` parameter can be either a `BinaryTreeNodeKey` or a
      * generic type `N`. It represents the property of the binary tree node that you want to search for.
-     * @param {BinaryTreeNodePropertyName} [propertyName] - The `propertyName` parameter is an optional parameter that
+     * @param callback  - The `callback` parameter is a function that takes a node as a parameter and returns a value.
      * specifies the property name to use for searching the binary tree nodes. If not provided, it defaults to `'key'`.
      * @returns The method is returning either a BinaryTreeNodeKey or N (generic type) or null.
      */
-    get(nodeProperty, propertyName = 'key') {
+    get(nodeProperty, callback = this._defaultCallbackByKey) {
         var _a;
-        return (_a = this.getNodes(nodeProperty, propertyName, true)[0]) !== null && _a !== void 0 ? _a : null;
+        return (_a = this.getNodes(nodeProperty, callback, true)[0]) !== null && _a !== void 0 ? _a : null;
     }
     /**
      * The function returns the key of the rightmost node if the comparison between two values is less than, the key of the
@@ -227,24 +227,30 @@ export class BST extends BinaryTree {
      * The function `getNodes` returns an array of nodes in a binary tree that match a given property value.
      * @param {BinaryTreeNodeKey | N} nodeProperty - The `nodeProperty` parameter can be either a `BinaryTreeNodeKey` or an
      * `N` type. It represents the property of the binary tree node that you want to compare with.
-     * @param {BinaryTreeNodePropertyName} [propertyName] - The `propertyName` parameter is an optional parameter that
+     * @param callback - The `callback` parameter is a function that takes a node as a parameter and returns a value.
      * specifies the property name to use for comparison. If not provided, it defaults to `'key'`.
      * @param {boolean} [onlyOne] - The `onlyOne` parameter is an optional boolean parameter that determines whether to
      * return only one node that matches the given `nodeProperty` or all nodes that match the `nodeProperty`. If `onlyOne`
      * is set to `true`, the function will return an array with only one node (if
+     * @param beginRoot - The `beginRoot` parameter is an optional parameter that specifies the root node from which to
      * @returns an array of nodes (type N).
      */
-    getNodes(nodeProperty, propertyName = 'key', onlyOne = false) {
-        if (!this.root)
+    getNodes(nodeProperty, callback = this._defaultCallbackByKey, onlyOne = false, beginRoot = this.root) {
+        if (!beginRoot)
             return [];
-        const result = [];
+        const ans = [];
         if (this.loopType === LoopType.RECURSIVE) {
             const _traverse = (cur) => {
-                if (this._pushByPropertyNameStopOrNot(cur, result, nodeProperty, propertyName, onlyOne))
-                    return;
+                const callbackResult = callback(cur);
+                if (callbackResult === nodeProperty) {
+                    ans.push(cur);
+                    if (onlyOne)
+                        return;
+                }
                 if (!cur.left && !cur.right)
                     return;
-                if (propertyName === 'key') {
+                // TODO potential bug
+                if (callback === this._defaultCallbackByKey) {
                     if (this._compare(cur.key, nodeProperty) === CP.gt)
                         cur.left && _traverse(cur.left);
                     if (this._compare(cur.key, nodeProperty) === CP.lt)
@@ -255,16 +261,21 @@ export class BST extends BinaryTree {
                     cur.right && _traverse(cur.right);
                 }
             };
-            _traverse(this.root);
+            _traverse(beginRoot);
         }
         else {
-            const queue = new Queue([this.root]);
+            const queue = new Queue([beginRoot]);
             while (queue.size > 0) {
                 const cur = queue.shift();
                 if (cur) {
-                    if (this._pushByPropertyNameStopOrNot(cur, result, nodeProperty, propertyName, onlyOne))
-                        return result;
-                    if (propertyName === 'key') {
+                    const callbackResult = callback(cur);
+                    if (callbackResult === nodeProperty) {
+                        ans.push(cur);
+                        if (onlyOne)
+                            return ans;
+                    }
+                    // TODO potential bug
+                    if (callback === this._defaultCallbackByKey) {
                         if (this._compare(cur.key, nodeProperty) === CP.gt)
                             cur.left && queue.push(cur.left);
                         if (this._compare(cur.key, nodeProperty) === CP.lt)
@@ -277,22 +288,23 @@ export class BST extends BinaryTree {
                 }
             }
         }
-        return result;
+        return ans;
     }
     // --- start additional functions
     /**
-     * The `lesserOrGreaterForeach` function adds a delta value to the specified property of all nodes in a binary tree that
+     * The `lesserOrGreaterTraverse` function adds a delta value to the specified property of all nodes in a binary tree that
      * have a greater value than a given node.
+     * @param callback - The `callback` parameter is a function that takes a node as a parameter and returns a value.
      * @param {N | BinaryTreeNodeKey | null} node - The `node` parameter can be either of type `N` (a generic type), `BinaryTreeNodeKey`, or `null`. It
      * represents the node in the binary tree to which the delta value will be added.
      * @param lesserOrGreater - The `lesserOrGreater` parameter is an optional parameter that specifies whether the delta
-     * @param callback - The `callback` parameter is a function that takes a node as a parameter and returns a boolean
      */
-    lesserOrGreaterForeach(node, lesserOrGreater = CP.lt, callback) {
+    lesserOrGreaterTraverse(callback = this._defaultCallbackByKey, lesserOrGreater = CP.lt, node) {
         if (typeof node === 'number')
-            node = this.get(node, 'key');
+            node = this.get(node);
+        const ans = [];
         if (!node)
-            return false;
+            return [];
         const key = node.key;
         if (!this.root)
             return false;
@@ -300,7 +312,7 @@ export class BST extends BinaryTree {
             const _traverse = (cur) => {
                 const compared = this._compare(cur.key, key);
                 if (compared === lesserOrGreater)
-                    callback(cur);
+                    ans.push(callback(cur));
                 if (!cur.left && !cur.right)
                     return;
                 if (cur.left && this._compare(cur.left.key, key) === lesserOrGreater)
@@ -318,14 +330,14 @@ export class BST extends BinaryTree {
                 if (cur) {
                     const compared = this._compare(cur.key, key);
                     if (compared === lesserOrGreater)
-                        callback(cur);
+                        ans.push(callback(cur));
                     if (cur.left && this._compare(cur.left.key, key) === lesserOrGreater)
                         queue.push(cur.left);
                     if (cur.right && this._compare(cur.right.key, key) === lesserOrGreater)
                         queue.push(cur.right);
                 }
             }
-            return true;
+            return ans;
         }
     }
     /**
@@ -343,7 +355,7 @@ export class BST extends BinaryTree {
      * @returns The function `perfectlyBalance()` returns a boolean value.
      */
     perfectlyBalance() {
-        const sorted = this.dfs('in', 'node'), n = sorted.length;
+        const sorted = this.dfs(node => node, 'in'), n = sorted.length;
         this.clear();
         if (sorted.length < 1)
             return false;

package/lib/data-structures/binary-tree/tree-multiset.d.ts

@@ -6,7 +6,7 @@
  * @license MIT License
  */
 import type { BinaryTreeNodeKey, TreeMultisetNodeNested, TreeMultisetOptions } from '../../types';
-import { BinaryTreeDeletedResult, DFSOrderPattern } from '../../types';
+import { BinaryTreeDeletedResult } from '../../types';
 import { IBinaryTree } from '../../interfaces';
 import { AVLTree, AVLTreeNode } from './avl-tree';
 export declare class TreeMultisetNode<V = any, FAMILY extends TreeMultisetNode<V, FAMILY> = TreeMultisetNodeNested<V>> extends AVLTreeNode<V, FAMILY> {
@@ -102,40 +102,6 @@ export declare class TreeMultiset<N extends TreeMultisetNode<N['val'], N> = Tree
      * @returns The function `delete` returns an array of `BinaryTreeDeletedResult<N>` objects.
      */
     delete(nodeOrKey: N | BinaryTreeNodeKey, ignoreCount?: boolean): BinaryTreeDeletedResult<N>[];
-    /**
-     * The function `getNodesByCount` returns an array of nodes that have a specific count property, either recursively or
-     * using a queue.
-     * @param {BinaryTreeNodeKey | N} nodeProperty - The `nodeProperty` parameter can be either a `BinaryTreeNodeKey` or a
-     * `N`. It represents the property of the nodes that you want to search for.
-     * @param {boolean} [onlyOne] - The `onlyOne` parameter is an optional boolean parameter that determines whether to
-     * return only one node that matches the `nodeProperty` or all nodes that match the `nodeProperty`. If `onlyOne` is set
-     * to `true`, the function will return only one node. If `onlyOne`
-     * @returns an array of nodes that match the given nodeProperty.
-     */
-    getNodesByCount(nodeProperty: BinaryTreeNodeKey | N, onlyOne?: boolean): N[];
-    /**
-     * The BFSCount function returns an array of counts from a breadth-first search of nodes.
-     * @returns The BFSCount() function returns an array of numbers, specifically the count property of each node in the
-     * bfs traversal.
-     */
-    bfsCount(): number[];
-    /**
-     * The function "listLevelsCount" takes a node and returns an array of arrays, where each inner array contains the
-     * count property of each node at that level.
-     * @param {N | null} node - The parameter `node` is of type `N | null`. This means that it can either be an instance of
-     * the class `N` or `null`.
-     * @returns a 2D array of numbers. Each inner array represents a level in the binary tree, and each number in the inner
-     * array represents the count property of a node in that level.
-     */
-    listLevelsCount(node: N | null): number[][];
-    /**
-     * The `morrisCount` function returns an array of counts for each node in a binary tree, based on a specified traversal
-     * pattern.
-     * @param {'in' | 'pre' | 'post'} [pattern] - The `pattern` parameter is an optional parameter that specifies the
-     * traversal pattern for the Morris traversal algorithm. It can have one of three values: 'in', 'pre', or 'post'.
-     * @returns The function `morrisCount` returns an array of numbers.
-     */
-    morrisCount(pattern?: DFSOrderPattern): number[];
     /**
      * The clear() function clears the data and sets the count to 0.
      */

package/lib/data-structures/binary-tree/tree-multiset.js

@@ -1,6 +1,5 @@
 import { CP, FamilyPosition, LoopType } from '../../types';
 import { AVLTree, AVLTreeNode } from './avl-tree';
-import { Queue } from '../queue';
 export class TreeMultisetNode extends AVLTreeNode {
     /**
      * The constructor function initializes a BinaryTreeNode object with a key, value, and count.
@@ -222,7 +221,7 @@ export class TreeMultiset extends AVLTree {
      * @returns The function `perfectlyBalance()` returns a boolean value.
      */
     perfectlyBalance() {
-        const sorted = this.dfs('in', 'node'), n = sorted.length;
+        const sorted = this.dfs(node => node, 'in'), n = sorted.length;
         if (sorted.length < 1)
             return false;
         this.clear();
@@ -322,83 +321,6 @@ export class TreeMultiset extends AVLTree {
         }
         return bstDeletedResult;
     }
-    /**
-     * The function `getNodesByCount` returns an array of nodes that have a specific count property, either recursively or
-     * using a queue.
-     * @param {BinaryTreeNodeKey | N} nodeProperty - The `nodeProperty` parameter can be either a `BinaryTreeNodeKey` or a
-     * `N`. It represents the property of the nodes that you want to search for.
-     * @param {boolean} [onlyOne] - The `onlyOne` parameter is an optional boolean parameter that determines whether to
-     * return only one node that matches the `nodeProperty` or all nodes that match the `nodeProperty`. If `onlyOne` is set
-     * to `true`, the function will return only one node. If `onlyOne`
-     * @returns an array of nodes that match the given nodeProperty.
-     */
-    getNodesByCount(nodeProperty, onlyOne = false) {
-        if (!this.root)
-            return [];
-        const result = [];
-        if (this.loopType === LoopType.RECURSIVE) {
-            const _traverse = (cur) => {
-                if (cur.count === nodeProperty) {
-                    result.push(cur);
-                    if (onlyOne)
-                        return;
-                }
-                if (!cur.left && !cur.right)
-                    return;
-                cur.left && _traverse(cur.left);
-                cur.right && _traverse(cur.right);
-            };
-            _traverse(this.root);
-        }
-        else {
-            const queue = new Queue([this.root]);
-            while (queue.size > 0) {
-                const cur = queue.shift();
-                if (cur) {
-                    if (cur.count === nodeProperty) {
-                        result.push(cur);
-                        if (onlyOne)
-                            return result;
-                    }
-                    cur.left && queue.push(cur.left);
-                    cur.right && queue.push(cur.right);
-                }
-            }
-        }
-        return result;
-    }
-    /**
-     * The BFSCount function returns an array of counts from a breadth-first search of nodes.
-     * @returns The BFSCount() function returns an array of numbers, specifically the count property of each node in the
-     * bfs traversal.
-     */
-    bfsCount() {
-        const nodes = super.bfs('node');
-        return nodes.map(node => node.count);
-    }
-    /**
-     * The function "listLevelsCount" takes a node and returns an array of arrays, where each inner array contains the
-     * count property of each node at that level.
-     * @param {N | null} node - The parameter `node` is of type `N | null`. This means that it can either be an instance of
-     * the class `N` or `null`.
-     * @returns a 2D array of numbers. Each inner array represents a level in the binary tree, and each number in the inner
-     * array represents the count property of a node in that level.
-     */
-    listLevelsCount(node) {
-        const levels = super.listLevels(node, 'node');
-        return levels.map(level => level.map(node => node.count));
-    }
-    /**
-     * The `morrisCount` function returns an array of counts for each node in a binary tree, based on a specified traversal
-     * pattern.
-     * @param {'in' | 'pre' | 'post'} [pattern] - The `pattern` parameter is an optional parameter that specifies the
-     * traversal pattern for the Morris traversal algorithm. It can have one of three values: 'in', 'pre', or 'post'.
-     * @returns The function `morrisCount` returns an array of numbers.
-     */
-    morrisCount(pattern = 'in') {
-        const nodes = super.morris(pattern, 'node');
-        return nodes.map(node => node.count);
-    }
     /**
      * The clear() function clears the data and sets the count to 0.
      */

package/lib/data-structures/heap/heap.d.ts

@@ -80,7 +80,7 @@ export declare class Heap<E> {
     has(element: E): boolean;
     /**
      * Depth-first search (DFS) method, different traversal orders can be selected。
-     * @param order - Traversal order parameter: 'in' (in-order), 'pre' (pre-order) or 'post' (post-order).
+     * @param order - Traverse order parameter: 'in' (in-order), 'pre' (pre-order) or 'post' (post-order).
      * @returns An array containing elements traversed in the specified order.
      */
     dfs(order: DFSOrderPattern): E[];

package/lib/data-structures/heap/heap.js

@@ -151,7 +151,7 @@ export class Heap {
     }
     /**
      * Depth-first search (DFS) method, different traversal orders can be selected。
-     * @param order - Traversal order parameter: 'in' (in-order), 'pre' (pre-order) or 'post' (post-order).
+     * @param order - Traverse order parameter: 'in' (in-order), 'pre' (pre-order) or 'post' (post-order).
      * @returns An array containing elements traversed in the specified order.
      */
     dfs(order) {

package/lib/types/data-structures/binary-tree.d.ts

@@ -21,6 +21,8 @@ export declare enum FamilyPosition {
 export type BinaryTreeNodePropertyName = 'key' | 'val';
 export type NodeOrPropertyName = 'node' | BinaryTreeNodePropertyName;
 export type BinaryTreeNodeKey = number;
+export type BFSCallback<N> = (node: N, level?: number) => any;
+export type BFSCallbackReturn<N> = ReturnType<BFSCallback<N>>;
 export type BinaryTreeNodeProperty<N extends BinaryTreeNode<N['val'], N>> = N['val'] | N | number | BinaryTreeNodeKey;
 export type BinaryTreeDeletedResult<N> = {
     deleted: N | null | undefined;

package/lib/types/data-structures/index.d.ts

@@ -12,3 +12,5 @@ export * from './singly-linked-list';
 export * from './doubly-linked-list';
 export * from './navigator';
 export * from './hash';
+export type MapCallback<N> = (node: N) => any;
+export type MapCallbackReturn<N> = ReturnType<MapCallback<N>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "data-structure-typed",
-  "version": "1.37.1",
+  "version": "1.37.2",
   "description": "Data Structures of Javascript & TypeScript. Binary Tree, BST, Graph, Heap, Priority Queue, Linked List, Queue, Deque, Stack, AVL Tree, Tree Multiset, Trie, Directed Graph, Undirected Graph, Singly Linked List, Doubly Linked List, Max Heap, Max Priority Queue, Min Heap, Min Priority Queue.",
   "main": "dist/index.js",
   "module": "lib/index.js",
@@ -58,17 +58,17 @@
     "@typescript-eslint/eslint-plugin": "^6.7.4",
     "@typescript-eslint/parser": "^6.7.4",
     "auto-changelog": "^2.4.0",
-    "avl-tree-typed": "^1.36.9",
+    "avl-tree-typed": "^1.37.0",
     "benchmark": "^2.1.4",
-    "binary-tree-typed": "^1.36.9",
-    "bst-typed": "^1.36.9",
+    "binary-tree-typed": "^1.37.0",
+    "bst-typed": "^1.37.0",
     "dependency-cruiser": "^14.1.0",
     "eslint": "^8.50.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-import-resolver-alias": "^1.1.2",
     "eslint-import-resolver-typescript": "^3.6.1",
     "eslint-plugin-import": "^2.28.1",
-    "heap-typed": "^1.36.9",
+    "heap-typed": "^1.37.0",
     "istanbul-badges-readme": "^1.8.5",
     "jest": "^29.7.0",
     "prettier": "^3.0.3",

package/test/integration/avl-tree.test.ts

@@ -1,4 +1,5 @@
 import {AVLTree} from 'avl-tree-typed';
+import {CP} from "data-structure-typed";
 
 describe('AVL Tree Test', () => {
   it('should perform various operations on a AVL Tree', () => {
@@ -22,10 +23,12 @@ describe('AVL Tree Test', () => {
     const getMinNodeBySpecificNode = node15 && tree.getLeftMost(node15);
     expect(getMinNodeBySpecificNode?.key).toBe(12);
 
-    const subTreeSum = node15 && tree.subTreeSum(node15);
+    let subTreeSum = 0;
+    node15 && tree.subTreeForeach(15, node => subTreeSum += node.key);
     expect(subTreeSum).toBe(70);
 
-    const lesserSum = tree.lesserSum(10);
+    let lesserSum = 0;
+    tree.lesserOrGreaterForeach(10, CP.lt, node => lesserSum += node.key);
     expect(lesserSum).toBe(45);
 
     // node15 has type problem. After the uniform design, the generics of containers (DirectedGraph, BST) are based on the type of value. However, this design has a drawback: when I attempt to inherit from the Vertex or BSTNode classes, the types of the results obtained by all methods are those of the parent class.
@@ -41,56 +44,56 @@ describe('AVL Tree Test', () => {
     expect(bfs[0].key).toBe(8);
     expect(bfs[bfs.length - 1].key).toBe(16);
 
-    expect(tree.remove(11)[0].deleted?.key).toBe(11);
+    expect(tree.delete(11)[0].deleted?.key).toBe(11);
     expect(tree.isAVLBalanced()).toBe(true);
     expect(node15 && tree.getHeight(node15)).toBe(2);
 
-    expect(tree.remove(1)[0].deleted?.key).toBe(1);
+    expect(tree.delete(1)[0].deleted?.key).toBe(1);
     expect(tree.isAVLBalanced()).toBe(true);
     expect(tree.getHeight()).toBe(4);
 
-    expect(tree.remove(4)[0].deleted?.key).toBe(4);
+    expect(tree.delete(4)[0].deleted?.key).toBe(4);
     expect(tree.isAVLBalanced()).toBe(true);
     expect(tree.getHeight()).toBe(4);
 
-    expect(tree.remove(10)[0].deleted?.key).toBe(10);
+    expect(tree.delete(10)[0].deleted?.key).toBe(10);
     expect(tree.isAVLBalanced()).toBe(true);
     expect(tree.getHeight()).toBe(3);
 
-    expect(tree.remove(15)[0].deleted?.key).toBe(15);
+    expect(tree.delete(15)[0].deleted?.key).toBe(15);
     expect(tree.isAVLBalanced()).toBe(true);
 
     expect(tree.getHeight()).toBe(3);
 
-    expect(tree.remove(5)[0].deleted?.key).toBe(5);
+    expect(tree.delete(5)[0].deleted?.key).toBe(5);
     expect(tree.isAVLBalanced()).toBe(true);
     expect(tree.getHeight()).toBe(3);
 
-    expect(tree.remove(13)[0].deleted?.key).toBe(13);
+    expect(tree.delete(13)[0].deleted?.key).toBe(13);
     expect(tree.isAVLBalanced()).toBe(true);
     expect(tree.getHeight()).toBe(3);
 
-    expect(tree.remove(3)[0].deleted?.key).toBe(3);
+    expect(tree.delete(3)[0].deleted?.key).toBe(3);
     expect(tree.isAVLBalanced()).toBe(true);
     expect(tree.getHeight()).toBe(3);
 
-    expect(tree.remove(8)[0].deleted?.key).toBe(8);
+    expect(tree.delete(8)[0].deleted?.key).toBe(8);
     expect(tree.isAVLBalanced()).toBe(true);
     expect(tree.getHeight()).toBe(3);
 
-    expect(tree.remove(6)[0].deleted?.key).toBe(6);
-    expect(tree.remove(6).length).toBe(0);
+    expect(tree.delete(6)[0].deleted?.key).toBe(6);
+    expect(tree.delete(6).length).toBe(0);
     expect(tree.isAVLBalanced()).toBe(true);
     expect(tree.getHeight()).toBe(2);
 
-    expect(tree.remove(7)[0].deleted?.key).toBe(7);
+    expect(tree.delete(7)[0].deleted?.key).toBe(7);
     expect(tree.isAVLBalanced()).toBe(true);
     expect(tree.getHeight()).toBe(2);
 
-    expect(tree.remove(9)[0].deleted?.key).toBe(9);
+    expect(tree.delete(9)[0].deleted?.key).toBe(9);
     expect(tree.isAVLBalanced()).toBe(true);
     expect(tree.getHeight()).toBe(2);
-    expect(tree.remove(14)[0].deleted?.key).toBe(14);
+    expect(tree.delete(14)[0].deleted?.key).toBe(14);
     expect(tree.isAVLBalanced()).toBe(true);
     expect(tree.getHeight()).toBe(1);