min-heap-typed 1.50.1 → 1.50.3

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

@@ -13,46 +13,70 @@ export declare class SkipListNode<K, V> {
     constructor(key: K, value: V, level: number);
 }
 export declare class SkipList<K, V> {
+    /**
+     * The constructor function initializes a SkipLinkedList object with optional options and elements.
+     * @param elements - The `elements` parameter is an iterable containing key-value pairs `[K, V]`. It
+     * is used to initialize the SkipLinkedList with the given key-value pairs. If no elements are
+     * provided, the SkipLinkedList will be empty.
+     * @param {SkipLinkedListOptions} [options] - The `options` parameter is an optional object that can
+     * contain two properties:
+     */
     constructor(elements?: Iterable<[K, V]>, options?: SkipLinkedListOptions);
     protected _head: SkipListNode<K, V>;
+    /**
+     * The function returns the head node of a SkipList.
+     * @returns The method is returning a SkipListNode object with generic key type K and value type V.
+     */
     get head(): SkipListNode<K, V>;
     protected _level: number;
+    /**
+     * The function returns the value of the protected variable _level.
+     * @returns The level property of the object.
+     */
     get level(): number;
     protected _maxLevel: number;
+    /**
+     * The function returns the maximum level.
+     * @returns The value of the variable `_maxLevel` is being returned.
+     */
     get maxLevel(): number;
     protected _probability: number;
+    /**
+     * The function returns the probability value.
+     * @returns The probability value stored in the protected variable `_probability` is being returned.
+     */
     get probability(): number;
     /**
-     * Time Complexity: O(log n) - where n is the number of elements in the SkipList, as it traverses the levels of the SkipList.
-     * Space Complexity: O(1) - constant space, as it uses a fixed amount of space regardless of the size of the SkipList.
+     * Time Complexity: O(log n)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(1) - where n is the number of elements in the SkipList, as it traverses the levels of the SkipList.
-     * Space Complexity: O(1) - constant space, as it uses a fixed amount of space regardless of the size of the SkipList.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      *
      * Get the value of the first element (the smallest element) in the Skip List.
      * @returns The value of the first element, or undefined if the Skip List is empty.
      */
     get first(): V | undefined;
     /**
-     * Time Complexity: O(log n) - where n is the number of elements in the SkipList, as it traverses the levels of the SkipList.
-     * Space Complexity: O(1) - constant space, as it uses a fixed amount of space regardless of the size of the SkipList.
+     * Time Complexity: O(log n)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(log n) - where n is the number of elements in the SkipList, as it traverses the levels of the SkipList.
-     * Space Complexity: O(1) - constant space, as it uses a fixed amount of space regardless of the size of the SkipList.
+     * Time Complexity: O(log n)
+     * Space Complexity: O(1)
      *
      * Get the value of the last element (the largest element) in the Skip List.
      * @returns The value of the last element, or undefined if the Skip List is empty.
      */
     get last(): V | undefined;
     /**
-     * Time Complexity: O(log n) - where n is the number of elements in the SkipList, as it traverses the levels of the SkipList.
-     * Space Complexity: O(1) - constant space, as it uses a fixed amount of space regardless of the size of the SkipList.
+     * Time Complexity: O(log n)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(log n) - where n is the number of elements in the SkipList, as it traverses the levels of the SkipList.
-     * Space Complexity: O(1) - constant space, as it uses a fixed amount of space regardless of the size of the SkipList.
+     * Time Complexity: O(log n)
+     * Space Complexity: O(1)
      *
      * The add function adds a new node with a given key and value to a Skip List data structure.
      * @param {K} key - The key parameter represents the key of the node that needs to be added to the skip list.
@@ -61,12 +85,12 @@ export declare class SkipList<K, V> {
      */
     add(key: K, value: V): void;
     /**
-     * Time Complexity: O(log n) - where n is the number of elements in the SkipList, as it traverses the levels of the SkipList.
-     * Space Complexity: O(1) - constant space, as it uses a fixed amount of space regardless of the size of the SkipList.
+     * Time Complexity: O(log n)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(log n) - where n is the number of elements in the SkipList, as it traverses the levels of the SkipList.
-     * Space Complexity: O(1) - constant space, as it uses a fixed amount of space regardless of the size of the SkipList.
+     * Time Complexity: O(log n)
+     * Space Complexity: O(1)
      *
      * The function `get` retrieves the value associated with a given key from a skip list data structure.
      * @param {K} key - The `key` parameter is the key of the element that we want to retrieve from the data structure.
@@ -75,21 +99,23 @@ export declare class SkipList<K, V> {
      */
     get(key: K): V | undefined;
     /**
-     * Time Complexity: O(1) - where n is the number of elements in the SkipList, as it traverses the levels of the SkipList.
-     * Space Complexity: O(1) - constant space, as it uses a fixed amount of space regardless of the size of the SkipList.
+     * Time Complexity: O(log n)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(log n) - where n is the number of elements in the SkipList, as it traverses the levels of the SkipList.
-     * Space Complexity: O(1) - constant space, as it uses a fixed amount of space regardless of the size of the SkipList.
+     * The function checks if a key exists in a data structure.
+     * @param {K} key - The parameter "key" is of type K, which represents the type of the key being
+     * checked.
+     * @returns a boolean value.
      */
     has(key: K): boolean;
     /**
-     * Time Complexity: O(log n) - where n is the number of elements in the SkipList, as it traverses the levels of the SkipList.
-     * Space Complexity: O(1) - constant space, as it uses a fixed amount of space regardless of the size of the SkipList.
+     * Time Complexity: O(log n)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(log n) - where n is the number of elements in the SkipList, as it traverses the levels of the SkipList.
-     * Space Complexity: O(1) - constant space, as it uses a fixed amount of space regardless of the size of the SkipList.
+     * Time Complexity: O(log n)
+     * Space Complexity: O(1)
      *
      * The `delete` function removes a node with a specific key from a Skip List data structure.
      * @param {K} key - The key parameter represents the key of the node that needs to be removed from the skip list.
@@ -98,12 +124,12 @@ export declare class SkipList<K, V> {
      */
     delete(key: K): boolean;
     /**
-     * Time Complexity: O(log n) - where n is the number of elements in the SkipList, as it traverses the levels of the SkipList.
-     * Space Complexity: O(1) - constant space, as it uses a fixed amount of space regardless of the size of the SkipList.
+     * Time Complexity: O(log n)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(log n) - where n is the number of elements in the SkipList, as it traverses the levels of the SkipList.
-     * Space Complexity: O(1) - constant space, as it uses a fixed amount of space regardless of the size of the SkipList.
+     * Time Complexity: O(log n)
+     * Space Complexity: O(1)
      *
      * Get the value of the first element in the Skip List that is greater than the given key.
      * @param key - the given key.
@@ -111,12 +137,12 @@ export declare class SkipList<K, V> {
      */
     higher(key: K): V | undefined;
     /**
-     * Time Complexity: O(log n) - where n is the number of elements in the SkipList, as it traverses the levels of the SkipList.
-     * Space Complexity: O(1) - constant space, as it uses a fixed amount of space regardless of the size of the SkipList.
+     * Time Complexity: O(log n)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(log n) - where n is the number of elements in the SkipList, as it traverses the levels of the SkipList.
-     * Space Complexity: O(1) - constant space, as it uses a fixed amount of space regardless of the size of the SkipList.
+     * Time Complexity: O(log n)
+     * Space Complexity: O(1)
      *
      * Get the value of the last element in the Skip List that is less than the given key.
      * @param key - the given key.
@@ -124,12 +150,13 @@ export declare class SkipList<K, V> {
      */
     lower(key: K): V | undefined;
     /**
-     * Time Complexity: O(maxLevel) - where maxLevel is the maximum level of the SkipList, as it may iterate up to maxLevel times in the worst case.
-     * Space Complexity: O(1) - constant space.
+     * Time Complexity: O(maxLevel)
+     * Space Complexity: O(1)
+     * where maxLevel is the maximum level of the SkipList, as it may iterate up to maxLevel times in the worst case.
      */
     /**
-     * Time Complexity: O(maxLevel) - where maxLevel is the maximum level of the SkipList, as it may iterate up to maxLevel times in the worst case.
-     * Space Complexity: O(1) - constant space.
+     * Time Complexity: O(maxLevel)
+     * Space Complexity: O(1)
      *
      * The function "_randomLevel" generates a random level based on a given probability and maximum level.
      * @returns the level, which is a number.

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

@@ -10,6 +10,14 @@ class SkipListNode {
 }
 exports.SkipListNode = SkipListNode;
 class SkipList {
+    /**
+     * The constructor function initializes a SkipLinkedList object with optional options and elements.
+     * @param elements - The `elements` parameter is an iterable containing key-value pairs `[K, V]`. It
+     * is used to initialize the SkipLinkedList with the given key-value pairs. If no elements are
+     * provided, the SkipLinkedList will be empty.
+     * @param {SkipLinkedListOptions} [options] - The `options` parameter is an optional object that can
+     * contain two properties:
+     */
     constructor(elements = [], options) {
         this._head = new SkipListNode(undefined, undefined, this.maxLevel);
         this._level = 0;
@@ -27,25 +35,41 @@ class SkipList {
                 this.add(key, value);
         }
     }
+    /**
+     * The function returns the head node of a SkipList.
+     * @returns The method is returning a SkipListNode object with generic key type K and value type V.
+     */
     get head() {
         return this._head;
     }
+    /**
+     * The function returns the value of the protected variable _level.
+     * @returns The level property of the object.
+     */
     get level() {
         return this._level;
     }
+    /**
+     * The function returns the maximum level.
+     * @returns The value of the variable `_maxLevel` is being returned.
+     */
     get maxLevel() {
         return this._maxLevel;
     }
+    /**
+     * The function returns the probability value.
+     * @returns The probability value stored in the protected variable `_probability` is being returned.
+     */
     get probability() {
         return this._probability;
     }
     /**
-     * Time Complexity: O(log n) - where n is the number of elements in the SkipList, as it traverses the levels of the SkipList.
-     * Space Complexity: O(1) - constant space, as it uses a fixed amount of space regardless of the size of the SkipList.
+     * Time Complexity: O(log n)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(1) - where n is the number of elements in the SkipList, as it traverses the levels of the SkipList.
-     * Space Complexity: O(1) - constant space, as it uses a fixed amount of space regardless of the size of the SkipList.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      *
      * Get the value of the first element (the smallest element) in the Skip List.
      * @returns The value of the first element, or undefined if the Skip List is empty.
@@ -55,12 +79,12 @@ class SkipList {
         return firstNode ? firstNode.value : undefined;
     }
     /**
-     * Time Complexity: O(log n) - where n is the number of elements in the SkipList, as it traverses the levels of the SkipList.
-     * Space Complexity: O(1) - constant space, as it uses a fixed amount of space regardless of the size of the SkipList.
+     * Time Complexity: O(log n)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(log n) - where n is the number of elements in the SkipList, as it traverses the levels of the SkipList.
-     * Space Complexity: O(1) - constant space, as it uses a fixed amount of space regardless of the size of the SkipList.
+     * Time Complexity: O(log n)
+     * Space Complexity: O(1)
      *
      * Get the value of the last element (the largest element) in the Skip List.
      * @returns The value of the last element, or undefined if the Skip List is empty.
@@ -75,12 +99,12 @@ class SkipList {
         return current.value;
     }
     /**
-     * Time Complexity: O(log n) - where n is the number of elements in the SkipList, as it traverses the levels of the SkipList.
-     * Space Complexity: O(1) - constant space, as it uses a fixed amount of space regardless of the size of the SkipList.
+     * Time Complexity: O(log n)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(log n) - where n is the number of elements in the SkipList, as it traverses the levels of the SkipList.
-     * Space Complexity: O(1) - constant space, as it uses a fixed amount of space regardless of the size of the SkipList.
+     * Time Complexity: O(log n)
+     * Space Complexity: O(1)
      *
      * The add function adds a new node with a given key and value to a Skip List data structure.
      * @param {K} key - The key parameter represents the key of the node that needs to be added to the skip list.
@@ -106,12 +130,12 @@ class SkipList {
         }
     }
     /**
-     * Time Complexity: O(log n) - where n is the number of elements in the SkipList, as it traverses the levels of the SkipList.
-     * Space Complexity: O(1) - constant space, as it uses a fixed amount of space regardless of the size of the SkipList.
+     * Time Complexity: O(log n)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(log n) - where n is the number of elements in the SkipList, as it traverses the levels of the SkipList.
-     * Space Complexity: O(1) - constant space, as it uses a fixed amount of space regardless of the size of the SkipList.
+     * Time Complexity: O(log n)
+     * Space Complexity: O(1)
      *
      * The function `get` retrieves the value associated with a given key from a skip list data structure.
      * @param {K} key - The `key` parameter is the key of the element that we want to retrieve from the data structure.
@@ -132,23 +156,25 @@ class SkipList {
         return undefined;
     }
     /**
-     * Time Complexity: O(1) - where n is the number of elements in the SkipList, as it traverses the levels of the SkipList.
-     * Space Complexity: O(1) - constant space, as it uses a fixed amount of space regardless of the size of the SkipList.
+     * Time Complexity: O(log n)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(log n) - where n is the number of elements in the SkipList, as it traverses the levels of the SkipList.
-     * Space Complexity: O(1) - constant space, as it uses a fixed amount of space regardless of the size of the SkipList.
+     * The function checks if a key exists in a data structure.
+     * @param {K} key - The parameter "key" is of type K, which represents the type of the key being
+     * checked.
+     * @returns a boolean value.
      */
     has(key) {
         return this.get(key) !== undefined;
     }
     /**
-     * Time Complexity: O(log n) - where n is the number of elements in the SkipList, as it traverses the levels of the SkipList.
-     * Space Complexity: O(1) - constant space, as it uses a fixed amount of space regardless of the size of the SkipList.
+     * Time Complexity: O(log n)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(log n) - where n is the number of elements in the SkipList, as it traverses the levels of the SkipList.
-     * Space Complexity: O(1) - constant space, as it uses a fixed amount of space regardless of the size of the SkipList.
+     * Time Complexity: O(log n)
+     * Space Complexity: O(1)
      *
      * The `delete` function removes a node with a specific key from a Skip List data structure.
      * @param {K} key - The key parameter represents the key of the node that needs to be removed from the skip list.
@@ -180,12 +206,12 @@ class SkipList {
         return false;
     }
     /**
-     * Time Complexity: O(log n) - where n is the number of elements in the SkipList, as it traverses the levels of the SkipList.
-     * Space Complexity: O(1) - constant space, as it uses a fixed amount of space regardless of the size of the SkipList.
+     * Time Complexity: O(log n)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(log n) - where n is the number of elements in the SkipList, as it traverses the levels of the SkipList.
-     * Space Complexity: O(1) - constant space, as it uses a fixed amount of space regardless of the size of the SkipList.
+     * Time Complexity: O(log n)
+     * Space Complexity: O(1)
      *
      * Get the value of the first element in the Skip List that is greater than the given key.
      * @param key - the given key.
@@ -202,12 +228,12 @@ class SkipList {
         return nextNode ? nextNode.value : undefined;
     }
     /**
-     * Time Complexity: O(log n) - where n is the number of elements in the SkipList, as it traverses the levels of the SkipList.
-     * Space Complexity: O(1) - constant space, as it uses a fixed amount of space regardless of the size of the SkipList.
+     * Time Complexity: O(log n)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(log n) - where n is the number of elements in the SkipList, as it traverses the levels of the SkipList.
-     * Space Complexity: O(1) - constant space, as it uses a fixed amount of space regardless of the size of the SkipList.
+     * Time Complexity: O(log n)
+     * Space Complexity: O(1)
      *
      * Get the value of the last element in the Skip List that is less than the given key.
      * @param key - the given key.
@@ -227,12 +253,13 @@ class SkipList {
         return lastLess ? lastLess.value : undefined;
     }
     /**
-     * Time Complexity: O(maxLevel) - where maxLevel is the maximum level of the SkipList, as it may iterate up to maxLevel times in the worst case.
-     * Space Complexity: O(1) - constant space.
+     * Time Complexity: O(maxLevel)
+     * Space Complexity: O(1)
+     * where maxLevel is the maximum level of the SkipList, as it may iterate up to maxLevel times in the worst case.
      */
     /**
-     * Time Complexity: O(maxLevel) - where maxLevel is the maximum level of the SkipList, as it may iterate up to maxLevel times in the worst case.
-     * Space Complexity: O(1) - constant space.
+     * Time Complexity: O(maxLevel)
+     * Space Complexity: O(1)
      *
      * The function "_randomLevel" generates a random level based on a given probability and maximum level.
      * @returns the level, which is a number.

package/dist/data-structures/matrix/matrix.d.ts

@@ -16,13 +16,37 @@ export declare class Matrix {
      */
     constructor(data: number[][], options?: MatrixOptions);
     protected _rows: number;
+    /**
+     * The function returns the number of rows.
+     * @returns The number of rows.
+     */
     get rows(): number;
     protected _cols: number;
+    /**
+     * The function returns the value of the protected variable _cols.
+     * @returns The number of columns.
+     */
     get cols(): number;
     protected _data: number[][];
+    /**
+     * The function returns a two-dimensional array of numbers.
+     * @returns The data property, which is a two-dimensional array of numbers.
+     */
     get data(): number[][];
+    /**
+     * The above function returns the value of the _addFn property.
+     * @returns The value of the property `_addFn` is being returned.
+     */
     get addFn(): (a: number | undefined, b: number) => number | undefined;
+    /**
+     * The function returns the value of the _subtractFn property.
+     * @returns The `_subtractFn` property is being returned.
+     */
     get subtractFn(): (a: number, b: number) => number;
+    /**
+     * The function returns the value of the _multiplyFn property.
+     * @returns The `_multiplyFn` property is being returned.
+     */
     get multiplyFn(): (a: number, b: number) => number;
     /**
      * The `get` function returns the value at the specified row and column index if it is a valid index.
@@ -93,9 +117,6 @@ export declare class Matrix {
      * @returns a new Matrix object.
      */
     dot(matrix: Matrix): Matrix | undefined;
-    protected _addFn(a: number | undefined, b: number): number | undefined;
-    protected _subtractFn(a: number, b: number): number;
-    protected _multiplyFn(a: number, b: number): number;
     /**
      * The function checks if a given row and column index is valid within a specified range.
      * @param {number} row - The `row` parameter represents the row index of a two-dimensional array or
@@ -104,7 +125,17 @@ export declare class Matrix {
      * or grid. It is used to check if the given column index is valid within the bounds of the grid.
      * @returns A boolean value is being returned.
      */
-    protected isValidIndex(row: number, col: number): boolean;
+    isValidIndex(row: number, col: number): boolean;
+    /**
+     * The `clone` function returns a new instance of the Matrix class with the same data and properties
+     * as the original instance.
+     * @returns The `clone()` method is returning a new instance of the `Matrix` class with the same data
+     * and properties as the current instance.
+     */
+    clone(): Matrix;
+    protected _addFn(a: number | undefined, b: number): number | undefined;
+    protected _subtractFn(a: number, b: number): number;
+    protected _multiplyFn(a: number, b: number): number;
     /**
      * The function `_swapRows` swaps the positions of two rows in an array.
      * @param {number} row1 - The `row1` parameter is the index of the first row that you want to swap.

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

@@ -44,21 +44,45 @@ class Matrix {
             }
         }
     }
+    /**
+     * The function returns the number of rows.
+     * @returns The number of rows.
+     */
     get rows() {
         return this._rows;
     }
+    /**
+     * The function returns the value of the protected variable _cols.
+     * @returns The number of columns.
+     */
     get cols() {
         return this._cols;
     }
+    /**
+     * The function returns a two-dimensional array of numbers.
+     * @returns The data property, which is a two-dimensional array of numbers.
+     */
     get data() {
         return this._data;
     }
+    /**
+     * The above function returns the value of the _addFn property.
+     * @returns The value of the property `_addFn` is being returned.
+     */
     get addFn() {
         return this._addFn;
     }
+    /**
+     * The function returns the value of the _subtractFn property.
+     * @returns The `_subtractFn` property is being returned.
+     */
     get subtractFn() {
         return this._subtractFn;
     }
+    /**
+     * The function returns the value of the _multiplyFn property.
+     * @returns The `_multiplyFn` property is being returned.
+     */
     get multiplyFn() {
         return this._multiplyFn;
     }
@@ -332,17 +356,6 @@ class Matrix {
             multiplyFn: this.multiplyFn
         });
     }
