avl-tree-typed 1.53.7 → 1.53.8

package/dist/data-structures/queue/deque.js

@@ -60,14 +60,7 @@ class Deque extends base_1.IterableElementBase {
         const needBucketNum = (0, utils_1.calcMinUnitsRequired)(_size, this._bucketSize);
         this._bucketFirst = this._bucketLast = (this._bucketCount >> 1) - (needBucketNum >> 1);
         this._firstInBucket = this._lastInBucket = (this._bucketSize - (_size % this._bucketSize)) >> 1;
-        for (const el of elements) {
-            if (this.toElementFn) {
-                this.push(this.toElementFn(el));
-            }
-            else {
-                this.push(el);
-            }
-        }
+        this.pushMany(elements);
     }
     /**
      * The bucketSize function returns the size of the bucket.
@@ -214,6 +207,35 @@ class Deque extends base_1.IterableElementBase {
         this._size -= 1;
         return element;
     }
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
+     * The `shift()` function removes and returns the first element from a data structure, updating the
+     * internal state variables accordingly.
+     * @returns The element that is being removed from the beginning of the data structure is being
+     * returned.
+     */
+    shift() {
+        if (this._size === 0)
+            return;
+        const element = this._buckets[this._bucketFirst][this._firstInBucket];
+        if (this._size !== 1) {
+            if (this._firstInBucket < this._bucketSize - 1) {
+                this._firstInBucket += 1;
+            }
+            else if (this._bucketFirst < this._bucketCount - 1) {
+                this._bucketFirst += 1;
+                this._firstInBucket = 0;
+            }
+            else {
+                this._bucketFirst = 0;
+                this._firstInBucket = 0;
+            }
+        }
+        this._size -= 1;
+        return element;
+    }
     /**
      * Time Complexity: Amortized O(1)
      * Space Complexity: O(n)
@@ -247,33 +269,55 @@ class Deque extends base_1.IterableElementBase {
         return true;
     }
     /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
+     * Time Complexity: O(k)
+     * Space Complexity: O(k)
      *
-     * The `shift()` function removes and returns the first element from a data structure, updating the
-     * internal state variables accordingly.
-     * @returns The element that is being removed from the beginning of the data structure is being
-     * returned.
-     */
-    shift() {
-        if (this._size === 0)
-            return;
-        const element = this._buckets[this._bucketFirst][this._firstInBucket];
-        if (this._size !== 1) {
-            if (this._firstInBucket < this._bucketSize - 1) {
-                this._firstInBucket += 1;
+     * The function `pushMany` iterates over elements and pushes them into an array after applying a
+     * transformation function if provided.
+     * @param {IterableWithSizeOrLength<E> | IterableWithSizeOrLength<R>} elements - The `elements`
+     * parameter in the `pushMany` function is expected to be an iterable containing elements of type `E`
+     * or `R`. It can be either an `IterableWithSizeOrLength<E>` or an `IterableWithSizeOrLength<R>`. The
+     * function iterates over each element
+     * @returns The `pushMany` function is returning an array of boolean values, where each value
+     * represents the result of calling the `push` method on the current object instance with the
+     * corresponding element from the input `elements` iterable.
+     */
+    pushMany(elements) {
+        const ans = [];
+        for (const el of elements) {
+            if (this.toElementFn) {
+                ans.push(this.push(this.toElementFn(el)));
             }
-            else if (this._bucketFirst < this._bucketCount - 1) {
-                this._bucketFirst += 1;
-                this._firstInBucket = 0;
+            else {
+                ans.push(this.push(el));
+            }
+        }
+        return ans;
+    }
+    /**
+     * Time Complexity: O(k)
+     * Space Complexity: O(k)
+     *
+     * The `unshiftMany` function in TypeScript iterates over elements and adds them to the beginning of
+     * an array, optionally converting them using a provided function.
+     * @param {IterableWithSizeOrLength<E> | IterableWithSizeOrLength<R>} elements - The `elements`
+     * parameter in the `unshiftMany` function is an iterable containing elements of type `E` or `R`. It
+     * can be an array or any other iterable data structure that has a known size or length. The function
+     * iterates over each element in the `elements` iterable and
+     * @returns The `unshiftMany` function returns an array of boolean values indicating whether each
+     * element was successfully added to the beginning of the array.
+     */
+    unshiftMany(elements = []) {
+        const ans = [];
+        for (const el of elements) {
+            if (this.toElementFn) {
+                ans.push(this.unshift(this.toElementFn(el)));
             }
             else {
-                this._bucketFirst = 0;
-                this._firstInBucket = 0;
+                ans.push(this.unshift(el));
             }
         }
-        this._size -= 1;
-        return element;
+        return ans;
     }
     /**
      * Time Complexity: O(1)

package/dist/data-structures/queue/queue.d.ts

@@ -84,6 +84,18 @@ export declare class Queue<E = any, R = any> extends IterableElementBase<E, R, Q
      * @returns Always returns true, indicating the element was successfully added.
      */
     push(element: E): boolean;
+    /**
+     * Time Complexity: O(k)
+     * Space Complexity: O(k)
+     *
+     * The `pushMany` function iterates over elements and pushes them into an array after applying a
+     * transformation function if provided.
+     * @param {Iterable<E> | Iterable<R>} elements - The `elements` parameter in the `pushMany` function
+     * is an iterable containing elements of type `E` or `R`.
+     * @returns The `pushMany` function is returning an array of boolean values indicating whether each
+     * element was successfully pushed into the data structure.
+     */
+    pushMany(elements: Iterable<E> | Iterable<R>): boolean[];
     /**
      * Time Complexity: O(1)
      * Space Complexity: O(1)
@@ -94,12 +106,18 @@ export declare class Queue<E = any, R = any> extends IterableElementBase<E, R, Q
      */
     shift(): E | undefined;
     /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
+     *
      * The delete function removes an element from the list.
      * @param {E} element - Specify the element to be deleted
      * @return A boolean value indicating whether the element was successfully deleted or not
      */
     delete(element: E): boolean;
     /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
+     *
      * The deleteAt function deletes the element at a given index.
      * @param {number} index - Determine the index of the element to be deleted
      * @return A boolean value
@@ -109,7 +127,12 @@ export declare class Queue<E = any, R = any> extends IterableElementBase<E, R, Q
      * Time Complexity: O(1)
      * Space Complexity: O(1)
      *
-     * @param index
+     * The `at` function returns the element at a specified index adjusted by an offset, or `undefined`
+     * if the index is out of bounds.
+     * @param {number} index - The `index` parameter represents the position of the element you want to
+     * retrieve from the data structure.
+     * @returns The `at` method is returning the element at the specified index adjusted by the offset
+     * `_offset`.
      */
     at(index: number): E | undefined;
     /**
@@ -136,6 +159,9 @@ export declare class Queue<E = any, R = any> extends IterableElementBase<E, R, Q
      */
     clear(): void;
     /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
+     *
      * The `compact` function in TypeScript slices the elements array based on the offset and resets the
      * offset to zero.
      * @returns The `compact()` method is returning a boolean value of `true`.
@@ -169,6 +195,20 @@ export declare class Queue<E = any, R = any> extends IterableElementBase<E, R, Q
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(n)
+     *
+     * The `map` function in TypeScript creates a new Queue by applying a callback function to each
+     * element in the original Queue.
+     * @param callback - The `callback` parameter is a function that will be applied to each element in
+     * the queue. It takes the current element, its index, and the queue itself as arguments, and returns
+     * a new element.
+     * @param [toElementFn] - The `toElementFn` parameter is an optional function that can be provided to
+     * convert a raw element of type `RM` to a new element of type `EM`. This function is used within the
+     * `map` method to transform each raw element before passing it to the `callback` function. If
+     * @param {any} [thisArg] - The `thisArg` parameter in the `map` function is used to specify the
+     * value of `this` when executing the `callback` function. It allows you to set the context (the
+     * value of `this`) within the callback function. If `thisArg` is provided, it will be
+     * @returns A new Queue object containing elements of type EM, which are the result of applying the
+     * callback function to each element in the original Queue object.
      */
     map<EM, RM>(callback: ElementCallback<E, R, EM, Queue<E, R>>, toElementFn?: (rawElement: RM) => EM, thisArg?: any): Queue<EM, RM>;
     /**

package/dist/data-structures/queue/queue.js

@@ -22,14 +22,7 @@ class Queue extends base_1.IterableElementBase {
             const { autoCompactRatio = 0.5 } = options;
             this._autoCompactRatio = autoCompactRatio;
         }
-        if (elements) {
-            for (const el of elements) {
-                if (this.toElementFn)
-                    this.push(this.toElementFn(el));
-                else
-                    this.push(el);
-            }
-        }
+        this.pushMany(elements);
     }
     /**
      * The elements function returns the elements of this set.
@@ -114,6 +107,27 @@ class Queue extends base_1.IterableElementBase {
         this.elements.push(element);
         return true;
     }
+    /**
+     * Time Complexity: O(k)
+     * Space Complexity: O(k)
+     *
+     * The `pushMany` function iterates over elements and pushes them into an array after applying a
+     * transformation function if provided.
+     * @param {Iterable<E> | Iterable<R>} elements - The `elements` parameter in the `pushMany` function
+     * is an iterable containing elements of type `E` or `R`.
+     * @returns The `pushMany` function is returning an array of boolean values indicating whether each
+     * element was successfully pushed into the data structure.
+     */
+    pushMany(elements) {
+        const ans = [];
+        for (const el of elements) {
+            if (this.toElementFn)
+                ans.push(this.push(this.toElementFn(el)));
+            else
+                ans.push(this.push(el));
+        }
+        return ans;
+    }
     /**
      * Time Complexity: O(1)
      * Space Complexity: O(1)
@@ -132,6 +146,9 @@ class Queue extends base_1.IterableElementBase {
         return first;
     }
     /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
+     *
      * The delete function removes an element from the list.
      * @param {E} element - Specify the element to be deleted
      * @return A boolean value indicating whether the element was successfully deleted or not
@@ -141,6 +158,9 @@ class Queue extends base_1.IterableElementBase {
         return this.deleteAt(index);
     }
     /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
+     *
      * The deleteAt function deletes the element at a given index.
      * @param {number} index - Determine the index of the element to be deleted
      * @return A boolean value
@@ -153,7 +173,12 @@ class Queue extends base_1.IterableElementBase {
      * Time Complexity: O(1)
      * Space Complexity: O(1)
      *
-     * @param index
+     * The `at` function returns the element at a specified index adjusted by an offset, or `undefined`
+     * if the index is out of bounds.
+     * @param {number} index - The `index` parameter represents the position of the element you want to
+     * retrieve from the data structure.
+     * @returns The `at` method is returning the element at the specified index adjusted by the offset
+     * `_offset`.
      */
     at(index) {
         return this.elements[index + this._offset];
@@ -189,6 +214,9 @@ class Queue extends base_1.IterableElementBase {
         this._offset = 0;
     }
     /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
+     *
      * The `compact` function in TypeScript slices the elements array based on the offset and resets the
      * offset to zero.
      * @returns The `compact()` method is returning a boolean value of `true`.
@@ -238,6 +266,20 @@ class Queue extends base_1.IterableElementBase {
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(n)
+     *
+     * The `map` function in TypeScript creates a new Queue by applying a callback function to each
+     * element in the original Queue.
+     * @param callback - The `callback` parameter is a function that will be applied to each element in
+     * the queue. It takes the current element, its index, and the queue itself as arguments, and returns
+     * a new element.
+     * @param [toElementFn] - The `toElementFn` parameter is an optional function that can be provided to
+     * convert a raw element of type `RM` to a new element of type `EM`. This function is used within the
+     * `map` method to transform each raw element before passing it to the `callback` function. If
+     * @param {any} [thisArg] - The `thisArg` parameter in the `map` function is used to specify the
+     * value of `this` when executing the `callback` function. It allows you to set the context (the
+     * value of `this`) within the callback function. If `thisArg` is provided, it will be
+     * @returns A new Queue object containing elements of type EM, which are the result of applying the
+     * callback function to each element in the original Queue object.
      */
     map(callback, toElementFn, thisArg) {
         const newDeque = new Queue([], { toElementFn });

package/dist/data-structures/stack/stack.d.ts

@@ -28,10 +28,6 @@ export declare class Stack<E = any, R = any> extends IterableElementBase<E, R, S
      * @returns The size of the elements array.
      */
     get size(): number;
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(n)
-     */
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(n)
@@ -43,6 +39,9 @@ export declare class Stack<E = any, R = any> extends IterableElementBase<E, R, S
      */
     static fromArray<E>(elements: E[]): Stack<E>;
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The function checks if an array is empty and returns a boolean value.
      * @returns A boolean value indicating whether the `_elements` array is empty or not.
      */
@@ -74,15 +73,33 @@ export declare class Stack<E = any, R = any> extends IterableElementBase<E, R, S
      */
     pop(): E | undefined;
     /**
-     * The delete function removes an element from the stack.
-     * @param element: E Specify the element to be deleted
-     * @return A boolean value indicating whether the element was successfully deleted or not
+     * Time Complexity: O(k)
+     * Space Complexity: O(1)
+     *
+     * The function `pushMany` iterates over elements and pushes them into an array after applying a
+     * transformation function if provided.
+     * @param {Iterable<E> | Iterable<R>} elements - The `elements` parameter in the `pushMany` function
+     * is an iterable containing elements of type `E` or `R`. The function iterates over each element in
+     * the iterable and pushes it into the data structure. If a transformation function `toElementFn` is
+     * provided, it is used to
+     * @returns The `pushMany` function is returning an array of boolean values indicating whether each
+     * element was successfully pushed into the data structure.
+     */
+    pushMany(elements: Iterable<E> | Iterable<R>): boolean[];
+    /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
+     *
+     * The toArray function returns a copy of the elements in an array.
+     * @returns An array of type E.
      */
     delete(element: E): boolean;
     /**
-     * The deleteAt function deletes the element at a given index.
-     * @param index: number Determine the index of the element to be deleted
-     * @return A boolean value
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
+     *
+     * The toArray function returns a copy of the elements in an array.
+     * @returns An array of type E.
      */
     deleteAt(index: number): boolean;
     /**

package/dist/data-structures/stack/stack.js

@@ -14,16 +14,7 @@ class Stack extends base_1.IterableElementBase {
     constructor(elements = [], options) {
         super(options);
         this._elements = [];
-        if (elements) {
-            for (const el of elements) {
-                if (this.toElementFn) {
-                    this.push(this.toElementFn(el));
-                }
-                else {
-                    this.push(el);
-                }
-            }
-        }
+        this.pushMany(elements);
     }
     /**
      * The elements function returns the elements of this set.
@@ -39,10 +30,6 @@ class Stack extends base_1.IterableElementBase {
     get size() {
         return this.elements.length;
     }
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(n)
-     */
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(n)
@@ -56,6 +43,9 @@ class Stack extends base_1.IterableElementBase {
         return new Stack(elements);
     }
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The function checks if an array is empty and returns a boolean value.
      * @returns A boolean value indicating whether the `_elements` array is empty or not.
      */
@@ -100,18 +90,47 @@ class Stack extends base_1.IterableElementBase {
         return this.elements.pop();
     }
     /**
-     * The delete function removes an element from the stack.
-     * @param element: E Specify the element to be deleted
-     * @return A boolean value indicating whether the element was successfully deleted or not
+     * Time Complexity: O(k)
+     * Space Complexity: O(1)
+     *
+     * The function `pushMany` iterates over elements and pushes them into an array after applying a
+     * transformation function if provided.
+     * @param {Iterable<E> | Iterable<R>} elements - The `elements` parameter in the `pushMany` function
+     * is an iterable containing elements of type `E` or `R`. The function iterates over each element in
+     * the iterable and pushes it into the data structure. If a transformation function `toElementFn` is
+     * provided, it is used to
+     * @returns The `pushMany` function is returning an array of boolean values indicating whether each
+     * element was successfully pushed into the data structure.
+     */
+    pushMany(elements) {
+        const ans = [];
+        for (const el of elements) {
+            if (this.toElementFn) {
+                ans.push(this.push(this.toElementFn(el)));
+            }
+            else {
+                ans.push(this.push(el));
+            }
+        }
+        return ans;
+    }
+    /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
+     *
+     * The toArray function returns a copy of the elements in an array.
+     * @returns An array of type E.
      */
     delete(element) {
         const index = this.elements.indexOf(element);
         return this.deleteAt(index);
     }
     /**
-     * The deleteAt function deletes the element at a given index.
-     * @param index: number Determine the index of the element to be deleted
-     * @return A boolean value
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
+     *
+     * The toArray function returns a copy of the elements in an array.
+     * @returns An array of type E.
      */
     deleteAt(index) {
         const spliced = this.elements.splice(index, 1);

package/dist/data-structures/trie/trie.d.ts

@@ -200,7 +200,7 @@ export declare class Trie<R = any> extends IterableElementBase<string, R, Trie<R
      * @returns The `addMany` method returns an array of boolean values indicating whether each word in
      * the input iterable was successfully added to the data structure.
      */
-    addMany(words?: Iterable<string> | Iterable<R>): boolean[];
+    addMany(words: Iterable<string> | Iterable<R>): boolean[];
     /**
      * Time Complexity: O(l), where l is the length of the input word.
      * Space Complexity: O(1) - Constant space.
@@ -235,9 +235,14 @@ export declare class Trie<R = any> extends IterableElementBase<string, R, Trie<R
      */
     delete(word: string): boolean;
     /**
-     * Time Complexity: O(n), where n is the total number of nodes in the trie.
-     * Space Complexity: O(1) - Constant space.
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
      *
+     * The function `getHeight` calculates the height of a trie data structure starting from the root
+     * node.
+     * @returns The `getHeight` method returns the maximum depth or height of the trie tree starting from
+     * the root node. It calculates the depth using a breadth-first search (BFS) traversal of the trie
+     * tree and returns the maximum depth found.
      */
     getHeight(): number;
     /**

package/dist/data-structures/trie/trie.js

@@ -243,7 +243,7 @@ class Trie extends base_1.IterableElementBase {
      * @returns The `addMany` method returns an array of boolean values indicating whether each word in
      * the input iterable was successfully added to the data structure.
      */
-    addMany(words = []) {
+    addMany(words) {
         const ans = [];
         for (const word of words) {
             if (this.toElementFn) {
@@ -338,9 +338,14 @@ class Trie extends base_1.IterableElementBase {
         return isDeleted;
     }
     /**
-     * Time Complexity: O(n), where n is the total number of nodes in the trie.
-     * Space Complexity: O(1) - Constant space.
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
      *
+     * The function `getHeight` calculates the height of a trie data structure starting from the root
+     * node.
+     * @returns The `getHeight` method returns the maximum depth or height of the trie tree starting from
+     * the root node. It calculates the depth using a breadth-first search (BFS) traversal of the trie
+     * tree and returns the maximum depth found.
      */
     getHeight() {
         const startNode = this.root;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "avl-tree-typed",
-  "version": "1.53.7",
+  "version": "1.53.8",
   "description": "AVLTree(Adelson-Velsky and Landis Tree). Javascript & Typescript Data Structure.",
   "main": "dist/index.js",
   "scripts": {
@@ -163,6 +163,6 @@
     "typescript": "^4.9.5"
   },
   "dependencies": {
-    "data-structure-typed": "^1.53.7"
+    "data-structure-typed": "^1.53.8"
   }
 }

package/src/common/index.ts

@@ -1,14 +1,20 @@
+import { isComparable } from '../utils';
+
 export enum DFSOperation {
   VISIT = 0,
   PROCESS = 1
 }
+
 export class Range<K> {
   constructor(
     public low: K,
     public high: K,
     public includeLow: boolean = true,
     public includeHigh: boolean = true
-  ) {}
+  ) {
+    if (!(isComparable(low) && isComparable(high))) throw new RangeError('low or high is not comparable');
+    if (low > high) throw new RangeError('low must be less than or equal to high');
+  }
 
   // Determine whether a key is within the range
   isInRange(key: K, comparator: (a: K, b: K) => number): boolean {

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

@@ -173,7 +173,7 @@ export class AVLTreeMultiMap<
    * 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.
    */
-  override keyValueNodeEntryRawToNodeAndValue(
+  protected override _keyValueNodeEntryRawToNodeAndValue(
     keyNodeEntryOrRaw: BTNRep<K, V, NODE> | R,
     value?: V,
     count = 1
@@ -217,7 +217,7 @@ export class AVLTreeMultiMap<
    * @returns a boolean value.
    */
   override add(keyNodeEntryOrRaw: BTNRep<K, V, NODE> | R, value?: V, count = 1): boolean {
-    const [newNode, newValue] = this.keyValueNodeEntryRawToNodeAndValue(keyNodeEntryOrRaw, value, count);
+    const [newNode, newValue] = this._keyValueNodeEntryRawToNodeAndValue(keyNodeEntryOrRaw, value, count);
     if (newNode === undefined) return false;
 
     const orgNodeCount = newNode?.count || 0;

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

@@ -216,7 +216,7 @@ export class BinaryTree<
    * input parameter (`keyNodeEntryOrRaw`) and processes it accordingly to return a node or null
    * value.
    */
-  keyValueNodeEntryRawToNodeAndValue(
+  protected _keyValueNodeEntryRawToNodeAndValue(
     keyNodeEntryOrRaw: BTNRep<K, V, NODE> | R,
     value?: V
   ): [OptNodeOrNull<NODE>, V | undefined] {
@@ -420,7 +420,7 @@ export class BinaryTree<
    * key was found and the node was replaced instead of inserted.
    */
   add(keyNodeEntryOrRaw: BTNRep<K, V, NODE> | R, value?: V): boolean {
-    const [newNode, newValue] = this.keyValueNodeEntryRawToNodeAndValue(keyNodeEntryOrRaw, value);
+    const [newNode, newValue] = this._keyValueNodeEntryRawToNodeAndValue(keyNodeEntryOrRaw, value);
     if (newNode === undefined) return false;
 
     // If the tree is empty, directly set the new node as the root node