min-heap-typed 1.50.2 → 1.50.3

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

@@ -9,8 +9,39 @@ class SinglyLinkedListNode {
      * will be stored in the node of a linked list.
      */
     constructor(value) {
-        this.value = value;
-        this.next = undefined;
+        this._value = value;
+        this._next = undefined;
+    }
+    /**
+     * The function returns the value of a protected variable.
+     * @returns The value of the variable `_value` is being returned.
+     */
+    get value() {
+        return this._value;
+    }
+    /**
+     * 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) {
+        this._value = value;
+    }
+    /**
+     * The `next` function returns the next node in a singly linked list.
+     * @returns The `next` property is being returned. It can be either a `SinglyLinkedListNode<E>`
+     * object or `undefined`.
+     */
+    get next() {
+        return this._next;
+    }
+    /**
+     * The "next" property of a SinglyLinkedListNode is set to the provided value.
+     * @param {SinglyLinkedListNode<E> | undefined} value - The `value` parameter is of type
+     * `SinglyLinkedListNode<E> | undefined`. This means that it can accept either a
+     * `SinglyLinkedListNode` object or `undefined` as its value.
+     */
+    set next(value) {
+        this._next = value;
     }
 }
 exports.SinglyLinkedListNode = SinglyLinkedListNode;
@@ -656,7 +687,7 @@ class SinglyLinkedList extends base_1.IterableElementBase {
         return filteredList;
     }
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(n)
      * Space Complexity: O(n)
      */
     /**

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

@@ -30,7 +30,7 @@ export declare class SkipList<K, V> {
     get head(): SkipListNode<K, V>;
     protected _level: number;
     /**
-     * The function returns the value of the private variable _level.
+     * The function returns the value of the protected variable _level.
      * @returns The level property of the object.
      */
     get level(): number;
