linked-list-typed 1.39.2 → 1.39.4

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

@@ -5,15 +5,15 @@
  * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
  * @license MIT License
  */
-import type { BinaryTreeNodeKey, TreeMultisetNodeNested, TreeMultisetOptions } from '../../types';
-import { BinaryTreeDeletedResult, IterationType, OneParamCallback } from '../../types';
+import type { BTNKey, TreeMultisetNodeNested, TreeMultisetOptions } from '../../types';
+import { BinaryTreeDeletedResult, IterationType, BTNCallback } from '../../types';
 import { IBinaryTree } from '../../interfaces';
 import { AVLTree, AVLTreeNode } from './avl-tree';
 export declare class TreeMultisetNode<V = any, N extends TreeMultisetNode<V, N> = TreeMultisetNodeNested<V>> extends AVLTreeNode<V, N> {
     count: number;
     /**
      * The constructor function initializes a BinaryTreeNode object with a key, value, and count.
-     * @param {BinaryTreeNodeKey} key - The `key` parameter is of type `BinaryTreeNodeKey` and represents the unique identifier
+     * @param {BTNKey} key - The `key` parameter is of type `BTNKey` and represents the unique identifier
      * of the binary tree node.
      * @param {V} [val] - The `val` parameter is an optional parameter of type `V`. It represents the value of the binary
      * tree node. If no value is provided, it will be `undefined`.
@@ -21,7 +21,7 @@ export declare class TreeMultisetNode<V = any, N extends TreeMultisetNode<V, N>
      * occurs in a binary tree node. It has a default value of 1, which means that if no value is provided for the `count`
      * parameter when creating a new instance of the `BinaryTreeNode` class.
      */
-    constructor(key: BinaryTreeNodeKey, val?: V, count?: number);
+    constructor(key: BTNKey, val?: V, count?: number);
 }
 /**
  * The only distinction between a TreeMultiset and a AVLTree lies in the ability of the former to store duplicate nodes through the utilization of counters.
@@ -38,19 +38,19 @@ export declare class TreeMultiset<V = any, N extends TreeMultisetNode<V, N> = Tr
     get count(): number;
     /**
      * The function creates a new BSTNode with the given key, value, and count.
-     * @param {BinaryTreeNodeKey} key - The key parameter is the unique identifier for the binary tree node. It is used to
+     * @param {BTNKey} key - The key parameter is the unique identifier for the binary tree node. It is used to
      * distinguish one node from another in the tree.
      * @param {N} val - The `val` parameter represents the value that will be stored in the binary search tree node.
      * @param {number} [count] - The "count" parameter is an optional parameter of type number. It represents the number of
      * occurrences of the value in the binary search tree node. If not provided, the count will default to 1.
      * @returns A new instance of the BSTNode class with the specified key, value, and count (if provided).
      */
-    createNode(key: BinaryTreeNodeKey, val?: V, count?: number): N;
+    createNode(key: BTNKey, val?: V, count?: number): N;
     /**
      * The `add` function adds a new node to a binary search tree, updating the count if the key already
      * exists, and balancing the tree if necessary.
-     * @param {BinaryTreeNodeKey | N | null} keyOrNode - The `keyOrNode` parameter can be either a
-     * `BinaryTreeNodeKey` (which represents the key of the node to be added), a `N` (which represents a
+     * @param {BTNKey | N | null} keyOrNode - The `keyOrNode` parameter can be either a
+     * `BTNKey` (which represents the key of the node to be added), a `N` (which represents a
      * node to be added), or `null` (which represents a null node).
      * @param [val] - The `val` parameter represents the value associated with the key that is being
      * added to the binary tree.
@@ -59,7 +59,7 @@ export declare class TreeMultiset<V = any, N extends TreeMultisetNode<V, N> = Tr
      * count is specified, the default count will be 1.
      * @returns The function `add` returns a value of type `N | null | undefined`.
      */
