min-heap-typed 1.50.1 → 1.50.3

package/dist/data-structures/linked-list/doubly-linked-list.d.ts

@@ -8,15 +8,51 @@
 import type { ElementCallback } from '../../types';
 import { IterableElementBase } from '../base';
 export declare class DoublyLinkedListNode<E = any> {
-    value: E;
-    next: DoublyLinkedListNode<E> | undefined;
-    prev: DoublyLinkedListNode<E> | undefined;
     /**
      * The constructor function initializes the value, next, and previous properties of an object.
      * @param {E} value - The "value" parameter is the value that will be stored in the node. It can be of any data type, as it
      * is defined as a generic type "E".
      */
     constructor(value: E);
+    protected _value: E;
+    /**
+     * The function returns the value of a protected variable.
+     * @returns The value of the variable `_value` is being returned.
+     */
+    get value(): E;
+    /**
+     * The above function sets the value of a variable.
+     * @param {E} value - The parameter "value" is of type E, which means it can be any type.
+     */
+    set value(value: E);
+    protected _next: DoublyLinkedListNode<E> | undefined;
+    /**
+     * The "next" function returns the next node in a doubly linked list.
+     * @returns The `next` property is being returned. It can be either a `DoublyLinkedListNode<E>`
+     * object or `undefined`.
+     */
+    get next(): DoublyLinkedListNode<E> | undefined;
+    /**
+     * The "next" property of a DoublyLinkedListNode is set to the provided value.
+     * @param {DoublyLinkedListNode<E> | undefined} value - The `value` parameter is of type
+     * `DoublyLinkedListNode<E> | undefined`. This means that it can accept either a
+     * `DoublyLinkedListNode` object or `undefined` as its value.
+     */
+    set next(value: DoublyLinkedListNode<E> | undefined);
+    protected _prev: DoublyLinkedListNode<E> | undefined;
+    /**
+     * The `prev` function returns the previous node in a doubly linked list.
+     * @returns The `prev` property of the `DoublyLinkedListNode` class is being returned. It can either
+     * be a `DoublyLinkedListNode` object or `undefined`.
+     */
+    get prev(): DoublyLinkedListNode<E> | undefined;
+    /**
+     * The function sets the previous node of a doubly linked list node.
+     * @param {DoublyLinkedListNode<E> | undefined} value - The `value` parameter is of type
+     * `DoublyLinkedListNode<E> | undefined`. This means that it can accept either a
+     * `DoublyLinkedListNode` object or `undefined` as its value.
+     */
+    set prev(value: DoublyLinkedListNode<E> | undefined);
 }
 /**
  * 1. Node Structure: Each node contains three parts: a data field, a pointer (or reference) to the previous node, and a pointer to the next node. This structure allows traversal of the linked list in both directions.
@@ -26,21 +62,38 @@ export declare class DoublyLinkedListNode<E = any> {
  */
 export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
     /**
-     * The constructor initializes the linked list with an empty head, tail, and size.
+     * The constructor initializes a linked list with optional elements.
+     * @param elements - The `elements` parameter is an optional iterable object that contains the
+     * initial elements to be added to the data structure. It defaults to an empty array if no elements
+     * are provided.
      */
     constructor(elements?: Iterable<E>);
     protected _head: DoublyLinkedListNode<E> | undefined;
+    /**
+     * The `head` function returns the first node of a doubly linked list.
+     * @returns The method `getHead()` returns either a `DoublyLinkedListNode<E>` object or `undefined`.
+     */
     get head(): DoublyLinkedListNode<E> | undefined;
     protected _tail: DoublyLinkedListNode<E> | undefined;
+    /**
+     * The `tail` function returns the last node of a doubly linked list.
+     * @returns The `get tail()` method is returning either a `DoublyLinkedListNode<E>` object or
+     * `undefined`.
+     */
     get tail(): DoublyLinkedListNode<E> | undefined;
     protected _size: number;
+    /**
+     * The function returns the size of an object.
+     * @returns The size of the object, which is a number.
+     */
     get size(): number;
     /**
-     * Time Complexity: O(n), where n is the size of the input array.
-     * Space Complexity: O(n)
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     * where n is the number of elements in the linked list.
      */
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(1)
      * Space Complexity: O(1)
      *
      * The `get first` function returns the first node in a doubly linked list, or undefined if the list is empty.
@@ -52,7 +105,7 @@ export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
      * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(1)
      * Space Complexity: O(1)
      *
      * The `get last` function returns the last node in a doubly linked list, or undefined if the list is empty.
@@ -60,11 +113,11 @@ export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
      */
     get last(): E | undefined;
     /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
+     * Time Complexity: O(n)
+     * Space Complexity: O(n)
      */
     /**
-     * Time Complexity: O(n), where n is the size of the input array.
+     * Time Complexity: O(n)
      * Space Complexity: O(n)
      *
      * The `fromArray` function creates a new instance of a DoublyLinkedList and populates it with the elements from the
@@ -99,7 +152,7 @@ export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
      */
     pop(): E | undefined;
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(1)
      * Space Complexity: O(1)
      */
     /**
@@ -112,7 +165,7 @@ export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
      */
     shift(): E | undefined;
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(1)
      * Space Complexity: O(1)
      */
     /**
@@ -125,26 +178,26 @@ export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
      */
     unshift(value: E): boolean;
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(n)
      * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(n)
      * Space Complexity: O(1)
      *
-     * The `getAt` function returns the value at a specified index in a linked list, or undefined if the index is out of bounds.
+     * The `at` function returns the value at a specified index in a linked list, or undefined if the index is out of bounds.
      * @param {number} index - The index parameter is a number that represents the position of the element we want to
      * retrieve from the list.
      * @returns The method is returning the value at the specified index in the linked list. If the index is out of bounds
      * or the linked list is empty, it will return undefined.
      */
