directed-graph-typed 1.48.0 → 1.49.0

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

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SinglyLinkedList = exports.SinglyLinkedListNode = void 0;
+const base_1 = require("../base");
 /**
  * data-structure-typed
  *
@@ -20,11 +21,12 @@ class SinglyLinkedListNode {
     }
 }
 exports.SinglyLinkedListNode = SinglyLinkedListNode;
-class SinglyLinkedList {
+class SinglyLinkedList extends base_1.IterableElementBase {
     /**
      * The constructor initializes the linked list with an empty head, tail, and length.
      */
     constructor(elements) {
+        super();
         this._head = undefined;
         this._tail = undefined;
         this._length = 0;
@@ -142,12 +144,12 @@ class SinglyLinkedList {
      * Time Complexity: O(n) - Linear time in the worst case, as it may need to traverse the list to find the last element.
      * Space Complexity: O(1) - Constant space.
      *
-     * The `popLast()` function removes and returns the value of the last element in a linked list, updating the head and tail
+     * 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`.
      */
-    popLast() {
+    pollLast() {
         return this.pop();
     }
     /**
@@ -177,10 +179,10 @@ class SinglyLinkedList {
      * Time Complexity: O(1) - Constant time, as it involves adjusting pointers at the head.
      * Space Complexity: O(1) - Constant space.
      *
-     * The `popFirst()` function removes and returns the value of the first node in a linked list.
+     * 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.
      */
-    popFirst() {
+    pollFirst() {
         return this.shift();
     }
     /**
@@ -609,54 +611,31 @@ class SinglyLinkedList {
         return count;
     }
     /**
-     * The function returns an iterator that iterates over the values of a linked list.
-     */
-    *[Symbol.iterator]() {
-        let current = this.head;
-        while (current) {
-            yield current.value;
-            current = current.next;
-        }
-    }
-    /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
-     * Space Complexity: O(1)
-     */
-    /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
-     * Space Complexity: O(1)
-     *
-     * 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: value and index. The value 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) {
-        let index = 0;
-        for (const el of this) {
-            callback(el, index, this);
-            index++;
-        }
-    }
-    /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(n)
      * Space Complexity: O(n)
      */
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(n)
      * Space Complexity: O(n)
      *
-     * 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) {
+     * The `filter` function creates a new SinglyLinkedList by iterating over the elements of the current
+     * list and applying a callback function to each element to determine if it should be included in the
+     * filtered list.
+     * @param callback - The callback parameter is a function that will be called for each element in the
+     * list. It takes three arguments: the current element, the index of the current element, and the
+     * list itself. The callback function should return a boolean value indicating whether the current
+     * element should be included in the filtered list or not
+     * @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 `filter` method is returning a new `SinglyLinkedList` object that contains the
+     * elements that pass the filter condition specified by the `callback` function.
+     */
+    filter(callback, thisArg) {
         const filteredList = new SinglyLinkedList();
         let index = 0;
         for (const current of this) {
-            if (callback(current, index, this)) {
+            if (callback.call(thisArg, current, index, this)) {
                 filteredList.push(current);
             }
             index++;
@@ -668,21 +647,24 @@ class SinglyLinkedList {
      * Space Complexity: O(n)
      */
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(n)
      * Space Complexity: O(n)
      *
-     * 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 T (the type of values that will be stored in the mapped
-     * SinglyLinkedList).
-     * @returns The `map` function is returning a new instance of `SinglyLinkedList<T>` that contains the mapped values.
-     */
-    map(callback) {
+     * The `map` function creates a new SinglyLinkedList by applying a callback function to each element
+     * of the original list.
+     * @param callback - The `callback` parameter is a function that will be called for each element in
+     * the linked list. 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` function is returning a new `SinglyLinkedList` object that contains the results
+     * of applying the provided `callback` function to each element in the original list.
+     */
+    map(callback, thisArg) {
         const mappedList = new SinglyLinkedList();
         let index = 0;
         for (const current of this) {
-            mappedList.push(callback(current, index, this));
+            mappedList.push(callback.call(thisArg, current, index, this));
             index++;
         }
         return mappedList;
@@ -691,30 +673,15 @@ class SinglyLinkedList {
      * Time Complexity: O(n), where n is the number of elements in the linked list.
      * Space Complexity: O(n)
      */
-    /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
-     * Space Complexity: O(n)
-     *
-     * 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 `value`. It is
-     * used to perform a specific operation on each element of the linked list.
-     * @param {T} 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(callback, initialValue) {
-        let accumulator = initialValue;
-        let index = 0;
-        for (const current of this) {
-            accumulator = callback(accumulator, current, index, this);
-            index++;
-        }
-        return accumulator;
-    }
     print() {
         console.log([...this]);
     }
+    *_getIterator() {
+        let current = this.head;
+        while (current) {
+            yield current.value;
+            current = current.next;
+        }
+    }
 }
 exports.SinglyLinkedList = SinglyLinkedList;

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

@@ -5,14 +5,15 @@
  * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
  * @license MIT License
  */
-import { IterableWithSizeOrLength } from "../../types";
+import { ElementCallback, IterableWithSizeOrLength } from "../../types";
+import { IterableElementBase } from "../base";
 /**
  * Deque can provide random access with O(1) time complexity
  * Deque is usually more compact and efficient in memory usage because it does not require additional space to store pointers.
  * Deque may experience performance jitter, but DoublyLinkedList will not
  * Deque is implemented using a dynamic array. Inserting or deleting beyond both ends of the array may require moving elements or reallocating space.
  */
-export declare class Deque<E> {
+export declare class Deque<E> extends IterableElementBase<E> {
     protected _bucketFirst: number;
     protected _firstInBucket: number;
     protected _bucketLast: number;
@@ -66,10 +67,10 @@ export declare class Deque<E> {
      * Time Complexity: O(1) - Removes the last element.
      * Space Complexity: O(1) - Operates in-place.
      *
-     * The function "popLast" removes and returns the last element of an array.
+     * The function "pollLast" removes and returns the last element of an array.
      * @returns The last element of the array is being returned.
      */
-    popLast(): E | undefined;
+    pollLast(): E | undefined;
     /**
      * Time Complexity: O(1).
      * Space Complexity: O(n) - Due to potential resizing.
@@ -83,11 +84,11 @@ export declare class Deque<E> {
      * Time Complexity: O(1) - Removes the first element.
      * Space Complexity: O(1) - In-place operation.
      *
-     * The function "popFirst" removes and returns the first element of an array.
-     * @returns The method `popFirst()` is returning the first element of the array after removing it
+     * 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`.
      */
-    popFirst(): E | undefined;
+    pollFirst(): E | undefined;
     /**
      * The clear() function resets the state of the object by initializing all variables to their default
      * values.
@@ -354,32 +355,6 @@ export declare class Deque<E> {
      * @returns The `toArray()` method is returning an array of elements of type `E`.
      */
     toArray(): E[];
-    /**
-     * 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](): Generator<E, void, unknown>;
-    /**
-     * 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): void;
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(n)
@@ -388,14 +363,19 @@ export declare class Deque<E> {
      * 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.
+     * 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: (element: E, index: number, deque: this) => boolean): Deque<E>;
+    filter(predicate: ElementCallback<E, boolean>, thisArg?: any): Deque<E>;
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(n)
@@ -404,31 +384,29 @@ export declare class Deque<E> {
      * 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.
+     * 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: (element: E, index: number, deque: this) => T): Deque<T>;
+    map<T>(callback: ElementCallback<E, T>, thisArg?: any): Deque<T>;
     /**
      * Time Complexity: O(n)
-     * Space Complexity: O(1)
+     * Space Complexity: O(n)
      */
+    print(): void;
     /**
      * 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;
-    print(): void;
+     * 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(): Generator<E, void, unknown>;
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(n)
@@ -461,113 +439,3 @@ export declare class Deque<E> {
         indexInBucket: number;
     };
 }
-export declare class ObjectDeque<E = number> {
-    constructor(capacity?: number);
-    protected _nodes: {
-        [key: number]: E;
-    };
-    get nodes(): {
-        [p: number]: E;
-    };
-    protected _capacity: number;
-    get capacity(): number;
-    protected _first: number;
-    get first(): number;
-    protected _last: number;
-    get last(): number;
-    protected _size: number;
-    get size(): number;
-    /**
-     * 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-like data structure.
-     * @param {E} element - The `element` parameter represents the element that you want to add to the beginning of the data
-     * structure.
-     */
-    addFirst(element: E): void;
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     */
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     *
-     * The addLast function adds an element to the end of an array-like data structure.
-     * @param {E} element - The `element` parameter represents the element that you want to add to the end of the data structure.
-     */
-    addLast(element: E): void;
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     */
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     *
-     * The function `popFirst()` removes and returns the first element in a data structure.
-     * @returns The element of the first element in the data structure.
-     */
-    popFirst(): E | undefined;
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     */
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     *
-     * 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.
-     */
-    getFirst(): E | undefined;
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     */
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     *
-     * The `popLast()` function removes and returns the last element in a data structure.
-     * @returns The element that was removed from the data structure.
-     */
-    popLast(): E | undefined;
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     */
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     *
-     * The `getLast()` function returns the last element in an array-like data structure.
-     * @returns The last element in the array "_nodes" is being returned.
-     */
-    getLast(): E | undefined;
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     */
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     *
-     * The get function returns the element at the specified index in an array-like data structure.
-     * @param {number} index - The index parameter is a number that represents the position of the element you want to
-     * retrieve from the array.
-     * @returns The element at the specified index in the `_nodes` array is being returned. If there is no element at that
-     * index, `undefined` is returned.
-     */
-    get(index: number): NonNullable<E> | undefined;
-    /**
-     * The function checks if the size of a data structure is less than or equal to zero.
-     * @returns The method is returning a boolean element indicating whether the size of the object is less than or equal to 0.
-     */
-    isEmpty(): boolean;
-}