-    add(keyOrNode: BinaryTreeNodeKey | N | null, val?: V, count?: number): N | null | undefined;
+    add(keyOrNode: BTNKey | N | null, val?: V, count?: number): N | null | undefined;
     /**
      * The function adds a new node to a binary tree if there is an available slot in the parent node.
      * @param {N | null} newNode - The `newNode` parameter represents the node that needs to be added to
@@ -72,14 +72,14 @@ export declare class TreeMultiset<V = any, N extends TreeMultisetNode<V, N> = Tr
     /**
      * The `addMany` function adds multiple keys or nodes to a TreeMultiset and returns an array of the
      * inserted nodes.
-     * @param {(BinaryTreeNodeKey | null)[] | (N | null)[]} keysOrNodes - An array of keys or nodes to be
-     * added to the multiset. Each element can be either a BinaryTreeNodeKey or a TreeMultisetNode.
+     * @param {(BTNKey | null)[] | (N | null)[]} keysOrNodes - An array of keys or nodes to be
+     * added to the multiset. Each element can be either a BTNKey or a TreeMultisetNode.
      * @param {V[]} [data] - The `data` parameter is an optional array of values that correspond
      * to the keys or nodes being added to the multiset. It is used to associate additional data with
      * each key or node.
      * @returns The function `addMany` returns an array of `N`, `null`, or `undefined` values.
      */
-    addMany(keysOrNodes: (BinaryTreeNodeKey | null)[] | (N | null)[], data?: V[]): (N | null | undefined)[];
+    addMany(keysOrNodes: (BTNKey | null)[] | (N | null)[], data?: V[]): (N | null | undefined)[];
     /**
      * The `perfectlyBalance` function in TypeScript takes a sorted array of nodes and builds a balanced
      * binary search tree using either a recursive or iterative approach.
@@ -93,19 +93,19 @@ export declare class TreeMultiset<V = any, N extends TreeMultisetNode<V, N> = Tr
      * The `delete` function in a binary search tree deletes a node from the tree and returns the deleted
      * node along with the parent node that needs to be balanced.
      * @param {ReturnType<C>} identifier - The `identifier` parameter is either a
-     * `BinaryTreeNodeKey` or a generic type `N`. It represents the property of the node that we are
+     * `BTNKey` or a generic type `N`. It represents the property of the node that we are
      * searching for. It can be a specific key value or any other property of the node.
      * @param callback - The `callback` parameter is a function that takes a node as input and returns a
      * value. This value is compared with the `identifier` parameter to determine if the node should be
      * included in the result. The `callback` parameter has a default value of
-     * `this._defaultCallbackByKey`
+     * `((node: N) => node.key)`
      * @param [ignoreCount=false] - A boolean flag indicating whether to ignore the count of the node
      * being deleted. If set to true, the count of the node will not be considered and the node will be
      * deleted regardless of its count. If set to false (default), the count of the node will be
      * decremented by 1 and
      * @returns The method `delete` returns an array of `BinaryTreeDeletedResult<N>` objects.
      */
-    delete<C extends OneParamCallback<N>>(identifier: ReturnType<C>, callback?: C, ignoreCount?: boolean): BinaryTreeDeletedResult<N>[];
+    delete<C extends BTNCallback<N>>(identifier: ReturnType<C>, callback?: C, ignoreCount?: boolean): BinaryTreeDeletedResult<N>[];
     /**
      * The clear() function clears the contents of a data structure and sets the count to zero.
      */

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