-    _addFn(a, b) {
-        if (a === undefined)
-            return b;
-        return a + b;
-    }
-    _subtractFn(a, b) {
-        return a - b;
-    }
-    _multiplyFn(a, b) {
-        return a * b;
-    }
     /**
      * The function checks if a given row and column index is valid within a specified range.
      * @param {number} row - The `row` parameter represents the row index of a two-dimensional array or
@@ -354,6 +367,32 @@ class Matrix {
     isValidIndex(row, col) {
         return row >= 0 && row < this.rows && col >= 0 && col < this.cols;
     }
+    /**
+     * The `clone` function returns a new instance of the Matrix class with the same data and properties
+     * as the original instance.
+     * @returns The `clone()` method is returning a new instance of the `Matrix` class with the same data
+     * and properties as the current instance.
+     */
+    clone() {
+        return new Matrix(this.data, {
+            rows: this.rows,
+            cols: this.cols,
+            addFn: this.addFn,
+            subtractFn: this.subtractFn,
+            multiplyFn: this.multiplyFn
+        });
+    }
+    _addFn(a, b) {
+        if (a === undefined)
+            return b;
+        return a + b;
+    }
+    _subtractFn(a, b) {
+        return a - b;
+    }
+    _multiplyFn(a, b) {
+        return a * b;
+    }
     /**
      * The function `_swapRows` swaps the positions of two rows in an array.
      * @param {number} row1 - The `row1` parameter is the index of the first row that you want to swap.

package/dist/data-structures/priority-queue/max-priority-queue.d.ts

@@ -8,5 +8,15 @@
 import type { PriorityQueueOptions } from '../../types';
 import { PriorityQueue } from './priority-queue';
 export declare class MaxPriorityQueue<E = any> extends PriorityQueue<E> {
+    /**
+     * The constructor initializes a PriorityQueue with optional elements and options, including a
+     * comparator function.
+     * @param elements - The `elements` parameter is an iterable object that contains the initial
+     * elements to be added to the priority queue. It is optional and defaults to an empty array if not
+     * provided.
+     * @param options - The `options` parameter is an object that contains additional configuration
+     * options for the priority queue. In this case, it has a property called `comparator` which is a
+     * function used to compare elements in the priority queue.
+     */
     constructor(elements?: Iterable<E>, options?: PriorityQueueOptions<E>);
 }

