red-black-tree-typed 1.53.7 → 1.54.2

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

@@ -5,195 +5,96 @@
  * @copyright Copyright (c) 2022 Pablo Zeng <zrwusa@gmail.com>
  * @license MIT License
  */
-import type { AVLTreeMultiMapNested, AVLTreeMultiMapNodeNested, AVLTreeMultiMapOptions, BinaryTreeDeleteResult, BSTNOptKeyOrNode, BTNRep, IterationType } from '../../types';
-import { IBinaryTree } from '../../interfaces';
+import { AVLTreeMultiMapOptions, BTNRep, OptNodeOrNull } from '../../types';
 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> {
-    /**
-     * The constructor function initializes a BinaryTreeNode object with a key, value, and count.
-     * @param {K} key - The `key` parameter is of type `K` and represents the unique identifier
-     * of the binary tree node.
-     * @param {V} [value] - The `value` 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`.
-     * @param {number} [count=1] - The `count` parameter is a number that represents the number of times a particular value
-     * 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: K, value?: V, count?: number);
-    protected _count: number;
-    /**
-     * The function returns the value of the protected variable _count.
-     * @returns The count property of the object, which is of type number.
-     */
-    get count(): number;
-    /**
-     * The above function sets the value of the count property.
-     * @param {number} value - The value parameter is of type number, which means it can accept any
-     * numeric value.
-     */
-    set count(value: number);
+import { IBinaryTree } from '../../interfaces';
+export declare class AVLTreeMultiMapNode<K = any, V = any> extends AVLTreeNode<K, V[]> {
+    /**
+     * This TypeScript constructor initializes an object with a key of type K and an array of values of
+     * type V.
+     * @param {K} key - The `key` parameter is typically used to store a unique identifier or key for the
+     * data being stored in the data structure. It helps in quickly accessing or retrieving the
+     * associated value in the data structure.
+     * @param {V[]} value - The `value` parameter in the constructor represents an array of values of
+     * type `V`.
+     */
+    constructor(key: K, value: V[]);
+    parent?: AVLTreeMultiMapNode<K, V>;
+    _left?: OptNodeOrNull<AVLTreeMultiMapNode<K, V>>;
+    get left(): OptNodeOrNull<AVLTreeMultiMapNode<K, V>>;
+    set left(v: OptNodeOrNull<AVLTreeMultiMapNode<K, V>>);
+    _right?: OptNodeOrNull<AVLTreeMultiMapNode<K, V>>;
+    get right(): OptNodeOrNull<AVLTreeMultiMapNode<K, V>>;
+    set right(v: OptNodeOrNull<AVLTreeMultiMapNode<K, V>>);
 }
 /**
- * The only distinction between a AVLTreeMultiMap and a AVLTree lies in the ability of the former to store duplicate nodes through the utilization of counters.
+ *
  */
-export declare class AVLTreeMultiMap<K = any, V = any, R = object, NODE extends AVLTreeMultiMapNode<K, V, NODE> = AVLTreeMultiMapNode<K, V, AVLTreeMultiMapNodeNested<K, V>>, TREE extends AVLTreeMultiMap<K, V, R, NODE, TREE> = AVLTreeMultiMap<K, V, R, NODE, AVLTreeMultiMapNested<K, V, R, NODE>>> extends AVLTree<K, V, R, NODE, TREE> implements IBinaryTree<K, V, R, NODE, TREE> {
-    /**
-     * The constructor initializes a new AVLTreeMultiMap object with optional initial elements.
-     * @param keysNodesEntriesOrRaws - The `keysNodesEntriesOrRaws` parameter is an
-     * iterable object that can contain either keys, nodes, entries, or raw elements.
-     * @param [options] - The `options` parameter is an optional object that can be used to customize the
-     * behavior of the AVLTreeMultiMap. It can include properties such as `compareKeys` and
-     * `compareValues` functions to define custom comparison logic for keys and values, respectively.
-     */
-    constructor(keysNodesEntriesOrRaws?: Iterable<R | BTNRep<K, V, NODE>>, options?: AVLTreeMultiMapOptions<K, V, R>);
-    protected _count: number;
-    /**
-     * The function calculates the sum of the count property of all nodes in a tree using depth-first
-     * search.
-     * @returns the sum of the count property of all nodes in the tree.
-     */
-    get count(): number;
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(1)
-     *
-     * The function calculates the sum of the count property of all nodes in a tree using depth-first
-     * search.
-     * @returns the sum of the count property of all nodes in the tree.
-     */
-    getComputedCount(): number;
-    /**
-     * The function creates a new AVLTreeMultiMapNode with the specified key, value, and count.
-     * @param {K} key - The key parameter represents the key of the node being created. It is of type K,
-     * which is a generic type that can be replaced with any specific type when using the function.
-     * @param {V} [value] - The `value` parameter is an optional parameter that represents the value
-     * associated with the key in the node. It is of type `V`, which can be any data type.
-     * @param {number} [count] - The `count` parameter represents the number of occurrences of a
-     * key-value pair in the AVLTreeMultiMapNode. It is an optional parameter, so it can be omitted when
-     * calling the `createNode` method. If provided, it specifies the initial count for the node.
-     * @returns a new instance of the AVLTreeMultiMapNode class, casted as NODE.
-     */
-    createNode(key: K, value?: V, count?: number): NODE;
-    /**
-     * The function creates a new AVLTreeMultiMap object with the specified options and returns it.
-     * @param [options] - The `options` parameter is an optional object that contains additional
-     * configuration options for creating the AVLTreeMultiMap. It can have the following properties:
-     * @returns a new instance of the AVLTreeMultiMap class, with the specified options, as a TREE
-     * object.
-     */
-    createTree(options?: AVLTreeMultiMapOptions<K, V, R>): TREE;
+export declare class AVLTreeMultiMap<K = any, V = any, R = object, MK = any, MV = any, MR = object> extends AVLTree<K, V[], R, MK, MV[], MR> implements IBinaryTree<K, V[], R, MK, MV, MR> {
     /**
-     * The function checks if the input is an instance of AVLTreeMultiMapNode.
-     * @param {BTNRep<K, V, NODE> | R} keyNodeEntryOrRaw - The parameter
-     * `keyNodeEntryOrRaw` can be of type `R` or `BTNRep<K, V, NODE>`.
-     * @returns a boolean value indicating whether the input parameter `keyNodeEntryOrRaw` is
-     * an instance of the `AVLTreeMultiMapNode` class.
+     * The constructor initializes an AVLTreeMultiMap with the provided keys, nodes, entries, or raw data
+     * and options.
+     * @param keysNodesEntriesOrRaws - The `keysNodesEntriesOrRaws` parameter in the constructor is an
+     * iterable that can contain either key-value pairs represented as `BTNRep<K, V[],
+     * AVLTreeMultiMapNode<K, V>>` or raw data represented as `R`. This parameter is used to initialize
+     * the AVLTreeMulti
+     * @param [options] - The `options` parameter in the constructor is of type
+     * `AVLTreeMultiMapOptions<K, V[], R>`. It is an optional parameter that allows you to specify
+     * additional options for configuring the AVLTreeMultiMap instance.
      */
-    isNode(keyNodeEntryOrRaw: BTNRep<K, V, NODE> | R): keyNodeEntryOrRaw is NODE;
+    constructor(keysNodesEntriesOrRaws?: Iterable<BTNRep<K, V[], AVLTreeMultiMapNode<K, V>> | R>, options?: AVLTreeMultiMapOptions<K, V[], R>);
     /**
-     * The function `keyValueNodeEntryRawToNodeAndValue` converts a key, value, entry, or raw element into
-     * a node object.
-     * @param {BTNRep<K, V, NODE> | R} keyNodeEntryOrRaw - The
-     * `keyNodeEntryOrRaw` parameter can be of type `R` or `BTNRep<K, V, NODE>`.
-     * @param {V} [value] - The `value` parameter is an optional value that can be passed to the
-     * `override` function. It represents the value associated with the key in the data structure. If no
-     * value is provided, it will default to `undefined`.
-     * @param [count=1] - The `count` parameter is an optional parameter that specifies the number of
-     * times the key-value pair should be added to the data structure. If not provided, it defaults to 1.
-     * @returns either a NODE object or undefined.
-     */
-    keyValueNodeEntryRawToNodeAndValue(keyNodeEntryOrRaw: BTNRep<K, V, NODE> | R, value?: V, count?: number): [NODE | undefined, V | undefined];
-    /**
-     * Time Complexity: O(log n)
-     * Space Complexity: O(1)
-     *
-     * The function overrides the add method of a TypeScript class to add a new node to a data structure
-     * and update the count.
-     * @param {BTNRep<K, V, NODE> | R} keyNodeEntryOrRaw - The
-     * `keyNodeEntryOrRaw` parameter can accept a value of type `R`, which can be any type. It
-     * can also accept a value of type `BTNRep<K, V, NODE>`, which represents a key, node,
-     * entry, or raw element
-     * @param {V} [value] - The `value` parameter represents the value associated with the key in the
-     * data structure. It is an optional parameter, so it can be omitted if not needed.
-     * @param [count=1] - The `count` parameter represents the number of times the key-value pair should
-     * be added to the data structure. By default, it is set to 1, meaning that the key-value pair will
-     * be added once. However, you can specify a different value for `count` if you want to add
-     * @returns a boolean value.
-     */
-    add(keyNodeEntryOrRaw: BTNRep<K, V, NODE> | R, value?: V, count?: number): boolean;
-    /**
-     * Time Complexity: O(log n)
+     * Time Complexity: O(1)
      * Space Complexity: O(1)
      *
-     * The function overrides the delete method in a binary tree data structure, handling deletion of
-     * nodes and maintaining balance in the tree.
-     * @param {BTNRep<K, V, NODE> | R} keyNodeEntryOrRaw - The `predicate`
-     * parameter in the `delete` method is used to specify the condition for deleting a node from the
-     * binary tree. It can be a key, node, or entry that determines which
-     * node(s) should be deleted.
-     * @param [ignoreCount=false] - The `ignoreCount` parameter in the `override delete` method is a
-     * boolean flag that determines whether to ignore the count of the node being deleted. If
-     * `ignoreCount` is set to `true`, the method will delete the node regardless of its count. If
-     * `ignoreCount` is set to
-     * @returns The `delete` method overrides the default delete behavior in a binary tree data
-     * structure. It takes a predicate or node to be deleted and an optional flag to ignore count. The
-     * method returns an array of `BinaryTreeDeleteResult` objects, each containing information about the
-     * deleted node and whether balancing is needed in the tree.
+     * The function `createTree` in TypeScript overrides the creation of an AVLTreeMultiMap with
+     * specified options.
+     * @param [options] - The `options` parameter in the `createTree` function is of type
+     * `AVLTreeMultiMapOptions<K, V[], R>`. This means it is an object that can have properties of type
+     * `K`, `V[]`, and `R`. The function creates a new `AVL
+     * @returns The `createTree` method is returning a new instance of `AVLTreeMultiMap` with the
+     * provided options.
      */
-    delete(keyNodeEntryOrRaw: BTNRep<K, V, NODE> | R, ignoreCount?: boolean): BinaryTreeDeleteResult<NODE>[];
+    createTree(options?: AVLTreeMultiMapOptions<K, V[], R>): AVLTreeMultiMap<K, V, R, MK, MV, MR>;
     /**
      * Time Complexity: O(1)
      * Space Complexity: O(1)
      *
-     * The "clear" function overrides the parent class's "clear" function and also resets the count to
-     * zero.
+     * The function `createNode` overrides the method to create a new AVLTreeMultiMapNode with a
+     * specified key and an empty array of values.
+     * @param {K} key - The `key` parameter in the `createNode` method represents the key of the node
+     * that will be created in the AVLTreeMultiMap.
+     * @returns An AVLTreeMultiMapNode object is being returned, initialized with the provided key and an
+     * empty array.
      */
-    clear(): void;
+    createNode(key: K): AVLTreeMultiMapNode<K, V>;
+    add(node: BTNRep<K, V[], AVLTreeMultiMapNode<K, V>>): boolean;
+    add(key: K, value: V): boolean;
     /**
-     * Time Complexity: O(n log n)
+     * Time Complexity: O(log n)
      * Space Complexity: O(log n)
-     * The `perfectlyBalance` function takes a sorted array of nodes and builds a balanced binary search
-     * tree using either a recursive or iterative approach.
-     * @param {IterationType} iterationType - The `iterationType` parameter is an optional parameter that
-     * specifies the type of iteration to use when building the balanced binary search tree. It has a
-     * default value of `this.iterationType`, which means it will use the iteration type currently set in
-     * the object.
-     * @returns The function `perfectlyBalance` returns a boolean value. It returns `true` if the
-     * balancing operation is successful, and `false` if there are no nodes to balance.
-     */
-    perfectlyBalance(iterationType?: IterationType): boolean;
-    /**
-     * Time complexity: O(n)
-     * Space complexity: O(n)
-     *
-     * The function overrides the clone method to create a deep copy of a tree object.
-     * @returns The `clone()` method is returning a cloned instance of the `TREE` object.
-     */
-    clone(): TREE;
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
      *
-     * The `_swapProperties` function swaps the properties (key, value, count, height) between two nodes
-     * in a binary search tree.
-     * @param {R | BSTNOptKeyOrNode<K, NODE>} srcNode - The `srcNode` parameter represents the source node
-     * that will be swapped with the `destNode`.
-     * @param {R | BSTNOptKeyOrNode<K, NODE>} destNode - The `destNode` parameter represents the destination
-     * node where the properties will be swapped with the source node.
-     * @returns The method is returning the `destNode` after swapping its properties with the `srcNode`.
-     * If either `srcNode` or `destNode` is undefined, it returns `undefined`.
-     */
-    protected _swapProperties(srcNode: R | BSTNOptKeyOrNode<K, NODE>, destNode: R | BSTNOptKeyOrNode<K, NODE>): NODE | undefined;
+     * The function `deleteValue` removes a specific value from a key in an AVLTreeMultiMap data
+     * structure and deletes the entire node if no values are left for that key.
+     * @param {BTNRep<K, V[], AVLTreeMultiMapNode<K, V>> | K} keyNodeOrEntry - The `keyNodeOrEntry`
+     * parameter in the `deleteValue` function can be either a `BTNRep` object representing a key-value
+     * pair in the AVLTreeMultiMapNode, or just the key itself.
+     * @param {V} value - The `value` parameter in the `deleteValue` function represents the specific
+     * value that you want to delete from the multi-map data structure associated with a particular key.
+     * The function checks if the value exists in the array of values associated with the key, and if
+     * found, removes it from the array.
+     * @returns The `deleteValue` function returns a boolean value. It returns `true` if the specified
+     * `value` was successfully deleted from the array of values associated with the `keyNodeOrEntry`. If
+     * the value was not found in the array, it returns `false`.
+     */
+    deleteValue(keyNodeOrEntry: BTNRep<K, V[], AVLTreeMultiMapNode<K, V>> | K, value: V): boolean;
     /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
+     * Time Complexity: O(n)
+     * Space Complexity: O(n)
      *
-     * The function replaces an old node with a new node and updates the count property of the new node.
-     * @param {NODE} oldNode - The oldNode parameter represents the node that needs to be replaced in the
-     * data structure. It is of type NODE.
-     * @param {NODE} newNode - The `newNode` parameter is an instance of the `NODE` class.
-     * @returns The method is returning the result of calling the `_replaceNode` method from the
-     * superclass, which is of type `NODE`.
+     * The function `clone` overrides the default cloning behavior to create a deep copy of a tree
+     * structure.
+     * @returns A cloned tree object is being returned.
      */
-    protected _replaceNode(oldNode: NODE, newNode: NODE): NODE;
+    clone(): AVLTreeMultiMap<K, V, R, MK, MV, MR>;
 }