@@ -6,7 +6,7 @@ const avl_tree_1 = require("./avl-tree");
 class TreeMultisetNode extends avl_tree_1.AVLTreeNode {
     /**
      * The constructor function initializes a BinaryTreeNode object with a key, value, and count.
-     * @param {BinaryTreeNodeKey} key - The `key` parameter is of type `BinaryTreeNodeKey` and represents the unique identifier
+     * @param {BTNKey} key - The `key` parameter is of type `BTNKey` and represents the unique identifier
      * of the binary tree node.
      * @param {V} [val] - The `val` parameter is an optional parameter of type `V`. It represents the value of the binary
      * tree node. If no value is provided, it will be `undefined`.
@@ -39,7 +39,7 @@ class TreeMultiset extends avl_tree_1.AVLTree {
     }
     /**
      * The function creates a new BSTNode with the given key, value, and count.
-     * @param {BinaryTreeNodeKey} key - The key parameter is the unique identifier for the binary tree node. It is used to
+     * @param {BTNKey} key - The key parameter is the unique identifier for the binary tree node. It is used to
      * distinguish one node from another in the tree.
      * @param {N} val - The `val` parameter represents the value that will be stored in the binary search tree node.
      * @param {number} [count] - The "count" parameter is an optional parameter of type number. It represents the number of
@@ -52,8 +52,8 @@ class TreeMultiset extends avl_tree_1.AVLTree {
     /**
      * The `add` function adds a new node to a binary search tree, updating the count if the key already
      * exists, and balancing the tree if necessary.
-     * @param {BinaryTreeNodeKey | N | null} keyOrNode - The `keyOrNode` parameter can be either a
-     * `BinaryTreeNodeKey` (which represents the key of the node to be added), a `N` (which represents a
+     * @param {BTNKey | N | null} keyOrNode - The `keyOrNode` parameter can be either a
+     * `BTNKey` (which represents the key of the node to be added), a `N` (which represents a
      * node to be added), or `null` (which represents a null node).
      * @param [val] - The `val` parameter represents the value associated with the key that is being
      * added to the binary tree.
@@ -175,8 +175,8 @@ class TreeMultiset extends avl_tree_1.AVLTree {
     /**
      * The `addMany` function adds multiple keys or nodes to a TreeMultiset and returns an array of the
      * inserted nodes.
-     * @param {(BinaryTreeNodeKey | null)[] | (N | null)[]} keysOrNodes - An array of keys or nodes to be
-     * added to the multiset. Each element can be either a BinaryTreeNodeKey or a TreeMultisetNode.
+     * @param {(BTNKey | null)[] | (N | null)[]} keysOrNodes - An array of keys or nodes to be
+     * added to the multiset. Each element can be either a BTNKey or a TreeMultisetNode.
      * @param {V[]} [data] - The `data` parameter is an optional array of values that correspond
      * to the keys or nodes being added to the multiset. It is used to associate additional data with
      * each key or node.
@@ -246,19 +246,19 @@ class TreeMultiset extends avl_tree_1.AVLTree {
      * The `delete` function in a binary search tree deletes a node from the tree and returns the deleted
      * node along with the parent node that needs to be balanced.
      * @param {ReturnType<C>} identifier - The `identifier` parameter is either a
-     * `BinaryTreeNodeKey` or a generic type `N`. It represents the property of the node that we are
+     * `BTNKey` or a generic type `N`. It represents the property of the node that we are
      * searching for. It can be a specific key value or any other property of the node.
      * @param callback - The `callback` parameter is a function that takes a node as input and returns a
      * value. This value is compared with the `identifier` parameter to determine if the node should be
      * included in the result. The `callback` parameter has a default value of
-     * `this._defaultCallbackByKey`
+     * `((node: N) => node.key)`
      * @param [ignoreCount=false] - A boolean flag indicating whether to ignore the count of the node
      * being deleted. If set to true, the count of the node will not be considered and the node will be
      * deleted regardless of its count. If set to false (default), the count of the node will be
      * decremented by 1 and
      * @returns The method `delete` returns an array of `BinaryTreeDeletedResult<N>` objects.
      */
-    delete(identifier, callback = this._defaultCallbackByKey, ignoreCount = false) {
+    delete(identifier, callback = ((node) => node.key), ignoreCount = false) {
         const bstDeletedResult = [];
         if (!this.root)
             return bstDeletedResult;

package/dist/interfaces/binary-tree.d.ts

@@ -1,7 +1,7 @@
 import { BinaryTreeNode } from '../data-structures';
-import { BinaryTreeDeletedResult, BinaryTreeNodeKey, BinaryTreeNodeNested, OneParamCallback } from '../types';
+import { BinaryTreeDeletedResult, BTNKey, BinaryTreeNodeNested, BTNCallback } from '../types';
 export interface IBinaryTree<V = any, N extends BinaryTreeNode<V, N> = BinaryTreeNodeNested<V>> {
-    createNode(key: BinaryTreeNodeKey, val?: N['val']): N;
-    add(keyOrNode: BinaryTreeNodeKey | N | null, val?: N['val']): N | null | undefined;
-    delete<C extends OneParamCallback<N>>(identifier: ReturnType<C> | null, callback: C): BinaryTreeDeletedResult<N>[];
+    createNode(key: BTNKey, val?: N['val']): N;
+    add(keyOrNode: BTNKey | N | null, val?: N['val']): N | null | undefined;
+    delete<C extends BTNCallback<N>>(identifier: ReturnType<C> | null, callback: C): BinaryTreeDeletedResult<N>[];
 }

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

@@ -18,7 +18,7 @@ export declare enum FamilyPosition {
     ISOLATED = "ISOLATED",
     MAL_NODE = "MAL_NODE"
 }
-export type BinaryTreeNodeKey = number;
+export type BTNKey = number;
 export type BinaryTreeDeletedResult<N> = {
     deleted: N | null | undefined;
     needBalanced: N | null;

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

@@ -1,6 +1,6 @@
 import { BSTNode } from '../../../data-structures';
-import type { BinaryTreeNodeKey, BinaryTreeOptions } from './binary-tree';
-export type BSTComparator = (a: BinaryTreeNodeKey, b: BinaryTreeNodeKey) => number;
+import type { BTNKey, BinaryTreeOptions } from './binary-tree';
+export type BSTComparator = (a: BTNKey, b: BTNKey) => number;
 export type BSTNodeNested<T> = BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, any>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>;
 export type BSTOptions = BinaryTreeOptions & {
     comparator?: BSTComparator;

package/dist/types/helpers.d.ts

@@ -1,6 +1,6 @@
 export type Comparator<T> = (a: T, b: T) => number;
 export type DFSOrderPattern = 'pre' | 'in' | 'post';
-export type OneParamCallback<N, D = any> = (node: N) => D;
+export type BTNCallback<N, D = any> = (node: N) => D;
 export declare enum CP {
     lt = "lt",
     eq = "eq",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "linked-list-typed",
-  "version": "1.39.2",
+  "version": "1.39.4",
   "description": "Linked List, Doubly Linked List, Singly Linked List. Javascript & Typescript Data Structure.",
   "main": "dist/index.js",
   "scripts": {
@@ -66,6 +66,6 @@
     "typescript": "^4.9.5"
   },
   "dependencies": {
-    "data-structure-typed": "^1.39.2"
+    "data-structure-typed": "^1.39.4"
   }
 }

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

@@ -6,14 +6,14 @@
  * @license MIT License
  */
 import {BST, BSTNode} from './bst';
-import type {AVLTreeNodeNested, AVLTreeOptions, BinaryTreeDeletedResult, BinaryTreeNodeKey} from '../../types';
-import {OneParamCallback} from '../../types';
+import type {AVLTreeNodeNested, AVLTreeOptions, BinaryTreeDeletedResult, BTNKey} from '../../types';
+import {BTNCallback} from '../../types';
 import {IBinaryTree} from '../../interfaces';
 
 export class AVLTreeNode<V = any, N extends AVLTreeNode<V, N> = AVLTreeNodeNested<V>> extends BSTNode<V, N> {
   height: number;
 
-  constructor(key: BinaryTreeNodeKey, val?: V) {
+  constructor(key: BTNKey, val?: V) {
     super(key, val);
     this.height = 0;
   }
@@ -21,7 +21,8 @@ export class AVLTreeNode<V = any, N extends AVLTreeNode<V, N> = AVLTreeNodeNeste
 
 export class AVLTree<V = any, N extends AVLTreeNode<V, N> = AVLTreeNode<V, AVLTreeNodeNested<V>>>
   extends BST<V, N>
-  implements IBinaryTree<V, N> {
+  implements IBinaryTree<V, N>
+{
   /**
    * This is a constructor function for an AVL tree data structure in TypeScript.
    * @param {AVLTreeOptions} [options] - The `options` parameter is an optional object that can be passed to the
@@ -34,27 +35,27 @@ export class AVLTree<V = any, N extends AVLTreeNode<V, N> = AVLTreeNode<V, AVLTr
 
   /**
    * The function creates a new AVL tree node with the specified key and value.
-   * @param {BinaryTreeNodeKey} key - The key parameter is the key value that will be associated with
+   * @param {BTNKey} key - The key parameter is the key value that will be associated with
    * the new node. It is used to determine the position of the node in the binary search tree.
    * @param [val] - The parameter `val` is an optional value that can be assigned to the node. It is of
    * type `V`, which means it can be any value that is assignable to the `val` property of the
    * node type `N`.
    * @returns a new AVLTreeNode object with the specified key and value.
    */
-  override createNode(key: BinaryTreeNodeKey, val?: V): N {
+  override createNode(key: BTNKey, val?: V): N {
     return new AVLTreeNode<V, N>(key, val) as N;
   }
 
   /**
    * The function overrides the add method of a binary tree node and balances the tree after inserting
    * a new node.
-   * @param {BinaryTreeNodeKey | N | null} keyOrNode - The `keyOrNode` parameter can accept either a
-   * `BinaryTreeNodeKey` or a `N` (which represents a node in the binary tree) or `null`.
+   * @param {BTNKey | N | null} keyOrNode - The `keyOrNode` parameter can accept either a
+   * `BTNKey` or a `N` (which represents a node in the binary tree) or `null`.
    * @param [val] - The `val` parameter is the value that you want to assign to the new node that you
    * are adding to the binary search tree.
    * @returns The method is returning the inserted node (`N`), `null`, or `undefined`.
    */
-  override add(keyOrNode: BinaryTreeNodeKey | N | null, val?: V): N | null | undefined {
+  override add(keyOrNode: BTNKey | N | null, val?: V): N | null | undefined {
     // TODO support node as a param
     const inserted = super.add(keyOrNode, val);
     if (inserted) this._balancePath(inserted);
@@ -65,18 +66,19 @@ export class AVLTree<V = any, N extends AVLTreeNode<V, N> = AVLTreeNode<V, AVLTr
    * The function overrides the delete method of a binary tree and balances the tree after deleting a
    * node if necessary.
    * @param {ReturnType<C>} identifier - The `identifier` parameter is either a
-   * `BinaryTreeNodeKey` or a generic type `N`. It represents the property of the node that we are
+   * `BTNKey` or a generic type `N`. It represents the property of the node that we are
    * searching for. It can be a specific key value or any other property of the node.
    * @param callback - The `callback` parameter is a function that takes a node as input and returns a
    * value. This value is compared with the `identifier` parameter to determine if the node should be
    * included in the result. The `callback` parameter has a default value of
-   * `this._defaultCallbackByKey`
+   * `((node: N) => node.key)`
    * @returns The method is returning an array of `BinaryTreeDeletedResult<N>` objects.
    */
-  override delete<C extends OneParamCallback<N>>(
+  override delete<C extends BTNCallback<N>>(
     identifier: ReturnType<C>,
-    callback: C = this._defaultCallbackByKey as C
+    callback: C = ((node: N) => node.key) as C
   ): BinaryTreeDeletedResult<N>[] {
+    if ((identifier as any) instanceof AVLTreeNode) callback = (node => node) as C;
     const deletedResults = super.delete(identifier, callback);
     for (const {needBalanced} of deletedResults) {
       if (needBalanced) {
@@ -160,7 +162,7 @@ export class AVLTree<V = any, N extends AVLTreeNode<V, N> = AVLTreeNode<V, AVLTr
       // Balance Restoration: If a balance issue is discovered after inserting a node, it requires balance restoration operations. Balance restoration includes four basic cases where rotation operations need to be performed to fix the balance:
       switch (
         this._balanceFactor(A) // second O(1)
-        ) {
+      ) {
         case -2:
           if (A && A.left) {
             if (this._balanceFactor(A.left) <= 0) {

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

@@ -17,7 +17,7 @@ export class BinaryIndexedTree {
    * @param  - - `frequency`: The default frequency value. It is optional and has a default
    * value of 0.
    */
-  constructor({frequency = 0, max}: { frequency?: number; max: number }) {
+  constructor({frequency = 0, max}: {frequency?: number; max: number}) {
     this._freq = frequency;
     this._max = max;
     this._freqMap = {0: 0};