@@ -43,7 +43,7 @@ export declare class SkipList<K, V> {
     protected _probability: number;
     /**
      * The function returns the probability value.
-     * @returns The probability value stored in the private variable `_probability` is being returned.
+     * @returns The probability value stored in the protected variable `_probability` is being returned.
      */
     get probability(): number;
     /**

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

@@ -43,7 +43,7 @@ class SkipList {
         return this._head;
     }
     /**
-     * The function returns the value of the private variable _level.
+     * The function returns the value of the protected variable _level.
      * @returns The level property of the object.
      */
     get level() {
@@ -58,7 +58,7 @@ class SkipList {
     }
     /**
      * The function returns the probability value.
-     * @returns The probability value stored in the private variable `_probability` is being returned.
+     * @returns The probability value stored in the protected variable `_probability` is being returned.
      */
     get probability() {
         return this._probability;

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

@@ -23,7 +23,7 @@ export declare class Matrix {
     get rows(): number;
     protected _cols: number;
     /**
-     * The function returns the value of the private variable _cols.
+     * The function returns the value of the protected variable _cols.
      * @returns The number of columns.
      */
     get cols(): number;

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

@@ -52,7 +52,7 @@ class Matrix {
         return this._rows;
     }
     /**
-     * The function returns the value of the private variable _cols.
+     * The function returns the value of the protected variable _cols.
      * @returns The number of columns.
      */
     get cols() {

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);
     }

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

@@ -15,12 +15,6 @@ import { IterableElementBase } from '../base';
  * 5. Performance jitter: Deque may experience performance jitter, but DoublyLinkedList will not
  */
 export declare class Deque<E> extends IterableElementBase<E> {
-    protected _bucketFirst: number;
-    protected _firstInBucket: number;
-    protected _bucketLast: number;
-    protected _lastInBucket: number;
-    protected _bucketCount: number;
-    protected readonly _bucketSize: number;
     /**
      * The constructor initializes a Deque object with an optional iterable of elements and options.
      * @param elements - An iterable object (such as an array or a Set) that contains the initial
@@ -33,16 +27,48 @@ export declare class Deque<E> extends IterableElementBase<E> {
      * or is not a number
      */
     constructor(elements?: IterableWithSizeOrLength<E>, options?: DequeOptions);
+    protected _bucketSize: number;
     /**
      * The bucketSize function returns the size of the bucket.
      *
      * @return The size of the bucket
      */
     get bucketSize(): number;
+    protected _bucketFirst: number;
+    /**
+     * The function returns the value of the protected variable `_bucketFirst`.
+     * @returns The value of the `_bucketFirst` property.
+     */
+    get bucketFirst(): number;
+    protected _firstInBucket: number;
+    /**
+     * The function returns the value of the protected variable _firstInBucket.
+     * @returns The method is returning the value of the variable `_firstInBucket`, which is of type
+     * `number`.
+     */
+    get firstInBucket(): number;
+    protected _bucketLast: number;
+    /**
+     * The function returns the value of the protected variable `_bucketLast`.
+     * @returns The value of the `_bucketLast` property, which is a number.
+     */
+    get bucketLast(): number;
+    protected _lastInBucket: number;
+    /**
+     * The function returns the value of the protected variable _lastInBucket.
+     * @returns The method is returning the value of the variable `_lastInBucket`, which is of type
+     * `number`.
+     */
+    get lastInBucket(): number;
+    protected _bucketCount: number;
+    /**
+     * The function returns the number of buckets.
+     * @returns The number of buckets.
+     */
+    get bucketCount(): number;
     protected _buckets: E[][];
     /**
      * The buckets function returns the buckets property of the object.
-     *
      * @return The buckets property
      */
     get buckets(): E[][];
@@ -120,11 +146,25 @@ export declare class Deque<E> extends IterableElementBase<E> {
      */
     shift(): E | undefined;
     /**
-     * Time Complexity: O(1) - Removes the last element.
-     * Space Complexity: O(1) - Operates in-place.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
+     * The function checks if the size of an object is equal to zero and returns a boolean value.
+     * @returns A boolean value indicating whether the size of the object is 0 or not.
      */
     isEmpty(): boolean;
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The clear() function resets the state of the object by initializing all variables to their default
      * values.
      */
@@ -204,14 +244,33 @@ export declare class Deque<E> extends IterableElementBase<E> {
      * @returns The method is returning the updated size of the data structure.
      */
     cut(pos: number, isCutSelf?: boolean): Deque<E>;
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1) or O(n)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1) or O(n)
+     *
+     * The `cutRest` function cuts the elements from a specified position in a deque and returns a new
+     * deque with the cut elements.
+     * @param {number} pos - The `pos` parameter represents the position from which to cut the Deque. It
+     * is a number that indicates the index of the element in the Deque where the cut should start.
+     * @param [isCutSelf=false] - isCutSelf is a boolean parameter that determines whether the original
+     * Deque should be modified or a new Deque should be created. If isCutSelf is true, the original
+     * Deque will be modified by cutting off elements starting from the specified position. If isCutSelf
+     * is false, a new De
+     * @returns The function `cutRest` returns either the modified original deque (`this`) or a new deque
+     * (`newDeque`) depending on the value of the `isCutSelf` parameter.
+     */
     cutRest(pos: number, isCutSelf?: boolean): Deque<E>;
     /**
      * Time Complexity: O(n)
-     * Space Complexity: O(1)
+     * Space Complexity: O(1) or O(n)
      */
     /**
      * Time Complexity: O(n)
-     * Space Complexity: O(1)
+     * Space Complexity: O(1) or O(n)
      *
      * The `deleteAt` function removes an element at a specified position in an array-like data
      * structure.
@@ -378,8 +437,8 @@ export declare class Deque<E> extends IterableElementBase<E> {
      * Space Complexity: O(n) - Due to potential resizing.
      */
     /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(n) - In worst case, resizing doubles the array size.
+     * 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
@@ -387,20 +446,25 @@ export declare class Deque<E> extends IterableElementBase<E> {
      */
     addLast(element: E): boolean;
     /**
-     * Time Complexity: O(1) - Removes the first element.
-     * Space Complexity: O(1) - In-place operation.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(1) - Removes the last element.
-     * Space Complexity: O(1) - Operates in-place.
+     * 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(n) - Due to potential resizing.
+     * 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
@@ -408,8 +472,13 @@ export declare class Deque<E> extends IterableElementBase<E> {
      */
     addFirst(element: E): boolean;
     /**
-     * Time Complexity: O(1) - Removes the first element.
-     * Space Complexity: O(1) - In-place operation.
+     * 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
@@ -417,6 +486,11 @@ export declare class Deque<E> extends IterableElementBase<E> {
      */
     pollFirst(): E | undefined;
     /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
+     * /
+  
+     /**
      * Time Complexity: O(n)
      * Space Complexity: O(1)
      *

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

@@ -24,12 +24,12 @@ class Deque extends base_1.IterableElementBase {
      */
     constructor(elements = [], options) {
         super();
+        this._bucketSize = 1 << 12;
         this._bucketFirst = 0;
         this._firstInBucket = 0;
         this._bucketLast = 0;
         this._lastInBucket = 0;
         this._bucketCount = 0;
-        this._bucketSize = 1 << 12;
         this._buckets = [];
         this._size = 0;
         if (options) {
@@ -69,9 +69,45 @@ class Deque extends base_1.IterableElementBase {
     get bucketSize() {
         return this._bucketSize;
     }
+    /**
+     * The function returns the value of the protected variable `_bucketFirst`.
+     * @returns The value of the `_bucketFirst` property.
+     */
+    get bucketFirst() {
+        return this._bucketFirst;
+    }
+    /**
+     * The function returns the value of the protected variable _firstInBucket.
+     * @returns The method is returning the value of the variable `_firstInBucket`, which is of type
+     * `number`.
+     */
+    get firstInBucket() {
+        return this._firstInBucket;
+    }
+    /**
+     * The function returns the value of the protected variable `_bucketLast`.
+     * @returns The value of the `_bucketLast` property, which is a number.
+     */
+    get bucketLast() {
+        return this._bucketLast;
+    }
+    /**
+     * The function returns the value of the protected variable _lastInBucket.
+     * @returns The method is returning the value of the variable `_lastInBucket`, which is of type
+     * `number`.
+     */
+    get lastInBucket() {
+        return this._lastInBucket;
+    }
+    /**
+     * The function returns the number of buckets.
+     * @returns The number of buckets.
+     */
+    get bucketCount() {
+        return this._bucketCount;
+    }
     /**
      * The buckets function returns the buckets property of the object.
-     *
      * @return The buckets property
      */
     get buckets() {
@@ -236,13 +272,27 @@ class Deque extends base_1.IterableElementBase {
         return element;
     }
     /**
-     * Time Complexity: O(1) - Removes the last element.
-     * Space Complexity: O(1) - Operates in-place.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
+     * The function checks if the size of an object is equal to zero and returns a boolean value.
+     * @returns A boolean value indicating whether the size of the object is 0 or not.
      */
     isEmpty() {
         return this.size === 0;
     }
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The clear() function resets the state of the object by initializing all variables to their default
      * values.
      */
@@ -390,6 +440,25 @@ class Deque extends base_1.IterableElementBase {
             return newDeque;
         }
     }
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1) or O(n)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1) or O(n)
+     *
+     * The `cutRest` function cuts the elements from a specified position in a deque and returns a new
+     * deque with the cut elements.
+     * @param {number} pos - The `pos` parameter represents the position from which to cut the Deque. It
+     * is a number that indicates the index of the element in the Deque where the cut should start.
+     * @param [isCutSelf=false] - isCutSelf is a boolean parameter that determines whether the original
+     * Deque should be modified or a new Deque should be created. If isCutSelf is true, the original
+     * Deque will be modified by cutting off elements starting from the specified position. If isCutSelf
+     * is false, a new De
+     * @returns The function `cutRest` returns either the modified original deque (`this`) or a new deque
+     * (`newDeque`) depending on the value of the `isCutSelf` parameter.
+     */
     cutRest(pos, isCutSelf = false) {
         if (isCutSelf) {
             if (pos < 0) {
@@ -412,11 +481,11 @@ class Deque extends base_1.IterableElementBase {
     }
     /**
      * Time Complexity: O(n)
-     * Space Complexity: O(1)
+     * Space Complexity: O(1) or O(n)
      */
     /**
      * Time Complexity: O(n)
-     * Space Complexity: O(1)
+     * Space Complexity: O(1) or O(n)
      *
      * The `deleteAt` function removes an element at a specified position in an array-like data
      * structure.
@@ -703,8 +772,8 @@ class Deque extends base_1.IterableElementBase {
      * Space Complexity: O(n) - Due to potential resizing.
      */
     /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(n) - In worst case, resizing doubles the array size.
+     * 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
@@ -714,12 +783,12 @@ class Deque extends base_1.IterableElementBase {
         return this.push(element);
     }
     /**
-     * Time Complexity: O(1) - Removes the first element.
-     * Space Complexity: O(1) - In-place operation.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(1) - Removes the last element.
-     * Space Complexity: O(1) - Operates in-place.
+     * 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.
@@ -728,8 +797,13 @@ class Deque extends base_1.IterableElementBase {
         return this.pop();
     }
     /**
-     * Time Complexity: O(1).
-     * Space Complexity: O(n) - Due to potential resizing.
+     * 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
@@ -739,8 +813,13 @@ class Deque extends base_1.IterableElementBase {
         return this.unshift(element);
     }
     /**
-     * Time Complexity: O(1) - Removes the first element.
-     * Space Complexity: O(1) - In-place operation.
+     * 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
@@ -750,6 +829,11 @@ class Deque extends base_1.IterableElementBase {
         return this.shift();
     }
     /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
+     * /
+  
+     /**
      * Time Complexity: O(n)
      * Space Complexity: O(1)
      *