min-heap-typed 1.39.1 → 1.39.3

package/src/data-structures/linked-list/singly-linked-list.ts

@@ -87,17 +87,13 @@ export class SinglyLinkedList<E = any> {
     return singlyLinkedList;
   }
 
-  getLength(): number {
-    return this._length;
-  }
-
   /**
-   * The `push` function adds a new node with the given data to the end of a singly linked list.
-   * @param {E} data - The "data" parameter represents the value that you want to add to the linked list. It can be of
+   * The `push` function adds a new node with the given val to the end of a singly linked list.
+   * @param {E} val - The "val" 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.
    */
-  push(data: E): void {
-    const newNode = new SinglyLinkedListNode(data);
+  push(val: E): void {
+    const newNode = new SinglyLinkedListNode(val);
     if (!this.head) {
       this.head = newNode;
       this.tail = newNode;
@@ -108,6 +104,15 @@ export class SinglyLinkedList<E = any> {
     this._length++;
   }
 
+  /**
+   * The `push` function adds a new node with the given val to the end of a singly linked list.
+   * @param {E} val - The "val" 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(val: E): void {
+    this.push(val);
+  }
+
   /**
    * The `pop()` function removes and returns the value of the last element in a linked list, updating the head and tail
    * pointers accordingly.
@@ -135,6 +140,16 @@ export class SinglyLinkedList<E = any> {
     return val;
   }
 
+  /**
+   * The `popLast()` 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 `null`.
+   */
+  popLast(): E | undefined {
+    return this.pop();
+  }
+
   /**
    * 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.
@@ -147,6 +162,14 @@ export class SinglyLinkedList<E = any> {
     return removedNode.val;
   }
 
+  /**
+   * The `popFirst()` 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.
+   */
+  popFirst(): E | undefined {
+    return this.shift();
+  }
+
   /**
    * The unshift function adds a new node with the given value to the beginning of a singly linked list.
    * @param {E} val - The parameter "val" represents the value of the new node that will be added to the beginning of the
@@ -164,6 +187,15 @@ export class SinglyLinkedList<E = any> {
     this._length++;
   }
 
+  /**
+   * The addFirst function adds a new node with the given value to the beginning of a singly linked list.
+   * @param {E} val - The parameter "val" represents the value of the new node that will be added to the beginning of the
+   * linked list.
+   */
+  addFirst(val: E): void {
+    this.unshift(val);
+  }
+
   /**
    * The function `getAt` returns the value at a specified index in a linked list, or null if the index is out of range.
    * @param {number} index - The index parameter is a number that represents the position of the element we want to
@@ -382,7 +414,7 @@ export class SinglyLinkedList<E = any> {
    * @returns a `SinglyLinkedListNode<E>` if a node with the specified value is found in the linked list. If no node with
    * the specified value is found, the function returns `null`.
    */
-  findNode(value: E): SinglyLinkedListNode<E> | null {
+  getNode(value: E): SinglyLinkedListNode<E> | null {
     let current = this.head;
 
     while (current) {
@@ -432,9 +464,6 @@ export class SinglyLinkedList<E = any> {
     return false;
   }
 
-  insertAfter(existingValueOrNode: E, newValue: E): boolean;
-  insertAfter(existingValueOrNode: SinglyLinkedListNode<E>, newValue: E): boolean;
-
   /**
    * The `insertAfter` function inserts a new node with a given value after an existing node in a singly linked list.
    * @param {E | SinglyLinkedListNode<E>} existingValueOrNode - The existing value or node in the linked list after which
@@ -449,7 +478,7 @@ export class SinglyLinkedList<E = any> {
     if (existingValueOrNode instanceof SinglyLinkedListNode) {
       existingNode = existingValueOrNode;
     } else {
-      existingNode = this.findNode(existingValueOrNode);
+      existingNode = this.getNode(existingValueOrNode);
     }
 
     if (existingNode) {
@@ -485,6 +514,82 @@ export class SinglyLinkedList<E = any> {
     return count;
   }
 
+  /**
+   * The `forEach` function iterates over each element in a linked list and applies a callback function to each element.
+   * @param callback - The callback parameter is a function that takes two arguments: val and index. The val argument
+   * represents the value of the current node in the linked list, and the index argument represents the index of the
+   * current node in the linked list.
+   */
+  forEach(callback: (val: E, index: number) => void): void {
+    let current = this.head;
+    let index = 0;
+    while (current) {
+      callback(current.val, index);
+      current = current.next;
+      index++;
+    }
+  }
+
+  /**
+   * The `map` function takes a callback function and applies it to each element in the SinglyLinkedList, returning a new
+   * SinglyLinkedList with the transformed values.
+   * @param callback - The callback parameter is a function that takes a value of type E (the type of values stored in
+   * the original SinglyLinkedList) and returns a value of type U (the type of values that will be stored in the mapped
+   * SinglyLinkedList).
+   * @returns The `map` function is returning a new instance of `SinglyLinkedList<U>` that contains the mapped values.
+   */
+  map<U>(callback: (val: E) => U): SinglyLinkedList<U> {
+    const mappedList = new SinglyLinkedList<U>();
+    let current = this.head;
+    while (current) {
+      mappedList.push(callback(current.val));
+      current = current.next;
+    }
+    return mappedList;
+  }
+
+  /**
+   * The `filter` function iterates through a SinglyLinkedList and returns a new SinglyLinkedList containing only the
+   * elements that satisfy the given callback function.
+   * @param callback - The `callback` parameter is a function that takes a value of type `E` and returns a boolean value.
+   * It is used to determine whether a value should be included in the filtered list or not.
+   * @returns The filtered list, which is an instance of the SinglyLinkedList class.
+   */
+  filter(callback: (val: E) => boolean): SinglyLinkedList<E> {
+    const filteredList = new SinglyLinkedList<E>();
+    let current = this.head;
+    while (current) {
+      if (callback(current.val)) {
+        filteredList.push(current.val);
+      }
+      current = current.next;
+    }
+    return filteredList;
+  }
+
+  /**
+   * The `reduce` function iterates over a linked list and applies a callback function to each element, accumulating a
+   * single value.
+   * @param callback - The `callback` parameter is a function that takes two arguments: `accumulator` and `val`. It is
+   * used to perform a specific operation on each element of the linked list.
+   * @param {U} initialValue - The `initialValue` parameter is the initial value of the accumulator. It is the starting
+   * point for the reduction operation.
+   * @returns The `reduce` method is returning the final value of the accumulator after iterating through all the
+   * elements in the linked list.
+   */
+  reduce<U>(callback: (accumulator: U, val: E) => U, initialValue: U): U {
+    let accumulator = initialValue;
+    let current = this.head;
+    while (current) {
+      accumulator = callback(accumulator, current.val);
+      current = current.next;
+    }
+    return accumulator;
+  }
+
+  /**
+   * The function returns an iterator that iterates over the values of a linked list.
+   */
   *[Symbol.iterator]() {
     let current = this.head;
 

package/src/data-structures/queue/deque.ts

@@ -95,12 +95,12 @@ export class ObjectDeque<E = number> {
   }
 
   /**
-   * The function `pollFirst()` removes and returns the first element in a data structure.
+   * The function `popFirst()` removes and returns the first element in a data structure.
    * @returns The value of the first element in the data structure.
    */
-  pollFirst() {
+  popFirst() {
     if (!this._size) return;
-    const value = this.peekFirst();
+    const value = this.getFirst();
     delete this._nodes[this._first];
     this._first++;
     this._size--;
@@ -108,20 +108,20 @@ export class ObjectDeque<E = number> {
   }
 
   /**
-   * The `peekFirst` function returns the first element in an array-like data structure if it exists.
+   * The `getFirst` function returns the first element in an array-like data structure if it exists.
    * @returns The element at the first position of the `_nodes` array.
    */
-  peekFirst() {
+  getFirst() {
     if (this._size) return this._nodes[this._first];
   }
 
   /**
-   * The `pollLast()` function removes and returns the last element in a data structure.
+   * The `popLast()` function removes and returns the last element in a data structure.
    * @returns The value that was removed from the data structure.
    */
-  pollLast() {
+  popLast() {
     if (!this._size) return;
-    const value = this.peekLast();
+    const value = this.getLast();
     delete this._nodes[this._last];
     this._last--;
     this._size--;
@@ -130,10 +130,10 @@ export class ObjectDeque<E = number> {
   }
 
   /**
-   * The `peekLast()` function returns the last element in an array-like data structure.
+   * The `getLast()` function returns the last element in an array-like data structure.
    * @returns The last element in the array "_nodes" is being returned.
    */
-  peekLast() {
+  getLast() {
     if (this._size) return this._nodes[this._last];
   }
 
@@ -188,19 +188,19 @@ export class ArrayDeque<E> {
   }
 
   /**
-   * The function "pollLast" returns and removes the last element from an array, or returns null if the array is empty.
-   * @returns The method `pollLast()` returns the last element of the `_nodes` array, or `null` if the array is empty.
+   * The function "popLast" returns and removes the last element from an array, or returns null if the array is empty.
+   * @returns The method `popLast()` returns the last element of the `_nodes` array, or `null` if the array is empty.
    */
-  pollLast(): E | null {
+  popLast(): E | null {
     return this._nodes.pop() ?? null;
   }
 
   /**
-   * The `pollFirst` function removes and returns the first element from an array, or returns null if the array is empty.
-   * @returns The `pollFirst()` function returns the first element of the `_nodes` array, or `null` if the array is
+   * The `popFirst` function removes and returns the first element from an array, or returns null if the array is empty.
+   * @returns The `popFirst()` function returns the first element of the `_nodes` array, or `null` if the array is
    * empty.
    */
-  pollFirst(): E | null {
+  popFirst(): E | null {
     return this._nodes.shift() ?? null;
   }
 
@@ -219,19 +219,19 @@ export class ArrayDeque<E> {
   }
 
   /**
-   * The `peekFirst` function returns the first element of an array or null if the array is empty.
-   * @returns The function `peekFirst()` is returning the first element (`E`) of the `_nodes` array. If the array is
+   * The `getFirst` function returns the first element of an array or null if the array is empty.
+   * @returns The function `getFirst()` is returning the first element (`E`) of the `_nodes` array. If the array is
    * empty, it will return `null`.
    */
-  peekFirst(): E | null {
+  getFirst(): E | null {
     return this._nodes[0] ?? null;
   }
 
   /**
-   * The `peekLast` function returns the last element of an array or null if the array is empty.
-   * @returns The method `peekLast()` returns the last element of the `_nodes` array, or `null` if the array is empty.
+   * The `getLast` function returns the last element of an array or null if the array is empty.
+   * @returns The method `getLast()` returns the last element of the `_nodes` array, or `null` if the array is empty.
    */
-  peekLast(): E | null {
+  getLast(): E | null {
     return this._nodes[this._nodes.length - 1] ?? null;
   }
 

package/src/data-structures/queue/queue.ts

@@ -123,11 +123,11 @@ export class Queue<E = any> {
   }
 
   /**
-   * The `peekLast` function returns the last element in an array-like data structure, or null if the structure is empty.
-   * @returns The method `peekLast()` returns the last element of the `_nodes` array if the array is not empty. If the
+   * The `getLast` function returns the last element in an array-like data structure, or null if the structure is empty.
+   * @returns The method `getLast()` returns the last element of the `_nodes` array if the array is not empty. If the
    * array is empty, it returns `null`.
    */
-  peekLast(): E | undefined {
+  getLast(): E | undefined {
     return this.size > 0 ? this.nodes[this.nodes.length - 1] : undefined;
   }
 

package/src/interfaces/binary-tree.ts

@@ -1,10 +1,10 @@
 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;
+  createNode(key: BTNKey, val?: N['val']): N;
 
-  add(keyOrNode: BinaryTreeNodeKey | N | null, val?: N['val']): N | null | undefined;
+  add(keyOrNode: BTNKey | N | null, val?: N['val']): N | null | undefined;
 
-  delete<C extends OneParamCallback<N>>(identifier: ReturnType<C> | null, callback: C): BinaryTreeDeletedResult<N>[];
+  delete<C extends BTNCallback<N>>(identifier: ReturnType<C> | null, callback: C): BinaryTreeDeletedResult<N>[];
 }

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

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

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

@@ -1,7 +1,7 @@
 import {BSTNode} from '../../../data-structures';
-import type {BinaryTreeNodeKey, BinaryTreeOptions} from './binary-tree';
+import type {BTNKey, BinaryTreeOptions} from './binary-tree';
 
-export type BSTComparator = (a: BinaryTreeNodeKey, b: BinaryTreeNodeKey) => number;
+export type BSTComparator = (a: BTNKey, b: BTNKey) => number;
 
 // prettier-ignore
 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>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>

package/src/types/helpers.ts

@@ -2,7 +2,7 @@ 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 enum CP {
   lt = 'lt',