undirected-graph-typed 1.49.0 → 1.49.2

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

@@ -1,5 +1,3 @@
-import { IterableElementBase } from "../base";
-import { ElementCallback } from "../../types";
 /**
  * data-structure-typed
  *
@@ -7,6 +5,8 @@ import { ElementCallback } from "../../types";
  * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
  * @license MIT License
  */
+import type { ElementCallback } from '../../types';
+import { IterableElementBase } from '../base';
 export declare class DoublyLinkedListNode<E = any> {
     value: E;
     next: DoublyLinkedListNode<E> | undefined;
@@ -18,24 +18,29 @@ export declare class DoublyLinkedListNode<E = any> {
      */
     constructor(value: E);
 }
+/**
+ * 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.
+ * 2. Bidirectional Traversal: Unlike singly linked lists, doubly linked lists can be easily traversed forwards or backwards. This makes insertions and deletions in the list more flexible and efficient.
+ * 3. No Centralized Index: Unlike arrays, elements in a linked list are not stored contiguously, so there is no centralized index. Accessing elements in a linked list typically requires traversing from the head or tail node.
+ * 4. High Efficiency in Insertion and Deletion: Adding or removing elements in a linked list does not require moving other elements, making these operations more efficient than in arrays.
+ */
 export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
     /**
-     * The constructor initializes the linked list with an empty head, tail, and length.
+     * The constructor initializes the linked list with an empty head, tail, and size.
      */
     constructor(elements?: Iterable<E>);
     protected _head: DoublyLinkedListNode<E> | undefined;
     get head(): DoublyLinkedListNode<E> | undefined;
     protected _tail: DoublyLinkedListNode<E> | undefined;
     get tail(): DoublyLinkedListNode<E> | undefined;
-    protected _length: number;
-    get length(): number;
+    protected _size: number;
     get size(): number;
     /**
-     * Time Complexity: O(n), where n is the length of the input array.
+     * Time Complexity: O(n), where n is the size of the input array.
      * Space Complexity: O(n)
      */
     /**
-     * Time Complexity: O(n), where n is the length of the input array.
+     * Time Complexity: O(n), where n is the size of the input array.
      * Space Complexity: O(n)
      *
      * The `fromArray` function creates a new instance of a DoublyLinkedList and populates it with the elements from the
@@ -55,19 +60,7 @@ export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
      * The push function adds a new node with the given value to the end of the doubly linked list.
      * @param {E} value - The value to be added to the linked list.
      */
-    push(value: E): void;
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     */
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     *
-     * The addLast function adds a new node with the given value to the end of the doubly linked list.
-     * @param {E} value - The value to be added to the linked list.
-     */
-    addLast(value: E): void;
+    push(value: E): boolean;
     /**
      * Time Complexity: O(1)
      * Space Complexity: O(1)
@@ -81,19 +74,6 @@ export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
      * list is empty, it returns undefined.
      */
     pop(): E | undefined;
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     */
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     *
-     * The `pollLast()` function removes and returns the value of the last node in a doubly linked list.
-     * @returns The method is returning the value of the removed node (removedNode.value) if the list is not empty. If the
-     * list is empty, it returns undefined.
-     */
-    pollLast(): E | undefined;
     /**
      * Time Complexity: O(1)
      * Space Complexity: O(1)
@@ -107,19 +87,6 @@ export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
      * list.
      */
     shift(): E | undefined;
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     */
-    /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
-     *
-     * The `pollFirst()` function removes and returns the value of the first node in a doubly linked list.
-     * @returns The method `shift()` returns the value of the node that is removed from the beginning of the doubly linked
-     * list.
-     */
-    pollFirst(): E | undefined;
     /**
      * Time Complexity: O(1)
      * Space Complexity: O(1)
@@ -132,44 +99,7 @@ export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
      * @param {E} value - The `value` parameter represents the value of the new node that will be added to the beginning of the
      * doubly linked list.
      */
-    unshift(value: E): void;
-    /**
-     * 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 doubly linked list.
-     * @param {E} value - The `value` parameter represents the value of the new node that will be added to the beginning of the
-     * doubly linked list.
-     */
-    addFirst(value: E): void;
-    /**
-     * 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 `getFirst` function returns the first node in a doubly linked list, or undefined if the list is empty.
-     * @returns The method `getFirst()` returns the first node of the doubly linked list, or `undefined` if the list is empty.
-     */
-    getFirst(): E | undefined;
-    /**
-     * 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 `getLast` function returns the last node in a doubly linked list, or undefined if the list is empty.
-     * @returns The method `getLast()` returns the last node of the doubly linked list, or `undefined` if the list is empty.
-     */
-    getLast(): E | undefined;
+    unshift(value: E): boolean;
     /**
      * Time Complexity: O(n), where n is the number of elements in the linked list.
      * Space Complexity: O(1)
@@ -232,7 +162,7 @@ export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
      * @returns The `insert` method returns a boolean value. It returns `true` if the insertion is successful, and `false`
      * if the index is out of bounds.
      */
-    insertAt(index: number, value: E): boolean;
+    addAt(index: number, value: E): boolean;
     /**
      * Time Complexity: O(n), where n is the number of elements in the linked list.
      * Space Complexity: O(1)
@@ -241,7 +171,7 @@ export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
      * Time Complexity: O(n), where n is the number of elements in the linked list.
      * Space Complexity: O(1)
      *
-     * The `insertBefore` function inserts a new value before an existing value or node in a doubly linked list.
+     * The `addBefore` function inserts a new value before an existing value or node in a doubly linked list.
      * @param {E | DoublyLinkedListNode<E>} existingValueOrNode - The existing value or node in the doubly linked list
      * before which the new value will be inserted. It can be either the value of the existing node or the existing node
      * itself.
@@ -250,7 +180,7 @@ export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
      * @returns The method returns a boolean value. It returns `true` if the insertion is successful, and `false` if the
      * insertion fails.
      */
-    insertBefore(existingValueOrNode: E | DoublyLinkedListNode<E>, newValue: E): boolean;
+    addBefore(existingValueOrNode: E | DoublyLinkedListNode<E>, newValue: E): boolean;
     /**
      * Time Complexity: O(n), where n is the number of elements in the linked list.
      * Space Complexity: O(1)
@@ -259,7 +189,7 @@ export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
      * Time Complexity: O(n), where n is the number of elements in the linked list.
      * Space Complexity: O(1)
      *
-     * The `insertAfter` function inserts a new node with a given value after an existing node in a doubly linked list.
+     * The `addAfter` function inserts a new node with a given value after an existing node in a doubly linked list.
      * @param {E | DoublyLinkedListNode<E>} existingValueOrNode - The existing value or node in the doubly linked list
      * after which the new value will be inserted. It can be either the value of the existing node or the existing node
      * itself.
@@ -267,7 +197,7 @@ export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
      * @returns The method returns a boolean value. It returns true if the insertion is successful, and false if the
      * existing value or node is not found in the doubly linked list.
      */
-    insertAfter(existingValueOrNode: E | DoublyLinkedListNode<E>, newValue: E): boolean;
+    addAfter(existingValueOrNode: E | DoublyLinkedListNode<E>, newValue: E): boolean;
     /**
      * Time Complexity: O(n), where n is the number of elements in the linked list.
      * Space Complexity: O(1)
@@ -282,7 +212,7 @@ export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
      * @returns The method `deleteAt` returns the value of the node that was deleted, or `undefined` if the index is out of
      * bounds.
      */
-    deleteAt(index: number): E | undefined;
+    deleteAt(index: number): boolean;
     /**
      * Time Complexity: O(n), where n is the number of elements in the linked list.
      * Space Complexity: O(1)
@@ -299,12 +229,12 @@ export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
      */
     delete(valOrNode: E | DoublyLinkedListNode<E> | undefined): boolean;
     /**
-     * The function checks if a variable has a length greater than zero and returns a boolean value.
+     * 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;
     /**
-     * The `clear` function resets the linked list by setting the head, tail, and length to undefined and 0 respectively.
+     * The `clear` function resets the linked list by setting the head, tail, and size to undefined and 0 respectively.
      */
     clear(): void;
     /**
@@ -363,7 +293,7 @@ export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
      *
      * The `reverse` function reverses the order of the elements in a doubly linked list.
      */
-    reverse(): void;
+    reverse(): this;
     /**
      * Time Complexity: O(n), where n is the number of elements in the linked list.
      * Space Complexity: O(n)
@@ -432,11 +362,81 @@ export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
      * object.
      */
     map<T>(callback: ElementCallback<E, T>, thisArg?: any): DoublyLinkedList<T>;
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
+     * The addLast function adds a new node with the given value to the end of the doubly linked list.
+     * @param {E} value - The value to be added to the linked list.
+     */
+    addLast(value: E): boolean;
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
+     * The `pollLast()` function removes and returns the value of the last node in a doubly linked list.
+     * @returns The method is returning the value of the removed node (removedNode.value) if the list is not empty. If the
+     * list is empty, it returns undefined.
+     */
+    pollLast(): E | undefined;
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
+     * The `pollFirst()` function removes and returns the value of the first node in a doubly linked list.
+     * @returns The method `shift()` returns the value of the node that is removed from the beginning of the doubly linked
+     * list.
+     */
+    pollFirst(): E | undefined;
+    /**
+     * 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 doubly linked list.
+     * @param {E} value - The `value` parameter represents the value of the new node that will be added to the beginning of the
+     * doubly linked list.
+     */
+    addFirst(value: E): void;
     /**
      * Time Complexity: O(n), where n is the number of elements in the linked list.
-     * Space Complexity: O(n)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(1)
+     *
+     * The `get first` function returns the first node in a doubly linked list, or undefined if the list is empty.
+     * @returns The method `get first()` returns the first node of the doubly linked list, or `undefined` if the list is empty.
+     */
+    get first(): E | undefined;
+    /**
+     * 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 `get last` function returns the last node in a doubly linked list, or undefined if the list is empty.
+     * @returns The method `get last()` returns the last node of the doubly linked list, or `undefined` if the list is empty.
      */
-    print(): void;
+    get last(): E | undefined;
     /**
      * The function returns an iterator that iterates over the values of a linked list.
      */