data-structure-typed 1.50.4 → 1.50.5

package/dist/mjs/data-structures/linked-list/singly-linked-list.d.ts

@@ -60,6 +60,18 @@ export declare class SinglyLinkedList<E = any> extends IterableElementBase<E> {
      * @returns The method is returning either a SinglyLinkedListNode object or undefined.
      */
     get tail(): SinglyLinkedListNode<E> | undefined;
+    /**
+     * 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(): E | undefined;
+    /**
+     * 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(): E | undefined;
     protected _size: number;
     /**
      * The function returns the size of an object.
@@ -82,21 +94,6 @@ export declare class SinglyLinkedList<E = any> extends IterableElementBase<E> {
      * @returns The `fromArray` function returns a `SinglyLinkedList` object.
      */
     static fromArray<E>(data: E[]): SinglyLinkedList<E>;
-    /**
-     * 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.
-     */
-    push(value: E): boolean;
     /**
      * Time Complexity: O(1)
      * Space Complexity: O(1)
@@ -105,11 +102,12 @@ export declare class SinglyLinkedList<E = any> extends IterableElementBase<E> {
      * 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`.
      */
-    addLast(value: E): boolean;
+    push(element: E): boolean;
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(1)
@@ -119,26 +117,11 @@ export declare class SinglyLinkedList<E = any> extends IterableElementBase<E> {
      * 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(): E | undefined;
-    /**
-     * 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(): E | undefined;
     /**
      * Time Complexity: O(1)
      * Space Complexity: O(1)
@@ -147,8 +130,8 @@ export declare class SinglyLinkedList<E = any> extends IterableElementBase<E> {
      * 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(): E | undefined;
     /**
@@ -159,40 +142,15 @@ export declare class SinglyLinkedList<E = any> extends IterableElementBase<E> {
      * 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(): E | undefined;
-    /**
-     * 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.
-     */
-    unshift(value: E): boolean;
-    /**
-     * 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.
+     * 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`.
      */
-    addFirst(value: E): boolean;
+    unshift(element: E): boolean;
     /**
      * 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/mjs/data-structures/linked-list/singly-linked-list.js

@@ -73,6 +73,22 @@ export class SinglyLinkedList extends 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() {
+        return this.head?.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() {
+        return this.tail?.value;
+    }
     _size = 0;
     /**
      * The function returns the size of an object.
@@ -106,19 +122,18 @@ export class SinglyLinkedList extends 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 +145,6 @@ export class SinglyLinkedList extends 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 +154,9 @@ export class SinglyLinkedList extends 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 +178,6 @@ export class SinglyLinkedList extends 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 +186,8 @@ export class SinglyLinkedList extends 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 +205,13 @@ export class SinglyLinkedList extends 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 +223,9 @@ export class SinglyLinkedList extends 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/mjs/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/mjs/data-structures/queue/deque.js

@@ -764,67 +764,6 @@ export class Deque extends 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/mjs/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/mjs/data-structures/queue/queue.js

@@ -153,64 +153,6 @@ export class Queue extends 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)
@@ -362,34 +304,6 @@ export class Queue extends IterableElementBase {
  * 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 class LinkedListQueue extends 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() {
-        return this.head?.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)