min-heap-typed 1.50.1 → 1.50.2

package/dist/data-structures/heap/heap.js

@@ -21,6 +21,16 @@ const base_1 = require("../base");
  * 8. Graph Algorithms: Such as Dijkstra's shortest path algorithm and Prim's minimum spanning tree algorithm, which use heaps to improve performance.
  */
 class Heap extends base_1.IterableElementBase {
+    /**
+     * The constructor initializes a heap data structure with optional elements and options.
+     * @param elements - The `elements` parameter is an iterable object that contains the initial
+     * elements to be added to the heap. It is an optional parameter and if not provided, the heap will
+     * be initialized as empty.
+     * @param [options] - The `options` parameter is an optional object that can contain additional
+     * configuration options for the heap. In this case, it is used to specify a custom comparator
+     * function for comparing elements in the heap. The comparator function is used to determine the
+     * order of elements in the heap.
+     */
     constructor(elements = [], options) {
         super();
         this._comparator = (a, b) => {
@@ -44,9 +54,17 @@ class Heap extends base_1.IterableElementBase {
             // this.fix();
         }
     }
+    /**
+     * The function returns the value of the _comparator property.
+     * @returns The `_comparator` property is being returned.
+     */
     get comparator() {
         return this._comparator;
     }
+    /**
+     * The function returns an array of elements.
+     * @returns The elements array is being returned.
+     */
     get elements() {
         return this._elements;
     }
@@ -74,11 +92,12 @@ class Heap extends base_1.IterableElementBase {
         return new Heap(elements, options);
     }
     /**
-     * Time Complexity: O(log n), where n is the number of elements in the heap.
+     * Time Complexity: O(log n)
      * Space Complexity: O(1)
+     * where n is the number of elements in the heap.
      */
     /**
-     * Time Complexity: O(log n), where n is the number of elements in the heap.
+     * Time Complexity: O(log n)
      * Space Complexity: O(1)
      *
      * Insert an element into the heap and maintain the heap properties.
@@ -89,11 +108,12 @@ class Heap extends base_1.IterableElementBase {
         return this._bubbleUp(this.elements.length - 1);
     }
     /**
-     * Time Complexity: O(log n), where n is the number of elements in the heap.
+     * Time Complexity: O(log n)
      * Space Complexity: O(1)
+     * where n is the number of elements in the heap.
      */
     /**
-     * Time Complexity: O(log n), where n is the number of elements in the heap.
+     * Time Complexity: O(log n)
      * Space Complexity: O(1)
      *
      * Remove and return the top element (smallest or largest element) from the heap.
@@ -111,6 +131,9 @@ class Heap extends base_1.IterableElementBase {
         return value;
     }
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * Peek at the top element of the heap without removing it.
      * @returns The top element or undefined if the heap is empty.
      */
@@ -361,6 +384,9 @@ class Heap extends base_1.IterableElementBase {
         }
         return mappedHeap;
     }
+    /**
+     * The function `_getIterator` returns an iterable iterator for the elements in the class.
+     */
     *_getIterator() {
         for (const element of this.elements) {
             yield element;
@@ -419,6 +445,16 @@ class Heap extends base_1.IterableElementBase {
 }
 exports.Heap = Heap;
 class FibonacciHeapNode {
+    /**
+     * The constructor function initializes an object with an element and a degree, and sets the marked
+     * property to false.
+     * @param {E} element - The "element" parameter represents the value or data that will be stored in
+     * the node of a data structure. It can be any type of data, such as a number, string, object, or
+     * even another data structure.
+     * @param [degree=0] - The degree parameter represents the degree of the element in a data structure
+     * called a Fibonacci heap. The degree of a node is the number of children it has. By default, the
+     * degree is set to 0 when a new node is created.
+     */
     constructor(element, degree = 0) {
         this.element = element;
         this.degree = degree;
@@ -427,6 +463,13 @@ class FibonacciHeapNode {
 }
 exports.FibonacciHeapNode = FibonacciHeapNode;
 class FibonacciHeap {
+    /**
+     * The constructor function initializes a FibonacciHeap object with an optional comparator function.
+     * @param [comparator] - The `comparator` parameter is an optional argument that represents a
+     * function used to compare elements in the FibonacciHeap. If a comparator function is provided, it
+     * will be used to determine the order of elements in the heap. If no comparator function is
+     * provided, a default comparator function will be used.
+     */
     constructor(comparator) {
         this._size = 0;
         this.clear();
@@ -435,15 +478,32 @@ class FibonacciHeap {
             throw new Error('FibonacciHeap constructor: given comparator should be a function.');
         }
     }
+    /**
+     * The function returns the root node of a Fibonacci heap.
+     * @returns The method is returning either a FibonacciHeapNode object or undefined.
+     */
     get root() {
         return this._root;
     }
+    /**
+     * The function returns the size of an object.
+     * @returns The size of the object, which is a number.
+     */
     get size() {
         return this._size;
     }
+    /**
+     * The function returns the minimum node in a Fibonacci heap.
+     * @returns The method is returning the minimum node of the Fibonacci heap, which is of type
+     * `FibonacciHeapNode<E>`. If there is no minimum node, it will return `undefined`.
+     */
     get min() {
         return this._min;
     }
+    /**
+     * The function returns the comparator used for comparing elements.
+     * @returns The `_comparator` property of the object.
+     */
     get comparator() {
         return this._comparator;
     }
@@ -726,11 +786,11 @@ class FibonacciHeap {
         y.parent = x;
     }
     /**
-     * Time Complexity: O(n log n), where n is the number of elements in the heap.
+     * Time Complexity: O(n log n)
      * Space Complexity: O(n)
      */
     /**
-     * Time Complexity: O(n log n), where n is the number of elements in the heap.
+     * Time Complexity: O(n log n)
      * Space Complexity: O(n)
      *
      * Remove and return the top element (smallest or largest element) from the heap.

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

@@ -26,21 +26,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.
+     * Time Complexity: O(n)
      * Space Complexity: O(n)
+     * 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(n)
      * 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 +69,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(n)
      * Space Complexity: O(1)
      *
      * The `get last` function returns the last node in a doubly linked list, or undefined if the list is empty.
@@ -99,7 +116,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(n)
      * Space Complexity: O(1)
      */
     /**
@@ -112,7 +129,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(n)
      * Space Complexity: O(1)
      */
     /**
@@ -125,26 +142,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 +173,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 +188,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 +205,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(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(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 +224,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(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 `addAfter` function inserts a new node with a given value after an existing node in a doubly linked list.
@@ -223,7 +241,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 +252,7 @@ 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(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,7 +263,7 @@ 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)
      */
     /**
@@ -254,7 +272,7 @@ export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
      */
     isEmpty(): boolean;
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(1)
      * Space Complexity: O(1)
      */
     /**
@@ -262,26 +280,11 @@ export declare class DoublyLinkedList<E = any> extends IterableElementBase<E> {
      */
     clear(): 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 `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`.
-     */
-    find(callback: (value: E) => boolean): 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 returns the index of the first occurrence of a given value in a linked list.
@@ -292,11 +295,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.
+     * 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(1)
      *
      * The `findBackward` function iterates through a linked list from the last node to the first node and returns the last
@@ -308,11 +311,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.
+     * 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(1)
      *
      * The `reverse` function reverses the order of the elements in a doubly linked list.
@@ -323,7 +326,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,17 +334,31 @@ 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.
      * @returns The `toReversedArray()` function returns an array of type `E[]`.
      */
     toReversedArray(): E[];
+    /**
+     * 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(1)
      * Space Complexity: O(1)
@@ -412,7 +429,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(n)
      * Space Complexity: O(1)
      */
     /**
@@ -425,7 +442,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(n)
      * Space Complexity: O(1)
      */
     /**