package/dist/data-structures/priority-queue/max-priority-queue.js

@@ -3,6 +3,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MaxPriorityQueue = void 0;
 const priority_queue_1 = require("./priority-queue");
 class MaxPriorityQueue extends priority_queue_1.PriorityQueue {
+    /**
+     * The constructor initializes a PriorityQueue with optional elements and options, including a
+     * comparator function.
+     * @param elements - The `elements` parameter is an iterable object that contains the initial
+     * elements to be added to the priority queue. It is optional and defaults to an empty array if not
+     * provided.
+     * @param options - The `options` parameter is an object that contains additional configuration
+     * options for the priority queue. In this case, it has a property called `comparator` which is a
+     * function used to compare elements in the priority queue.
+     */
     constructor(elements = [], options = {
         comparator: (a, b) => {
             if (!(typeof a === 'number' && typeof b === 'number')) {

package/dist/data-structures/priority-queue/min-priority-queue.d.ts

@@ -8,5 +8,16 @@
 import type { PriorityQueueOptions } from '../../types';
 import { PriorityQueue } from './priority-queue';
 export declare class MinPriorityQueue<E = any> extends PriorityQueue<E> {
+    /**
+     * The constructor initializes a PriorityQueue with optional elements and options, including a
+     * comparator function.
+     * @param elements - The `elements` parameter is an iterable object that contains the initial
+     * elements to be added to the priority queue. It is optional and defaults to an empty array if not
+     * provided.
+     * @param options - The `options` parameter is an object that contains additional configuration
+     * options for the priority queue. In this case, it has a property called `comparator` which is a
+     * function used to compare elements in the priority queue. The `comparator` function takes two
+     * parameters `a` and `b`,
+     */
     constructor(elements?: Iterable<E>, options?: PriorityQueueOptions<E>);
 }

package/dist/data-structures/priority-queue/min-priority-queue.js

@@ -3,6 +3,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MinPriorityQueue = void 0;
 const priority_queue_1 = require("./priority-queue");
 class MinPriorityQueue extends priority_queue_1.PriorityQueue {
+    /**
+     * The constructor initializes a PriorityQueue with optional elements and options, including a
+     * comparator function.
+     * @param elements - The `elements` parameter is an iterable object that contains the initial
+     * elements to be added to the priority queue. It is optional and defaults to an empty array if not
+     * provided.
+     * @param options - The `options` parameter is an object that contains additional configuration
+     * options for the priority queue. In this case, it has a property called `comparator` which is a
+     * function used to compare elements in the priority queue. The `comparator` function takes two
+     * parameters `a` and `b`,
+     */
     constructor(elements = [], options = {
         comparator: (a, b) => {
             if (!(typeof a === 'number' && typeof b === 'number')) {

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

@@ -16,5 +16,13 @@ import { Heap } from '../heap';
  * 6. Kth Largest Element in a Data Stream: Used to maintain a min-heap of size K for quickly finding the Kth largest element in stream data
  */
 export declare class PriorityQueue<E = any> extends Heap<E> {
+    /**
+     * The constructor initializes a priority queue with optional elements and options.
+     * @param elements - The `elements` parameter is an iterable object that contains the initial
+     * elements to be added to the priority queue. It is an optional parameter and if not provided, the
+     * priority queue will be initialized as empty.
+     * @param [options] - The `options` parameter is an optional object that can be used to customize the
+     * behavior of the priority queue. It can contain the following properties:
+     */
     constructor(elements?: Iterable<E>, options?: PriorityQueueOptions<E>);
 }

package/dist/data-structures/priority-queue/priority-queue.js

@@ -11,6 +11,14 @@ const heap_1 = require("../heap");
  * 6. Kth Largest Element in a Data Stream: Used to maintain a min-heap of size K for quickly finding the Kth largest element in stream data
  */
 class PriorityQueue extends heap_1.Heap {
+    /**
+     * The constructor initializes a priority queue with optional elements and options.
+     * @param elements - The `elements` parameter is an iterable object that contains the initial
+     * elements to be added to the priority queue. It is an optional parameter and if not provided, the
+     * priority queue will be initialized as empty.
+     * @param [options] - The `options` parameter is an optional object that can be used to customize the
+     * behavior of the priority queue. It can contain the following properties:
+     */
     constructor(elements = [], options) {
         super(elements, options);
     }