-    getAt(index: number): E | undefined;
+    at(index: number): E | undefined;
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(n)
      * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(n)
      * Space Complexity: O(1)
      *
      * The function `getNodeAt` returns the node at a given index in a doubly linked list, or undefined if the index is out of
@@ -156,11 +209,11 @@ export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
      */
     getNodeAt(index: number): DoublyLinkedListNode<E> | undefined;
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(n)
      * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(n)
      * Space Complexity: O(1)
      *
      * The function `findNodeByValue` searches for a node with a specific value in a doubly linked list and returns the
@@ -171,11 +224,11 @@ export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
      */
     getNode(value: E | undefined): DoublyLinkedListNode<E> | undefined;
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(n)
      * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(n)
      * Space Complexity: O(1)
      *
      * The `insert` function inserts a value at a specified index in a doubly linked list.
@@ -188,11 +241,12 @@ export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
      */
     addAt(index: number, value: E): boolean;
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(1) or O(n)
      * Space Complexity: O(1)
+     * where n is the number of elements in the linked list.
      */
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(1) or O(n)
      * Space Complexity: O(1)
      *
      * The `addBefore` function inserts a new value before an existing value or node in a doubly linked list.
@@ -206,11 +260,11 @@ export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
      */
     addBefore(existingValueOrNode: E | DoublyLinkedListNode<E>, newValue: E): boolean;
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(1) or O(n)
      * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(1) or O(n)
      * Space Complexity: O(1)
      *
      * The `addAfter` function inserts a new node with a given value after an existing node in a doubly linked list.
@@ -223,7 +277,7 @@ export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
      */
     addAfter(existingValueOrNode: E | DoublyLinkedListNode<E>, newValue: E): boolean;
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(n)
      * Space Complexity: O(1)
      *
      * The `deleteAt` function removes an element at a specified index from a linked list and returns the removed element.
@@ -234,7 +288,11 @@ export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
      */
     deleteAt(index: number): boolean;
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(1) or O(n)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1) or O(n)
      * Space Complexity: O(1)
      *
      * The `delete` function removes a node from a doubly linked list based on either the node itself or its value.
@@ -245,43 +303,34 @@ export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
      */
     delete(valOrNode: E | DoublyLinkedListNode<E> | undefined): boolean;
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(1)
      * Space Complexity: O(1)
      */
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The function checks if a variable has a size greater than zero and returns a boolean value.
      * @returns A boolean value is being returned.
      */
     isEmpty(): boolean;
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
-     * Space Complexity: O(1)
-     */
-    /**
-     * The `clear` function resets the linked list by setting the head, tail, and size to undefined and 0 respectively.
-     */
-    clear(): void;
-    /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(1)
      * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(1)
      * Space Complexity: O(1)
      *
-     * The `find` function iterates through a linked list and returns the first element that satisfies a given condition.
-     * @param callback - A function that takes a value of type E as its parameter and returns a boolean value. This
-     * function is used to determine whether a particular value in the linked list satisfies a certain condition.
-     * @returns The method `find` returns the first element in the linked list that satisfies the condition specified by
-     * the callback function. If no element satisfies the condition, it returns `undefined`.
+     * The `clear` function resets the linked list by setting the head, tail, and size to undefined and 0 respectively.
      */
-    find(callback: (value: E) => boolean): E | undefined;
+    clear(): void;
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(n)
      * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(n)
      * Space Complexity: O(1)
      *
      * The function returns the index of the first occurrence of a given value in a linked list.
@@ -292,11 +341,11 @@ export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
      */
     indexOf(value: E): number;
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
-     * Space Complexity: O(n)
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(n)
      * Space Complexity: O(1)
      *
      * The `findBackward` function iterates through a linked list from the last node to the first node and returns the last
@@ -308,11 +357,11 @@ export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
      */
     findBackward(callback: (value: E) => boolean): E | undefined;
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
-     * Space Complexity: O(n)
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(n)
      * Space Complexity: O(1)
      *
      * The `reverse` function reverses the order of the elements in a doubly linked list.
@@ -323,7 +372,7 @@ export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
      * 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 `toArray` function converts a linked list into an array.
@@ -331,11 +380,11 @@ export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
      */
     toArray(): E[];
     /**
-     * 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 `toReversedArray` function converts a doubly linked list into an array in reverse order.
@@ -343,8 +392,22 @@ export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
      */
     toReversedArray(): E[];
     /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
+     * Time Complexity: O(n)
+     * Space Complexity: O(n)
+     */
+    /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(n)
+     *
+     * The `clone` function creates a new instance of the `DoublyLinkedList` class with the same values
+     * as the original list.
+     * @returns The `clone()` method is returning a new instance of the `DoublyLinkedList` class, which
+     * is a copy of the original list.
+     */
+    clone(): DoublyLinkedList<E>;
+    /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(n)
      */
     /**
      * Time Complexity: O(n)
@@ -365,8 +428,8 @@ export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
      */
     filter(callback: ElementCallback<E, boolean>, thisArg?: any): DoublyLinkedList<E>;
     /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
+     * Time Complexity: O(n)
+     * Space Complexity: O(n)
      */
     /**
      * Time Complexity: O(n)
@@ -412,7 +475,7 @@ export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
      */
     pollLast(): E | undefined;
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(1)
      * Space Complexity: O(1)
      */
     /**
@@ -425,7 +488,7 @@ export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
      */
     pollFirst(): E | undefined;
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(1)
      * Space Complexity: O(1)
      */
     /**