min-heap-typed 1.50.4 → 1.50.6

package/dist/data-structures/linked-list/singly-linked-list.js

@@ -74,6 +74,24 @@ class SinglyLinkedList extends base_1.IterableElementBase {
     get tail() {
         return this._tail;
     }
+    /**
+     * The above function returns the value of the first element in a linked list, or undefined if the
+     * list is empty.
+     * @returns The value of the first node in the linked list, or undefined if the linked list is empty.
+     */
+    get first() {
+        var _a;
+        return (_a = this.head) === null || _a === void 0 ? void 0 : _a.value;
+    }
+    /**
+     * The function returns the value of the last element in a linked list, or undefined if the list is
+     * empty.
+     * @returns The value of the last node in the linked list, or undefined if the linked list is empty.
+     */
+    get last() {
+        var _a;
+        return (_a = this.tail) === null || _a === void 0 ? void 0 : _a.value;
+    }
     /**
      * The function returns the size of an object.
      * @returns The size of the object, which is a number.
@@ -106,19 +124,18 @@ class SinglyLinkedList extends base_1.IterableElementBase {
     /**
      * Time Complexity: O(1)
      * Space Complexity: O(1)
-     * Constant time, as it involves basic pointer adjustments.
-     * Constant space, as it only creates a new node.
      */
     /**
      * Time Complexity: O(1)
      * Space Complexity: O(1)
      *
-     * The `push` function adds a new node with the given value to the end of a singly linked list.
-     * @param {E} value - The "value" parameter represents the value that you want to add to the linked list. It can be of
-     * any type (E) as specified in the generic type declaration of the class or function.
+     * The push function adds a new element to the end of a singly linked list.
+     * @param {E} element - The "element" parameter represents the value of the element that you want to
+     * add to the linked list.
+     * @returns The `push` method is returning a boolean value, `true`.
      */
-    push(value) {
-        const newNode = new SinglyLinkedListNode(value);
+    push(element) {
+        const newNode = new SinglyLinkedListNode(element);
         if (!this.head) {
             this._head = newNode;
             this._tail = newNode;
@@ -130,21 +147,6 @@ class SinglyLinkedList extends base_1.IterableElementBase {
         this._size++;
         return true;
     }
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     */
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     *
-     * The `push` function adds a new node with the given value to the end of a singly linked list.
-     * @param {E} value - The "value" parameter represents the value that you want to add to the linked list. It can be of
-     * any type (E) as specified in the generic type declaration of the class or function.
-     */
-    addLast(value) {
-        return this.push(value);
-    }
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(1)
@@ -154,10 +156,9 @@ class SinglyLinkedList extends base_1.IterableElementBase {
      * Time Complexity: O(n)
      * Space Complexity: O(1)
      *
-     * The `pop()` function removes and returns the value of the last element in a linked list, updating the head and tail
-     * pointers accordingly.
-     * @returns The method `pop()` returns the value of the node that is being removed from the end of the linked list. If
-     * the linked list is empty, it returns `undefined`.
+     * The `pop` function removes and returns the value of the last element in a linked list.
+     * @returns The method is returning the value of the element that is being popped from the end of the
+     * list.
      */
     pop() {
         if (!this.head)
@@ -179,22 +180,6 @@ class SinglyLinkedList extends base_1.IterableElementBase {
         this._size--;
         return value;
     }
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(1)
-     */
-    /**
-     * Time Complexity: O(n)
-     * Space Complexity: O(1)
-     *
-     * The `pollLast()` function removes and returns the value of the last element in a linked list, updating the head and tail
-     * pointers accordingly.
-     * @returns The method `pop()` returns the value of the node that is being removed from the end of the linked list. If
-     * the linked list is empty, it returns `undefined`.
-     */
-    pollLast() {
-        return this.pop();
-    }
     /**
      * Time Complexity: O(1)
      * Space Complexity: O(1)
@@ -203,8 +188,8 @@ class SinglyLinkedList extends base_1.IterableElementBase {
      * Time Complexity: O(1)
      * Space Complexity: O(1)
      *
-     * The `shift()` function removes and returns the value of the first node in a linked list.
-     * @returns The value of the node that is being removed from the beginning of the linked list.
+     * The `shift()` function removes and returns the value of the first element in a linked list.
+     * @returns The value of the removed node.
      */
     shift() {
         if (!this.head)
@@ -222,26 +207,13 @@ class SinglyLinkedList extends base_1.IterableElementBase {
      * Time Complexity: O(1)
      * Space Complexity: O(1)
      *
-     * The `pollFirst()` function removes and returns the value of the first node in a linked list.
-     * @returns The value of the node that is being removed from the beginning of the linked list.
-     */
-    pollFirst() {
-        return this.shift();
-    }
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     */
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     *
-     * The unshift function adds a new node with the given value to the beginning of a singly linked list.
-     * @param {E} value - The parameter "value" represents the value of the new node that will be added to the beginning of the
-     * linked list.
+     * The unshift function adds a new element to the beginning of a singly linked list.
+     * @param {E} element - The "element" parameter represents the value of the element that you want to
+     * add to the beginning of the singly linked list.
+     * @returns The `unshift` method is returning a boolean value, `true`.
      */
-    unshift(value) {
-        const newNode = new SinglyLinkedListNode(value);
+    unshift(element) {
+        const newNode = new SinglyLinkedListNode(element);
         if (!this.head) {
             this._head = newNode;
             this._tail = newNode;
@@ -253,25 +225,9 @@ class SinglyLinkedList extends base_1.IterableElementBase {
         this._size++;
         return true;
     }
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     */
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     *
-     * The addFirst function adds a new node with the given value to the beginning of a singly linked list.
-     * @param {E} value - The parameter "value" represents the value of the new node that will be added to the beginning of the
-     * linked list.
-     */
-    addFirst(value) {
-        return this.unshift(value);
-    }
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(1)
-     * Linear time, where n is the index, as it may need to traverse the list to find the desired node.
      */
     /**
      * Time Complexity: O(n)

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

@@ -432,59 +432,6 @@ export declare class Deque<E> extends IterableElementBase<E> {
      * @returns a new Deque object with the mapped values.
      */
     map<T>(callback: ElementCallback<E, T>, thisArg?: any): Deque<T>;
-    /**
-     * Time Complexity: Amortized O(1) - Similar to push, resizing leads to O(n).
-     * Space Complexity: O(n) - Due to potential resizing.
-     */
-    /**
-     * Time Complexity: Amortized O(1) - Similar to push, resizing leads to O(n).
-     * Space Complexity: O(n) - Due to potential resizing.
-     *
-     * The addLast function adds an element to the end of an array.
-     * @param {E} element - The element parameter represents the element that you want to add to the end of the
-     * data structure.
-     */
-    addLast(element: E): boolean;
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     */
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     *
-     * The function "pollLast" removes and returns the last element of an array.
-     * @returns The last element of the array is being returned.
-     */
-    pollLast(): E | undefined;
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     * /
-  
-     /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     *
-     * The "addFirst" function adds an element to the beginning of an array.
-     * @param {E} element - The parameter "element" represents the element that you want to add to the
-     * beginning of the data structure.
-     */
-    addFirst(element: E): boolean;
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     * /
-  
-     /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     *
-     * The function "pollFirst" removes and returns the first element of an array.
-     * @returns The method `pollFirst()` is returning the first element of the array after removing it
-     * from the beginning. If the array is empty, it will return `undefined`.
-     */
-    pollFirst(): E | undefined;
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(1)

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

@@ -767,67 +767,6 @@ class Deque extends base_1.IterableElementBase {
         }
         return newDeque;
     }
-    /**
-     * Time Complexity: Amortized O(1) - Similar to push, resizing leads to O(n).
-     * Space Complexity: O(n) - Due to potential resizing.
-     */
-    /**
-     * Time Complexity: Amortized O(1) - Similar to push, resizing leads to O(n).
-     * Space Complexity: O(n) - Due to potential resizing.
-     *
-     * The addLast function adds an element to the end of an array.
-     * @param {E} element - The element parameter represents the element that you want to add to the end of the
-     * data structure.
-     */
-    addLast(element) {
-        return this.push(element);
-    }
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     */
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     *
-     * The function "pollLast" removes and returns the last element of an array.
-     * @returns The last element of the array is being returned.
-     */
-    pollLast() {
-        return this.pop();
-    }
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     * /
-  
-     /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     *
-     * The "addFirst" function adds an element to the beginning of an array.
-     * @param {E} element - The parameter "element" represents the element that you want to add to the
-     * beginning of the data structure.
-     */
-    addFirst(element) {
-        return this.unshift(element);
-    }
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     * /
-  
-     /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     *
-     * The function "pollFirst" removes and returns the first element of an array.
-     * @returns The method `pollFirst()` is returning the first element of the array after removing it
-     * from the beginning. If the array is empty, it will return `undefined`.
-     */
-    pollFirst() {
-        return this.shift();
-    }
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(1)

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

@@ -120,56 +120,6 @@ export declare class Queue<E = any> extends IterableElementBase<E> {
      * @return A boolean value
      */
     deleteAt(index: number): boolean;
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     */
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     *
-     * The `peek` function returns the first element of the array `_elements` if it exists, otherwise it returns `undefined`.
-     * @returns The `peek()` method returns the first element of the data structure, represented by the `_elements` array at
-     * the `_offset` index. If the data structure is empty (size is 0), it returns `undefined`.
-     */
-    peek(): E | undefined;
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     */
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     *
-     * The `peekLast` function returns the last element in an array-like data structure, or undefined if the structure is empty.
-     * @returns The method `peekLast()` returns the last element of the `_elements` array if the array is not empty. If the
-     * array is empty, it returns `undefined`.
-     */
-    peekLast(): E | undefined;
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     */
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     *
-     * The enqueue function adds a value to the end of a queue.
-     * @param {E} value - The value parameter represents the value that you want to add to the queue.
-     */
-    enqueue(value: E): boolean;
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     */
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     *
-     * The `dequeue` function removes and returns the first element from a queue, or returns undefined if the queue is empty.
-     * @returns The method is returning a value of type E or undefined.
-     */
-    dequeue(): E | undefined;
     /**
      * Time Complexity: O(1)
      * Space Complexity: O(1)
@@ -288,26 +238,6 @@ export declare class Queue<E = any> extends IterableElementBase<E> {
  * 4. Frequent Enqueuing and Dequeuing Operations: If your application involves frequent enqueuing and dequeuing operations and is less concerned with random access, then LinkedListQueue is a good choice.
  */
 export declare class LinkedListQueue<E = any> extends SinglyLinkedList<E> {
-    /**
-     * The `get first` function returns the value of the head node in a linked list, or `undefined` if the list is empty.
-     * @returns The `get first()` method is returning the value of the `head` node if it exists, otherwise it returns `undefined`.
-     */
-    get first(): E | undefined;
-    /**
-     * The enqueue function adds a value to the end of an array.
-     * @param {E} value - The value parameter represents the value that you want to add to the queue.
-     */
-    enqueue(value: E): boolean;
-    /**
-     * The `dequeue` function removes and returns the first element from a queue, or returns undefined if the queue is empty.
-     * @returns The method is returning the element at the front of the queue, or undefined if the queue is empty.
-     */
-    dequeue(): E | undefined;
-    /**
-     * The `peek` function returns the value of the head node in a linked list, or `undefined` if the list is empty.
-     * @returns The `peek()` method is returning the value of the `head` node if it exists, otherwise it returns `undefined`.
-     */
-    peek(): E | undefined;
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(n)

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

@@ -156,64 +156,6 @@ class Queue extends base_1.IterableElementBase {
         const spliced = this.elements.splice(index, 1);
         return spliced.length === 1;
     }
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     */
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     *
-     * The `peek` function returns the first element of the array `_elements` if it exists, otherwise it returns `undefined`.
-     * @returns The `peek()` method returns the first element of the data structure, represented by the `_elements` array at
-     * the `_offset` index. If the data structure is empty (size is 0), it returns `undefined`.
-     */
-    peek() {
-        return this.first;
-    }
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     */
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     *
-     * The `peekLast` function returns the last element in an array-like data structure, or undefined if the structure is empty.
-     * @returns The method `peekLast()` returns the last element of the `_elements` array if the array is not empty. If the
-     * array is empty, it returns `undefined`.
-     */
-    peekLast() {
-        return this.last;
-    }
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     */
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     *
-     * The enqueue function adds a value to the end of a queue.
-     * @param {E} value - The value parameter represents the value that you want to add to the queue.
-     */
-    enqueue(value) {
-        return this.push(value);
-    }
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     */
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     *
-     * The `dequeue` function removes and returns the first element from a queue, or returns undefined if the queue is empty.
-     * @returns The method is returning a value of type E or undefined.
-     */
-    dequeue() {
-        return this.shift();
-    }
     /**
      * Time Complexity: O(1)
      * Space Complexity: O(1)
@@ -366,35 +308,6 @@ exports.Queue = Queue;
  * 4. Frequent Enqueuing and Dequeuing Operations: If your application involves frequent enqueuing and dequeuing operations and is less concerned with random access, then LinkedListQueue is a good choice.
  */
 class LinkedListQueue extends linked_list_1.SinglyLinkedList {
-    /**
-     * The `get first` function returns the value of the head node in a linked list, or `undefined` if the list is empty.
-     * @returns The `get first()` method is returning the value of the `head` node if it exists, otherwise it returns `undefined`.
-     */
-    get first() {
-        var _a;
-        return (_a = this.head) === null || _a === void 0 ? void 0 : _a.value;
-    }
-    /**
-     * The enqueue function adds a value to the end of an array.
-     * @param {E} value - The value parameter represents the value that you want to add to the queue.
-     */
-    enqueue(value) {
-        return this.push(value);
-    }
-    /**
-     * The `dequeue` function removes and returns the first element from a queue, or returns undefined if the queue is empty.
-     * @returns The method is returning the element at the front of the queue, or undefined if the queue is empty.
-     */
-    dequeue() {
-        return this.shift();
-    }
-    /**
-     * The `peek` function returns the value of the head node in a linked list, or `undefined` if the list is empty.
-     * @returns The `peek()` method is returning the value of the `head` node if it exists, otherwise it returns `undefined`.
-     */
-    peek() {
-        return this.first;
-    }
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(n)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "min-heap-typed",
-  "version": "1.50.4",
+  "version": "1.50.6",
   "description": "Min Heap. Javascript & Typescript Data Structure.",
   "main": "dist/index.js",
   "scripts": {
@@ -132,6 +132,6 @@
     "typescript": "^4.9.5"
   },
   "dependencies": {
-    "data-structure-typed": "^1.50.4"
+    "data-structure-typed": "^1.50.6"
   }
 }

package/src/data-structures/base/iterable-base.ts

@@ -6,6 +6,8 @@ export abstract class IterableEntryBase<K = any, V = any> {
    * Space Complexity: O(1)
    */
 
+  abstract get size(): number;
+
   /**
    * Time Complexity: O(n)
    * Space Complexity: O(1)
@@ -125,6 +127,11 @@ export abstract class IterableEntryBase<K = any, V = any> {
     return false;
   }
 
+  /**
+   * Time Complexity: O(n)
+   * Space Complexity: O(1)
+   */
+
   /**
    * Time Complexity: O(n)
    * Space Complexity: O(1)
@@ -248,11 +255,6 @@ export abstract class IterableEntryBase<K = any, V = any> {
     return;
   }
 
-  /**
-   * Time Complexity: O(n)
-   * Space Complexity: O(1)
-   */
-
   /**
    * Time Complexity: O(n)
    * Space Complexity: O(1)
@@ -301,6 +303,8 @@ export abstract class IterableEntryBase<K = any, V = any> {
 }
 
 export abstract class IterableElementBase<E = any, C = any> {
+  abstract get size(): number;
+
   /**
    * Time Complexity: O(n)
    * Space Complexity: O(1)
@@ -362,6 +366,11 @@ export abstract class IterableElementBase<E = any, C = any> {
     return true;
   }
 
+  /**
+   * Time Complexity: O(n)
+   * Space Complexity: O(1)
+   */
+
   /**
    * Time Complexity: O(n)
    * Space Complexity: O(1)
@@ -445,11 +454,6 @@ export abstract class IterableElementBase<E = any, C = any> {
     return;
   }
 
-  /**
-   * Time Complexity: O(n)
-   * Space Complexity: O(1)
-   */
-
   /**
    * Time Complexity: O(n)
    * Space Complexity: O(1)

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

@@ -934,7 +934,7 @@ export class BinaryTree<
 
     if (iterationType === IterationType.RECURSIVE) {
       const dfs = (cur: NODE | null | undefined, min: number, max: number): boolean => {
-        if (!cur) return true;
+        if (!this.isRealNode(cur)) return true;
         const numKey = this.extractor(cur.key);
         if (numKey <= min || numKey >= max) return false;
         return dfs(cur.left, min, numKey) && dfs(cur.right, numKey, max);
@@ -949,14 +949,14 @@ export class BinaryTree<
         let prev = checkMax ? Number.MAX_SAFE_INTEGER : Number.MIN_SAFE_INTEGER;
         // @ts-ignore
         let curr: NODE | null | undefined = beginRoot;
-        while (curr || stack.length > 0) {
-          while (curr) {
+        while (this.isRealNode(curr) || stack.length > 0) {
+          while (this.isRealNode(curr)) {
             stack.push(curr);
             curr = curr.left;
           }
           curr = stack.pop()!;
           const numKey = this.extractor(curr.key);
-          if (!curr || (!checkMax && prev >= numKey) || (checkMax && prev <= numKey)) return false;
+          if (!this.isRealNode(curr) || (!checkMax && prev >= numKey) || (checkMax && prev <= numKey)) return false;
           prev = numKey;
           curr = curr.right;
         }
@@ -1025,7 +1025,7 @@ export class BinaryTree<
 
     if (iterationType === IterationType.RECURSIVE) {
       const _getMaxHeight = (cur: NODE | null | undefined): number => {
-        if (!cur) return -1;
+        if (!this.isRealNode(cur)) return -1;
         const leftHeight = _getMaxHeight(cur.left);
         const rightHeight = _getMaxHeight(cur.right);
         return Math.max(leftHeight, rightHeight) + 1;
@@ -1039,8 +1039,8 @@ export class BinaryTree<
       while (stack.length > 0) {
         const { node, depth } = stack.pop()!;
 
-        if (node.left) stack.push({ node: node.left, depth: depth + 1 });
-        if (node.right) stack.push({ node: node.right, depth: depth + 1 });
+        if (this.isRealNode(node.left)) stack.push({ node: node.left, depth: depth + 1 });
+        if (this.isRealNode(node.right)) stack.push({ node: node.right, depth: depth + 1 });
 
         maxHeight = Math.max(maxHeight, depth);
       }
@@ -1354,34 +1354,34 @@ export class BinaryTree<
         switch (pattern) {
           case 'in':
             if (includeNull) {
-              if (node && this.isNodeOrNull(node.left)) _traverse(node.left);
+              if (this.isRealNode(node) && this.isNodeOrNull(node.left)) _traverse(node.left);
               this.isNodeOrNull(node) && ans.push(callback(node));
-              if (node && this.isNodeOrNull(node.right)) _traverse(node.right);
+              if (this.isRealNode(node) && this.isNodeOrNull(node.right)) _traverse(node.right);
             } else {
-              if (node && node.left) _traverse(node.left);
+              if (this.isRealNode(node) && this.isRealNode(node.left)) _traverse(node.left);
               this.isRealNode(node) && ans.push(callback(node));
-              if (node && node.right) _traverse(node.right);
+              if (this.isRealNode(node) && this.isRealNode(node.right)) _traverse(node.right);
             }
             break;
           case 'pre':
             if (includeNull) {
               this.isNodeOrNull(node) && ans.push(callback(node));
-              if (node && this.isNodeOrNull(node.left)) _traverse(node.left);
-              if (node && this.isNodeOrNull(node.right)) _traverse(node.right);
+              if (this.isRealNode(node) && this.isNodeOrNull(node.left)) _traverse(node.left);
+              if (this.isRealNode(node) && this.isNodeOrNull(node.right)) _traverse(node.right);
             } else {
               this.isRealNode(node) && ans.push(callback(node));
-              if (node && node.left) _traverse(node.left);
-              if (node && node.right) _traverse(node.right);
+              if (this.isRealNode(node) && this.isRealNode(node.left)) _traverse(node.left);
+              if (this.isRealNode(node) && this.isRealNode(node.right)) _traverse(node.right);
             }
             break;
           case 'post':
             if (includeNull) {
-              if (node && this.isNodeOrNull(node.left)) _traverse(node.left);
-              if (node && this.isNodeOrNull(node.right)) _traverse(node.right);
+              if (this.isRealNode(node) && this.isNodeOrNull(node.left)) _traverse(node.left);
+              if (this.isRealNode(node) && this.isNodeOrNull(node.right)) _traverse(node.right);
               this.isNodeOrNull(node) && ans.push(callback(node));
             } else {
-              if (node && node.left) _traverse(node.left);
-              if (node && node.right) _traverse(node.right);
+              if (this.isRealNode(node) && this.isRealNode(node.left)) _traverse(node.left);
+              if (this.isRealNode(node) && this.isRealNode(node.right)) _traverse(node.right);
               this.isRealNode(node) && ans.push(callback(node));
             }