linked-list-typed 1.48.1 → 1.48.3

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

@@ -7,8 +7,9 @@
  */
 
 
-import { IterableWithSizeOrLength } from "../../types";
+import { ElementCallback, IterableWithSizeOrLength } from "../../types";
 import { calcMinUnitsRequired, rangeCheck } from "../../utils";
+import { IterableElementBase } from "../base";
 
 /**
  * Deque can provide random access with O(1) time complexity
@@ -17,7 +18,7 @@ import { calcMinUnitsRequired, rangeCheck } from "../../utils";
  * Deque is implemented using a dynamic array. Inserting or deleting beyond both ends of the array may require moving elements or reallocating space.
  */
 
-export class Deque<E> {
+export class Deque<E> extends IterableElementBase<E> {
   protected _bucketFirst = 0;
   protected _firstInBucket = 0;
   protected _bucketLast = 0;
@@ -35,7 +36,7 @@ export class Deque<E> {
    * stored in each bucket. It determines the size of each bucket in the data structure.
    */
   constructor(elements: IterableWithSizeOrLength<E> = [], bucketSize = (1 << 12)) {
-
+    super();
     let _size: number;
     if ('length' in elements) {
       if (elements.length instanceof Function) _size = elements.length(); else _size = elements.length;
@@ -699,67 +700,31 @@ export class Deque<E> {
     return arr;
   }
 
-  /**
-   * Time Complexity: O(n)
-   * Space Complexity: O(1)
-   */
-
-  /**
-   * Time Complexity: O(n)
-   * Space Complexity: O(1)
-   *
-   * The above function is an implementation of the iterator protocol in TypeScript, allowing the
-   * object to be iterated over using a for...of loop.
-   */
-  * [Symbol.iterator]() {
-    for (let i = 0; i < this.size; ++i) {
-      yield this.getAt(i);
-    }
-  }
-
-  /**
-   * Time Complexity: O(n)
-   * Space Complexity: O(1)
-   */
-
-  /**
-   * Time Complexity: O(n)
-   * Space Complexity: O(1)
-   *
-   * The `forEach` function iterates over each element in a deque and applies a callback function to
-   * each element.
-   * @param callback - The callback parameter is a function that will be called for each element in the
-   * deque. It takes three parameters:
-   */
-  forEach(callback: (element: E, index: number, deque: this) => void) {
-    let index = 0;
-    for (const el of this) {
-      callback(el, index, this);
-      index++;
-    }
-  }
-
   /**
    * Time Complexity: O(n)
    * Space Complexity: O(n)
    */
-
   /**
    * Time Complexity: O(n)
    * Space Complexity: O(n)
    *
-   * The `filter` function creates a new deque containing only the elements that satisfy the given
-   * predicate function.
-   * @param predicate - The `predicate` parameter is a function that takes three arguments: `element`,
-   * `index`, and `deque`.
-   * @returns The `filter` method is returning a new `Deque` object that contains only the elements
-   * that satisfy the given `predicate` function.
-   */
-  filter(predicate: (element: E, index: number, deque: this) => boolean): Deque<E> {
+   * The `filter` function creates a new deque containing elements from the original deque that satisfy
+   * a given predicate function.
+   * @param predicate - The `predicate` parameter is a callback function that takes three arguments:
+   * the current element being iterated over, the index of the current element, and the deque itself.
+   * It should return a boolean value indicating whether the element should be included in the filtered
+   * deque or not.
+   * @param {any} [thisArg] - The `thisArg` parameter is an optional argument that specifies the value
+   * to be used as `this` when executing the `predicate` function. If `thisArg` is provided, it will be
+   * passed as the `this` value to the `predicate` function. If `thisArg` is
+   * @returns The `filter` method is returning a new `Deque` object that contains the elements that
+   * satisfy the given predicate function.
+   */
+  filter(predicate: ElementCallback<E, boolean>, thisArg?: any): Deque<E> {
     const newDeque = new Deque<E>([], this._bucketSize);
     let index = 0;
     for (const el of this) {
-      if (predicate(el, index, this)) {
+      if (predicate.call(thisArg, el, index, this)) {
         newDeque.push(el);
       }
       index++;
@@ -771,21 +736,24 @@ export class Deque<E> {
    * Time Complexity: O(n)
    * Space Complexity: O(n)
    */
-
   /**
    * Time Complexity: O(n)
    * Space Complexity: O(n)
    *
-   * The `map` function takes a callback function and applies it to each element in the deque,
-   * returning a new deque with the results.
-   * @param callback - The `callback` parameter is a function that takes three arguments:
-   * @returns The `map` method is returning a new `Deque` object with the transformed elements.
-   */
-  map<T>(callback: (element: E, index: number, deque: this) => T): Deque<T> {
+   * The `map` function creates a new Deque by applying a callback function to each element of the
+   * original Deque.
+   * @param callback - The `callback` parameter is a function that will be called for each element in
+   * the deque. It takes three arguments:
+   * @param {any} [thisArg] - The `thisArg` parameter is an optional argument that specifies the value
+   * to be used as `this` when executing the `callback` function. If `thisArg` is provided, it will be
+   * passed as the `this` value to the `callback` function. If `thisArg` is
+   * @returns a new Deque object with the mapped values.
+   */
+  map<T>(callback: ElementCallback<E, T>, thisArg?: any): Deque<T> {
     const newDeque = new Deque<T>([], this._bucketSize);
     let index = 0;
     for (const el of this) {
-      newDeque.push(callback(el, index, this));
+      newDeque.push(callback.call(thisArg, el, index, this));
       index++;
     }
     return newDeque;
@@ -793,34 +761,24 @@ export class Deque<E> {
 
   /**
    * Time Complexity: O(n)
-   * Space Complexity: O(1)
+   * Space Complexity: O(n)
    */
 
+  print(): void {
+    console.log([...this])
+  }
+
   /**
    * Time Complexity: O(n)
    * Space Complexity: O(1)
    *
-   * The `reduce` function iterates over the elements of a deque and applies a callback function to
-   * each element, accumulating a single value.
-   * @param callback - The `callback` parameter is a function that takes four arguments:
-   * @param {T} initialValue - The `initialValue` parameter is the initial value of the accumulator. It
-   * is the value that will be passed as the first argument to the `callback` function when reducing
-   * the elements of the deque.
-   * @returns the final value of the accumulator after iterating over all elements in the deque and
-   * applying the callback function to each element.
-   */
-  reduce<T>(callback: (accumulator: T, element: E, index: number, deque: this) => T, initialValue: T): T {
-    let accumulator = initialValue;
-    let index = 0;
-    for (const el of this) {
-      accumulator = callback(accumulator, el, index, this);
-      index++;
+   * The above function is an implementation of the iterator protocol in TypeScript, allowing the
+   * object to be iterated over using a for...of loop.
+   */
+  protected* _getIterator() {
+    for (let i = 0; i < this.size; ++i) {
+      yield this.getAt(i);
     }
-    return accumulator;
-  }
-
-  print(): void {
-    console.log([...this])
   }
 
   /**

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

@@ -4,42 +4,10 @@
  * @class
  */
 import { SinglyLinkedList } from '../linked-list';
+import { IterableElementBase } from "../base";
+import { ElementCallback } from "../../types";
 
-export class LinkedListQueue<E = any> extends SinglyLinkedList<E> {
-  /**
-   * 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) {
-    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(): E | undefined {
-    return this.shift();
-  }
-
-  /**
-   * The `getFirst` function returns the value of the head node in a linked list, or `undefined` if the list is empty.
-   * @returns The `getFirst()` method is returning the value of the `head` node if it exists, otherwise it returns `undefined`.
-   */
-  getFirst(): E | undefined {
-    return this.head?.value;
-  }
-
-  /**
-   * 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 {
-    return this.getFirst();
-  }
-}
-
-export class Queue<E = any> {
+export class Queue<E = any> extends IterableElementBase<E> {
   /**
    * The constructor initializes an instance of a class with an optional array of elements and sets the offset to 0.
    * @param {E[]} [elements] - The `elements` parameter is an optional array of elements of type `E`. If provided, it
@@ -47,6 +15,7 @@ export class Queue<E = any> {
    * initialized as an empty array.
    */
   constructor(elements?: E[]) {
+    super();
     this._nodes = elements || [];
     this._offset = 0;
   }
@@ -304,34 +273,6 @@ export class Queue<E = any> {
     console.log([...this]);
   }
 
-  * [Symbol.iterator]() {
-    for (const item of this.nodes) {
-      yield item;
-    }
-  }
-
-  /**
-   * Time Complexity: O(n)
-   * Space Complexity: O(1)
-   */
-
-  /**
-   * Time Complexity: O(n)
-   * Space Complexity: O(1)
-   *
-   * The `forEach` function iterates over each element in a deque and applies a callback function to
-   * each element.
-   * @param callback - The callback parameter is a function that will be called for each element in the
-   * deque. It takes three parameters:
-   */
-  forEach(callback: (element: E, index: number, queue: this) => void) {
-    let index = 0;
-    for (const el of this) {
-      callback(el, index, this);
-      index++;
-    }
-  }
-
   /**
    * Time Complexity: O(n)
    * Space Complexity: O(n)
@@ -341,18 +282,23 @@ export class Queue<E = any> {
    * Time Complexity: O(n)
    * Space Complexity: O(n)
    *
-   * The `filter` function creates a new deque containing only the elements that satisfy the given
-   * predicate function.
-   * @param predicate - The `predicate` parameter is a function that takes three arguments: `element`,
-   * `index`, and `deque`.
-   * @returns The `filter` method is returning a new `Queue` object that contains only the elements
-   * that satisfy the given `predicate` function.
-   */
-  filter(predicate: (element: E, index: number, queue: this) => boolean): Queue<E> {
+   * The `filter` function creates a new `Queue` object containing elements from the original `Queue`
+   * that satisfy a given predicate function.
+   * @param predicate - The `predicate` parameter is a callback function that takes three arguments:
+   * the current element being iterated over, the index of the current element, and the queue itself.
+   * It should return a boolean value indicating whether the element should be included in the filtered
+   * queue or not.
+   * @param {any} [thisArg] - The `thisArg` parameter is an optional argument that specifies the value
+   * to be used as `this` when executing the `predicate` function. If `thisArg` is provided, it will be
+   * passed as the `this` value to the `predicate` function. If `thisArg` is
+   * @returns The `filter` method is returning a new `Queue` object that contains the elements that
+   * satisfy the given predicate function.
+   */
+  filter(predicate: ElementCallback<E, boolean>, thisArg?: any): Queue<E> {
     const newDeque = new Queue<E>([]);
     let index = 0;
     for (const el of this) {
-      if (predicate(el, index, this)) {
+      if (predicate.call(thisArg, el, index, this)) {
         newDeque.push(el);
       }
       index++;
@@ -364,33 +310,72 @@ export class Queue<E = any> {
    * Time Complexity: O(n)
    * Space Complexity: O(n)
    */
-
   /**
    * Time Complexity: O(n)
    * Space Complexity: O(n)
    *
-   * The `map` function takes a callback function and applies it to each element in the deque,
-   * returning a new deque with the results.
-   * @param callback - The `callback` parameter is a function that takes three arguments:
-   * @returns The `map` method is returning a new `Queue` object with the transformed elements.
-   */
-  map<T>(callback: (element: E, index: number, queue: this) => T): Queue<T> {
+   * The `map` function takes a callback function and applies it to each element in the queue,
+   * returning a new queue with the results.
+   * @param callback - The callback parameter is a function that will be called for each element in the
+   * queue. It takes three arguments: the current element, the index of the current element, and the
+   * queue itself. The callback function should return a new value that will be added to the new queue.
+   * @param {any} [thisArg] - The `thisArg` parameter is an optional argument that specifies the value
+   * to be used as `this` when executing the `callback` function. If `thisArg` is provided, it will be
+   * passed as the `this` value to the `callback` function. If `thisArg` is
+   * @returns The `map` function is returning a new `Queue` object with the transformed elements.
+   */
+  map<T>(callback: ElementCallback<E, T>, thisArg?: any): Queue<T> {
     const newDeque = new Queue<T>([]);
     let index = 0;
     for (const el of this) {
-      newDeque.push(callback(el, index, this));
+      newDeque.push(callback.call(thisArg, el, index, this));
       index++;
     }
     return newDeque;
   }
 
-  reduce<T>(callback: (accumulator: T, element: E, index: number, queue: this) => T, initialValue: T): T {
-    let accumulator = initialValue;
-    let index = 0;
-    for (const el of this) {
-      accumulator = callback(accumulator, el, index, this);
-      index++;
+  /**
+   * Time Complexity: O(n)
+   * Space Complexity: O(n)
+   */
+
+  protected* _getIterator() {
+    for (const item of this.nodes) {
+      yield item;
     }
-    return accumulator;
   }
 }
+
+export class LinkedListQueue<E = any> extends SinglyLinkedList<E> {
+  /**
+   * 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) {
+    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(): E | undefined {
+    return this.shift();
+  }
+
+  /**
+   * The `getFirst` function returns the value of the head node in a linked list, or `undefined` if the list is empty.
+   * @returns The `getFirst()` method is returning the value of the `head` node if it exists, otherwise it returns `undefined`.
+   */
+  getFirst(): E | undefined {
+    return this.head?.value;
+  }
+
+  /**
+   * 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 {
+    return this.getFirst();
+  }
+}

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

@@ -1,9 +1,12 @@
+import { IterableElementBase } from "../base";
+import { ElementCallback } from "../../types";
+
 /**
  * @license MIT
  * @copyright Tyler Zeng <zrwusa@gmail.com>
  * @class
  */
-export class Stack<E = any> {
+export class Stack<E = any> extends IterableElementBase<E> {
   /**
    * The constructor initializes an array of elements, which can be provided as an optional parameter.
    * @param {E[]} [elements] - The `elements` parameter is an optional parameter of type `E[]`, which represents an array
@@ -11,6 +14,7 @@ export class Stack<E = any> {
    * is provided and is an array, it is assigned to the `_elements
    */
   constructor(elements?: Iterable<E>) {
+    super();
     this._elements = [];
     if (elements) {
       for (const el of elements) {
@@ -154,33 +158,31 @@ export class Stack<E = any> {
   }
 
   /**
-   * Custom iterator for the Stack class.
-   * @returns An iterator object.
+   * Time Complexity: O(n)
+   * Space Complexity: O(n)
    */
-  * [Symbol.iterator]() {
-    for (let i = 0; i < this.elements.length; i++) {
-      yield this.elements[i];
-    }
-  }
 
   /**
-   * Applies a function to each element of the stack.
-   * @param {function(E): void} callback - A function to apply to each element.
-   */
-  forEach(callback: (element: E, index: number, stack: this) => void): void {
-    let index = 0;
-    for (const el of this) {
-      callback(el, index, this);
-      index++;
-    }
-  }
-
-
-  filter(predicate: (element: E, index: number, stack: this) => boolean): Stack<E> {
+   * Time Complexity: O(n)
+   * Space Complexity: O(n)
+   *
+   * The `filter` function creates a new stack containing elements from the original stack that satisfy
+   * a given predicate function.
+   * @param predicate - The `predicate` parameter is a callback function that takes three arguments:
+   * the current element being iterated over, the index of the current element, and the stack itself.
+   * It should return a boolean value indicating whether the element should be included in the filtered
+   * stack or not.
+   * @param {any} [thisArg] - The `thisArg` parameter is an optional argument that specifies the value
+   * to be used as `this` when executing the `predicate` function. If `thisArg` is provided, it will be
+   * passed as the `this` value to the `predicate` function. If `thisArg` is
+   * @returns The `filter` method is returning a new `Stack` object that contains the elements that
+   * satisfy the given predicate function.
+   */
+  filter(predicate: ElementCallback<E, boolean>, thisArg?: any): Stack<E> {
     const newStack = new Stack<E>();
     let index = 0;
     for (const el of this) {
-      if (predicate(el, index, this)) {
+      if (predicate.call(thisArg, el, index, this)) {
         newStack.push(el);
       }
       index++;
@@ -188,28 +190,45 @@ export class Stack<E = any> {
     return newStack;
   }
 
+  /**
+   * Time Complexity: O(n)
+   * Space Complexity: O(n)
+   */
 
-  map<T>(callback: (element: E, index: number, stack: this) => T): Stack<T> {
+  /**
+   * Time Complexity: O(n)
+   * Space Complexity: O(n)
+   *
+   * The `map` function takes a callback function and applies it to each element in the stack,
+   * returning a new stack with the results.
+   * @param callback - The `callback` parameter is a function that will be called for each element in
+   * the stack. It takes three arguments:
+   * @param {any} [thisArg] - The `thisArg` parameter is an optional argument that specifies the value
+   * to be used as `this` when executing the `callback` function. If `thisArg` is provided, it will be
+   * passed as the `this` value to the `callback` function. If `thisArg` is
+   * @returns The `map` method is returning a new `Stack` object.
+   */
+  map<T>(callback: ElementCallback<E, T>, thisArg?: any): Stack<T> {
     const newStack = new Stack<T>();
     let index = 0;
     for (const el of this) {
-      newStack.push(callback(el, index, this));
+      newStack.push(callback.call(thisArg, el, index, this));
       index++;
     }
     return newStack;
   }
 
-  reduce<T>(callback: (accumulator: T, element: E, index: number, stack: this) => T, initialValue: T): T {
-    let accumulator = initialValue;
-    let index = 0;
-    for (const el of this) {
-      accumulator = callback(accumulator, el, index, this);
-      index++;
-    }
-    return accumulator;
-  }
-
   print(): void {
     console.log([...this]);
   }
+
+  /**
+   * Custom iterator for the Stack class.
+   * @returns An iterator object.
+   */
+  protected* _getIterator() {
+    for (let i = 0; i < this.elements.length; i++) {
+      yield this.elements[i];
+    }
+  }
 }

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

@@ -6,6 +6,9 @@
  * @license MIT License
  */
 
+import { IterableElementBase } from "../base";
+import { ElementCallback } from "../../types";
+
 /**
  * TrieNode represents a node in the Trie data structure. It holds a character key, a map of children nodes,
  * and a flag indicating whether it's the end of a word.
@@ -25,8 +28,9 @@ export class TrieNode {
 /**
  * Trie represents a Trie data structure. It provides basic Trie operations and additional methods.
  */
-export class Trie {
+export class Trie extends IterableElementBase<string> {
   constructor(words?: string[], caseSensitive = true) {
+    super();
     this._root = new TrieNode('');
     this._caseSensitive = caseSensitive;
     this._size = 0;
@@ -339,32 +343,30 @@ export class Trie {
     return words;
   }
 
-  * [Symbol.iterator](): IterableIterator<string> {
-    function* _dfs(node: TrieNode, path: string): IterableIterator<string> {
-      if (node.isEnd) {
-        yield path;
-      }
-      for (const [char, childNode] of node.children) {
-        yield* _dfs(childNode, path + char);
-      }
-    }
-
-    yield* _dfs(this.root, '');
-  }
-
-  forEach(callback: (word: string, index: number, trie: this) => void): void {
-    let index = 0;
-    for (const word of this) {
-      callback(word, index, this);
-      index++;
-    }
-  }
+  /**
+   * Time Complexity: O(n)
+   * Space Complexity: O(n)
+   */
 
-  filter(predicate: (word: string, index: number, trie: this) => boolean): string[] {
+  /**
+   * Time Complexity: O(n)
+   * Space Complexity: O(n)
+   *
+   * The `filter` function takes a predicate function and returns a new array containing all the
+   * elements for which the predicate function returns true.
+   * @param predicate - The `predicate` parameter is a callback function that takes three arguments:
+   * `word`, `index`, and `this`. It should return a boolean value indicating whether the current
+   * element should be included in the filtered results or not.
+   * @param {any} [thisArg] - The `thisArg` parameter is an optional argument that allows you to
+   * specify the value of `this` within the `predicate` function. It is used when you want to bind a
+   * specific object as the context for the `predicate` function. If `thisArg` is provided, it will be
+   * @returns The `filter` method is returning an array of strings (`string[]`).
+   */
+  filter(predicate: ElementCallback<string, boolean>, thisArg?: any): string[] {
     const results: string[] = [];
     let index = 0;
     for (const word of this) {
-      if (predicate(word, index, this)) {
+      if (predicate.call(thisArg, word, index, this)) {
         results.push(word);
       }
       index++;
@@ -372,30 +374,51 @@ export class Trie {
     return results;
   }
 
-  map(callback: (word: string, index: number, trie: this) => string): Trie {
+  /**
+   * Time Complexity: O(n)
+   * Space Complexity: O(n)
+   */
+
+  /**
+   * Time Complexity: O(n)
+   * Space Complexity: O(n)
+   *
+   * The `map` function creates a new Trie by applying a callback function to each element in the Trie.
+   * @param callback - The callback parameter is a function that will be called for each element in the
+   * Trie. It takes three arguments: the current element in the Trie, the index of the current element,
+   * and the Trie itself. The callback function should return a new value for the element.
+   * @param {any} [thisArg] - The `thisArg` parameter is an optional argument that specifies the value
+   * to be used as `this` when executing the `callback` function. If `thisArg` is provided, it will be
+   * passed as the `this` value to the `callback` function. If `thisArg` is
+   * @returns The `map` function is returning a new Trie object.
+   */
+  map(callback: ElementCallback<string, string>, thisArg?: any): Trie {
     const newTrie = new Trie();
     let index = 0;
     for (const word of this) {
-      newTrie.add(callback(word, index, this));
+      newTrie.add(callback.call(thisArg, word, index, this));
       index++;
     }
     return newTrie;
   }
 
-  reduce<T>(callback: (accumulator: T, word: string, index: number, trie: this) => T, initialValue: T): T {
-    let accumulator = initialValue;
-    let index = 0;
-    for (const word of this) {
-      accumulator = callback(accumulator, word, index, this);
-      index++;
-    }
-    return accumulator;
-  }
-
   print() {
     console.log([...this]);
   }
 
+  protected* _getIterator(): IterableIterator<string> {
+    function* _dfs(node: TrieNode, path: string): IterableIterator<string> {
+      if (node.isEnd) {
+        yield path;
+      }
+      for (const [char, childNode] of node.children) {
+        yield* _dfs(childNode, path + char);
+      }
+    }
+
+    yield* _dfs(this.root, '');
+  }
+
   /**
    * Time Complexity: O(M), where M is the length of the input string.
    * Space Complexity: O(1) - Constant space.