data-structure-typed 0.8.18 → 1.12.9

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

@@ -1,17 +1,41 @@
 "use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ArrayDeque = exports.ObjectDeque = exports.Deque = void 0;
-const linked_list_1 = require("../linked-list");
+/**
+ * @copyright 2030 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT
+ */
+var linked_list_1 = require("../linked-list");
 // O(n) time complexity of obtaining the value
 // O(1) time complexity of adding at the beginning and the end
-class Deque extends linked_list_1.DoublyLinkedList {
-}
+var Deque = /** @class */ (function (_super) {
+    __extends(Deque, _super);
+    function Deque() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    return Deque;
+}(linked_list_1.DoublyLinkedList));
 exports.Deque = Deque;
 // O(1) time complexity of obtaining the value
 // O(n) time complexity of adding at the beginning and the end
 // todo tested slowest one
-class ObjectDeque {
-    constructor(capacity) {
+var ObjectDeque = /** @class */ (function () {
+    function ObjectDeque(capacity) {
         this._nodes = {};
         this._capacity = Number.MAX_SAFE_INTEGER;
         this._first = -1;
@@ -20,12 +44,12 @@ class ObjectDeque {
         if (capacity !== undefined)
             this._capacity = capacity;
     }
-    size() {
+    ObjectDeque.prototype.size = function () {
         return this._size;
-    }
-    offerFirst(value) {
+    };
+    ObjectDeque.prototype.offerFirst = function (value) {
         if (this._size === 0) {
-            const mid = Math.floor(this._capacity / 2);
+            var mid = Math.floor(this._capacity / 2);
             this._first = mid;
             this._last = mid;
         }
@@ -34,10 +58,10 @@ class ObjectDeque {
         }
         this._nodes[this._first] = value;
         this._size++;
-    }
-    offerLast(value) {
+    };
+    ObjectDeque.prototype.offerLast = function (value) {
         if (this._size === 0) {
-            const mid = Math.floor(this._capacity / 2);
+            var mid = Math.floor(this._capacity / 2);
             this._first = mid;
             this._last = mid;
         }
@@ -46,87 +70,158 @@ class ObjectDeque {
         }
         this._nodes[this._last] = value;
         this._size++;
-    }
-    pollFirst() {
+    };
+    ObjectDeque.prototype.pollFirst = function () {
         if (!this._size)
             return;
-        let value = this.peekFirst();
+        var value = this.peekFirst();
         delete this._nodes[this._first];
         this._first++;
         this._size--;
         return value;
-    }
-    peekFirst() {
+    };
+    ObjectDeque.prototype.peekFirst = function () {
         if (this._size)
             return this._nodes[this._first];
-    }
-    pollLast() {
+    };
+    ObjectDeque.prototype.pollLast = function () {
         if (!this._size)
             return;
-        let value = this.peekLast();
+        var value = this.peekLast();
         delete this._nodes[this._last];
         this._last--;
         this._size--;
         return value;
-    }
-    peekLast() {
+    };
+    ObjectDeque.prototype.peekLast = function () {
         if (this._size)
             return this._nodes[this._last];
-    }
-    get(index) {
+    };
+    ObjectDeque.prototype.get = function (index) {
         return this._nodes[this._first + index] || null;
-    }
-    isEmpty() {
+    };
+    ObjectDeque.prototype.isEmpty = function () {
         return this._size <= 0;
-    }
-}
+    };
+    return ObjectDeque;
+}());
 exports.ObjectDeque = ObjectDeque;
 // O(1) time complexity of obtaining the value
 // O(n) time complexity of adding at the beginning and the end
-class ArrayDeque {
-    constructor() {
+var ArrayDeque = /** @class */ (function () {
+    function ArrayDeque() {
         this._nodes = [];
     }
-    get size() {
-        return this._nodes.length;
-    }
-    offerLast(value) {
+    Object.defineProperty(ArrayDeque.prototype, "size", {
+        get: function () {
+            return this._nodes.length;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * The function "offerLast" adds a value to the end of an array.
+     * @param {T} value - The value parameter represents the value that you want to add to the end of the array.
+     * @returns The return value is the new length of the array after the value has been added.
+     */
+    ArrayDeque.prototype.offerLast = function (value) {
         return this._nodes.push(value);
-    }
-    pollLast() {
+    };
+    /**
+     * The function "pollLast" returns and removes the last element from an array, or returns null if the array is empty.
+     * @returns The method `pollLast()` returns the last element of the `_nodes` array, or `null` if the array is empty.
+     */
+    ArrayDeque.prototype.pollLast = function () {
         var _a;
         return (_a = this._nodes.pop()) !== null && _a !== void 0 ? _a : null;
-    }
-    pollFirst() {
+    };
+    /**
+     * The `pollFirst` function removes and returns the first element from an array, or returns null if the array is empty.
+     * @returns The `pollFirst()` function returns the first element of the `_nodes` array, or `null` if the array is
+     * empty.
+     */
+    ArrayDeque.prototype.pollFirst = function () {
         var _a;
         return (_a = this._nodes.shift()) !== null && _a !== void 0 ? _a : null;
-    }
-    offerFirst(value) {
+    };
+    /**
+     * The function "offerFirst" adds a value to the beginning of an array.
+     * @param {T} value - The value parameter represents the value that you want to add to the beginning of the array.
+     * @returns The return value of the `offerFirst` function is the new length of the array `_nodes` after adding the
+     * `value` at the beginning.
+     */
+    ArrayDeque.prototype.offerFirst = function (value) {
         return this._nodes.unshift(value);
-    }
-    peekFirst() {
+    };
+    /**
+     * The `peekFirst` function returns the first element of an array or null if the array is empty.
+     * @returns The function `peekFirst()` is returning the first element (`T`) of the `_nodes` array. If the array is
+     * empty, it will return `null`.
+     */
+    ArrayDeque.prototype.peekFirst = function () {
         var _a;
         return (_a = this._nodes[0]) !== null && _a !== void 0 ? _a : null;
-    }
-    peekLast() {
+    };
+    /**
+     * The `peekLast` function returns the last element of an array or null if the array is empty.
+     * @returns The method `peekLast()` returns the last element of the `_nodes` array, or `null` if the array is empty.
+     */
+    ArrayDeque.prototype.peekLast = function () {
         var _a;
         return (_a = this._nodes[this._nodes.length - 1]) !== null && _a !== void 0 ? _a : null;
-    }
-    get(index) {
+    };
+    /**
+     * The get function returns the element at the specified index in an array, or null if the index is out of bounds.
+     * @param {number} index - The index parameter is a number that represents the position of the element you want to
+     * retrieve from the array.
+     * @returns The method is returning the element at the specified index in the `_nodes` array. If the element exists, it
+     * will be returned. If the element does not exist (i.e., the index is out of bounds), `null` will be returned.
+     */
+    ArrayDeque.prototype.get = function (index) {
         var _a;
         return (_a = this._nodes[index]) !== null && _a !== void 0 ? _a : null;
-    }
-    set(index, value) {
+    };
+    /**
+     * The set function assigns a value to a specific index in an array.
+     * @param {number} index - The index parameter is a number that represents the position of the element in the array
+     * that you want to set a new value for.
+     * @param {T} value - The value parameter represents the new value that you want to set at the specified index in the
+     * _nodes array.
+     * @returns The value that is being set at the specified index in the `_nodes` array.
+     */
+    ArrayDeque.prototype.set = function (index, value) {
         return this._nodes[index] = value;
-    }
-    insert(index, value) {
+    };
+    /**
+     * The insert function adds a value at a specified index in an array.
+     * @param {number} index - The index parameter specifies the position at which the value should be inserted in the
+     * array. It is a number that represents the index of the array where the value should be inserted. The index starts
+     * from 0, so the first element of the array has an index of 0, the second element has
+     * @param {T} value - The value parameter represents the value that you want to insert into the array at the specified
+     * index.
+     * @returns The splice method returns an array containing the removed elements, if any. In this case, since no elements
+     * are being removed, an empty array will be returned.
+     */
+    ArrayDeque.prototype.insert = function (index, value) {
         return this._nodes.splice(index, 0, value);
-    }
-    remove(index) {
+    };
+    /**
+     * The remove function removes an element from an array at a specified index.
+     * @param {number} index - The index parameter specifies the position of the element to be removed from the array. It
+     * is a number that represents the index of the element to be removed.
+     * @returns The method is returning an array containing the removed element.
+     */
+    ArrayDeque.prototype.remove = function (index) {
         return this._nodes.splice(index, 1);
-    }
-    isEmpty() {
+    };
+    /**
+     * The function checks if an array called "_nodes" is empty.
+     * @returns The method `isEmpty()` is returning a boolean value. It returns `true` if the length of the `_nodes` array
+     * is 0, indicating that the array is empty. Otherwise, it returns `false`.
+     */
+    ArrayDeque.prototype.isEmpty = function () {
         return this._nodes.length === 0;
-    }
-}
+    };
+    return ArrayDeque;
+}());
 exports.ArrayDeque = ArrayDeque;

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

@@ -1,76 +1,73 @@
 /**
  * @license MIT
- * @copyright 2020 Pablo
- *
+ * @copyright 2030 Tyler Zeng <zrwusa@gmail.com>
  * @class
  */
 export declare class Queue<T> {
     protected _nodes: T[];
     protected _offset: number;
     /**
-     * Creates a queue.
-     * @param {array} [elements]
+     * The constructor initializes an instance of a class with an optional array of elements and sets the offset to 0.
+     * @param {T[]} [elements] - The `elements` parameter is an optional array of elements of type `T`. If provided, it
+     * will be used to initialize the `_nodes` property of the class. If not provided, the `_nodes` property will be
+     * initialized as an empty array.
      */
     constructor(elements?: T[]);
     /**
-     * Adds an element at the back of the queue.
+     * The function "fromArray" creates a new Queue object from an array of elements.Creates a queue from an existing array.
      * @public
-     * @param {any} element
+     * @static
+     * @param {T[]} elements - The "elements" parameter is an array of elements of type T.
+     * @returns The method is returning a new instance of the Queue class, initialized with the elements from the input
+     * array.
+     */
+    static fromArray<T>(elements: T[]): Queue<T>;
+    /**
+     * The offer function adds an element to the end of the queue and returns the updated queue.Adds an element at the back of the queue.
+     * @param {T} element - The `element` parameter represents the element that you want to add to the queue.
+     * @returns The `offer` method is returning a `Queue<T>` object.
      */
     offer(element: T): Queue<T>;
     /**
-     * Dequeues the front element in the queue.
-     * @public
-     * @returns {any}
+     * The `poll` function removes and returns the first element in the queue, and adjusts the internal data structure if
+     * necessary to optimize performance.
+     * @returns The function `poll()` returns either the first element in the queue or `null` if the queue is empty.
      */
     poll(): T | null;
     /**
-     * Returns the front element of the queue.
-     * @public
-     * @returns {any}
+     * The `peek` function returns the first element of the array `_nodes` if it exists, otherwise it returns `null`.
+     * @returns The `peek()` method returns the first element of the data structure, represented by the `_nodes` array at
+     * the `_offset` index. If the data structure is empty (size is 0), it returns `null`.
      */
     peek(): T | null;
     /**
-     * Returns the back element of the queue.
-     * @public
-     * @returns {any}
+     * The `peekLast` function returns the last element in an array-like data structure, or null if the structure is empty.
+     * @returns The method `peekLast()` returns the last element of the `_nodes` array if the array is not empty. If the
+     * array is empty, it returns `null`.
      */
     peekLast(): T | null;
     /**
-     * Returns the number of elements in the queue.
-     * @public
-     * @returns {number}
+     * The size function returns the number of elements in an array.
+     * @returns {number} The size of the array, which is the difference between the length of the array and the offset.
      */
     size(): number;
     /**
-     * Checks if the queue is empty.
-     * @public
-     * @returns {boolean}
+     * The function checks if a data structure is empty by comparing its size to zero.
+     * @returns {boolean} A boolean value indicating whether the size of the object is 0 or not.
      */
     isEmpty(): boolean;
     /**
-     * Returns the remaining elements in the queue as an array.
-     * @public
-     * @returns {array}
+     * The toArray() function returns an array of elements from the current offset to the end of the _nodes array.
+     * @returns An array of type T is being returned.
      */
     toArray(): T[];
     /**
-     * Clears the queue.
-     * @public
+     * The clear function resets the nodes array and offset to their initial values.
      */
     clear(): void;
     /**
-     * Creates a shallow copy of the queue.
-     * @public
-     * @return {Queue}
+     * The `clone()` function returns a new Queue object with the same elements as the original Queue.
+     * @returns The `clone()` method is returning a new instance of the `Queue` class.
      */
     clone(): Queue<T>;
-    /**
-     * Creates a queue from an existing array.
-     * @public
-     * @static
-     * @param {array} elements
-     * @return {Queue}
-     */
-    static fromArray<T>(elements: T[]): Queue<T>;
 }

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

@@ -3,37 +3,49 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Queue = void 0;
 /**
  * @license MIT
- * @copyright 2020 Pablo
- *
+ * @copyright 2030 Tyler Zeng <zrwusa@gmail.com>
  * @class
  */
-class Queue {
+var Queue = /** @class */ (function () {
     /**
-     * Creates a queue.
-     * @param {array} [elements]
+     * The constructor initializes an instance of a class with an optional array of elements and sets the offset to 0.
+     * @param {T[]} [elements] - The `elements` parameter is an optional array of elements of type `T`. If provided, it
+     * will be used to initialize the `_nodes` property of the class. If not provided, the `_nodes` property will be
+     * initialized as an empty array.
      */
-    constructor(elements) {
+    function Queue(elements) {
         this._nodes = elements || [];
         this._offset = 0;
     }
     /**
-     * Adds an element at the back of the queue.
+     * The function "fromArray" creates a new Queue object from an array of elements.Creates a queue from an existing array.
      * @public
-     * @param {any} element
+     * @static
+     * @param {T[]} elements - The "elements" parameter is an array of elements of type T.
+     * @returns The method is returning a new instance of the Queue class, initialized with the elements from the input
+     * array.
+     */
+    Queue.fromArray = function (elements) {
+        return new Queue(elements);
+    };
+    /**
+     * The offer function adds an element to the end of the queue and returns the updated queue.Adds an element at the back of the queue.
+     * @param {T} element - The `element` parameter represents the element that you want to add to the queue.
+     * @returns The `offer` method is returning a `Queue<T>` object.
      */
-    offer(element) {
+    Queue.prototype.offer = function (element) {
         this._nodes.push(element);
         return this;
-    }
+    };
     /**
-     * Dequeues the front element in the queue.
-     * @public
-     * @returns {any}
+     * The `poll` function removes and returns the first element in the queue, and adjusts the internal data structure if
+     * necessary to optimize performance.
+     * @returns The function `poll()` returns either the first element in the queue or `null` if the queue is empty.
      */
-    poll() {
+    Queue.prototype.poll = function () {
         if (this.size() === 0)
             return null;
-        const first = this.peek();
+        var first = this.peek();
         this._offset += 1;
         if (this._offset * 2 < this._nodes.length)
             return first;
@@ -42,72 +54,58 @@ class Queue {
         this._nodes = this._nodes.slice(this._offset);
         this._offset = 0;
         return first;
-    }
+    };
     /**
-     * Returns the front element of the queue.
-     * @public
-     * @returns {any}
+     * The `peek` function returns the first element of the array `_nodes` if it exists, otherwise it returns `null`.
+     * @returns The `peek()` method returns the first element of the data structure, represented by the `_nodes` array at
+     * the `_offset` index. If the data structure is empty (size is 0), it returns `null`.
      */
-    peek() {
+    Queue.prototype.peek = function () {
         return this.size() > 0 ? this._nodes[this._offset] : null;
-    }
+    };
     /**
-     * Returns the back element of the queue.
-     * @public
-     * @returns {any}
+     * The `peekLast` function returns the last element in an array-like data structure, or null if the structure is empty.
+     * @returns The method `peekLast()` returns the last element of the `_nodes` array if the array is not empty. If the
+     * array is empty, it returns `null`.
      */
-    peekLast() {
+    Queue.prototype.peekLast = function () {
         return this.size() > 0 ? this._nodes[this._nodes.length - 1] : null;
-    }
+    };
     /**
-     * Returns the number of elements in the queue.
-     * @public
-     * @returns {number}
+     * The size function returns the number of elements in an array.
+     * @returns {number} The size of the array, which is the difference between the length of the array and the offset.
      */
-    size() {
+    Queue.prototype.size = function () {
         return this._nodes.length - this._offset;
-    }
+    };
     /**
-     * Checks if the queue is empty.
-     * @public
-     * @returns {boolean}
+     * The function checks if a data structure is empty by comparing its size to zero.
+     * @returns {boolean} A boolean value indicating whether the size of the object is 0 or not.
      */
-    isEmpty() {
+    Queue.prototype.isEmpty = function () {
         return this.size() === 0;
-    }
+    };
     /**
-     * Returns the remaining elements in the queue as an array.
-     * @public
-     * @returns {array}
+     * The toArray() function returns an array of elements from the current offset to the end of the _nodes array.
+     * @returns An array of type T is being returned.
      */
-    toArray() {
+    Queue.prototype.toArray = function () {
         return this._nodes.slice(this._offset);
-    }
+    };
     /**
-     * Clears the queue.
-     * @public
+     * The clear function resets the nodes array and offset to their initial values.
      */
-    clear() {
+    Queue.prototype.clear = function () {
         this._nodes = [];
         this._offset = 0;
-    }
+    };
     /**
-     * Creates a shallow copy of the queue.
-     * @public
-     * @return {Queue}
+     * The `clone()` function returns a new Queue object with the same elements as the original Queue.
+     * @returns The `clone()` method is returning a new instance of the `Queue` class.
      */
-    clone() {
+    Queue.prototype.clone = function () {
         return new Queue(this._nodes.slice(this._offset));
-    }
-    /**
-     * Creates a queue from an existing array.
-     * @public
-     * @static
-     * @param {array} elements
-     * @return {Queue}
-     */
-    static fromArray(elements) {
-        return new Queue(elements);
-    }
-}
+    };
+    return Queue;
+}());
 exports.Queue = Queue;

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

@@ -1,69 +1,63 @@
 /**
  * @license MIT
- * @copyright 2020 Pablo Rios <zrwusa@gmail.com>
- *
+ * @copyright 2030 Tyler Zeng <zrwusa@gmail.com>
  * @class
  */
 export declare class Stack<T> {
     protected _elements: T[];
     /**
-     * Creates a stack.
-     * @param {array} [elements]
+     * The constructor initializes an array of elements, which can be provided as an optional parameter.
+     * @param {T[]} [elements] - The `elements` parameter is an optional parameter of type `T[]`, which represents an array
+     * of elements of type `T`. It is used to initialize the `_elements` property of the class. If the `elements` parameter
+     * is provided and is an array, it is assigned to the `_elements
      */
     constructor(elements?: T[]);
     /**
-     * Checks if the stack is empty.
-     * @public
-     * @returns {boolean}
+     * The function "fromArray" creates a new Stack object from an array of elements.
+     * @param {T[]} elements - The `elements` parameter is an array of elements of type `T`.
+     * @returns {Stack} The method is returning a new instance of the Stack class, initialized with the elements from the input
+     * array.
+     */
+    static fromArray<T>(elements: T[]): Stack<T>;
+    /**
+     * The function checks if an array is empty and returns a boolean value.
+     * @returns A boolean value indicating whether the `_elements` array is empty or not.
      */
     isEmpty(): boolean;
     /**
-     * Returns the number of elements in the stack.
-     * @public
-     * @returns {number}
+     * The size() function returns the number of elements in an array.
+     * @returns The size of the elements array.
      */
     size(): number;
     /**
-     * Returns the top element in the stack.
-     * @public
-     * @returns {object}
+     * The `peek` function returns the last element of an array, or null if the array is empty.
+     * @returns The `peek()` function returns the last element of the `_elements` array, or `null` if the array is empty.
      */
     peek(): T | null;
     /**
-     * Adds an element to the top of the stack.
-     * @public
-     * @param {object} element
+     * The push function adds an element to the stack and returns the updated stack.
+     * @param {T} element - The parameter "element" is of type T, which means it can be any data type.
+     * @returns The `push` method is returning the updated `Stack<T>` object.
      */
     push(element: T): Stack<T>;
     /**
-     * Removes and returns the top element in the stack.
-     * @public
-     * @returns {object}
+     * The `pop` function removes and returns the last element from an array, or returns null if the array is empty.
+     * @returns The `pop()` method is returning the last element of the array `_elements` if the array is not empty. If the
+     * array is empty, it returns `null`.
      */
     pop(): T | null;
     /**
-     * Returns the remaining elements as an array.
-     * @public
-     * @returns {array}
+     * The toArray function returns a copy of the elements in an array.
+     * @returns An array of type T.
      */
     toArray(): T[];
     /**
-     * Clears all elements from the stack.
-     * @public
+     * The clear function clears the elements array.
      */
     clear(): void;
     /**
-     * Creates a shallow copy from the stack.
-     * @public
-     * @return {Stack}
+     * The `clone()` function returns a new `Stack` object with the same elements as the original stack.
+     * @returns The `clone()` method is returning a new `Stack` object with a copy of the `_elements` array.
      */
     clone(): Stack<T>;
-    /**
-     * Creates a stack from an existing array
-     * @public
-     * @static
-     * @param {array} [elements]
-     * @return {Stack}
-     */
-    static fromArray<T>(elements: T[]): Stack<T>;
 }