data-structure-typed 1.35.0 → 1.40.0-rc

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

@@ -1,10 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ArrayDeque = exports.ObjectDeque = exports.Deque = void 0;
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
 const 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 {
 }
 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) {
         this._nodes = {};
@@ -39,6 +51,11 @@ class ObjectDeque {
     get size() {
         return this._size;
     }
+    /**
+     * The "addFirst" function adds a value to the beginning of an array-like data structure.
+     * @param {E} value - The `value` parameter represents the value that you want to add to the beginning of the data
+     * structure.
+     */
     addFirst(value) {
         if (this._size === 0) {
             const mid = Math.floor(this._capacity / 2);
@@ -51,6 +68,10 @@ class ObjectDeque {
         this._nodes[this._first] = value;
         this._size++;
     }
+    /**
+     * The addLast function adds a value to the end of an array-like data structure.
+     * @param {E} value - The `value` parameter represents the value that you want to add to the end of the data structure.
+     */
     addLast(value) {
         if (this._size === 0) {
             const mid = Math.floor(this._capacity / 2);
@@ -63,6 +84,10 @@ class ObjectDeque {
         this._nodes[this._last] = value;
         this._size++;
     }
+    /**
+     * The function `pollFirst()` removes and returns the first element in a data structure.
+     * @returns The value of the first element in the data structure.
+     */
     pollFirst() {
         if (!this._size)
             return;
@@ -72,10 +97,18 @@ class ObjectDeque {
         this._size--;
         return value;
     }
+    /**
+     * The `peekFirst` function returns the first element in an array-like data structure if it exists.
+     * @returns The element at the first position of the `_nodes` array.
+     */
     peekFirst() {
         if (this._size)
             return this._nodes[this._first];
     }
+    /**
+     * The `pollLast()` function removes and returns the last element in a data structure.
+     * @returns The value that was removed from the data structure.
+     */
     pollLast() {
         if (!this._size)
             return;
@@ -85,13 +118,28 @@ class ObjectDeque {
         this._size--;
         return value;
     }
+    /**
+     * The `peekLast()` function returns the last element in an array-like data structure.
+     * @returns The last element in the array "_nodes" is being returned.
+     */
     peekLast() {
         if (this._size)
             return this._nodes[this._last];
     }
+    /**
+     * The get function returns the element at the specified index in an array-like data structure.
+     * @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 element at the specified index in the `_nodes` array is being returned. If there is no element at that
+     * index, `null` is returned.
+     */
     get(index) {
         return this._nodes[this._first + index] || null;
     }
+    /**
+     * The function checks if the size of a data structure is less than or equal to zero.
+     * @returns The method is returning a boolean value indicating whether the size of the object is less than or equal to 0.
+     */
     isEmpty() {
         return this._size <= 0;
     }
@@ -103,6 +151,8 @@ class 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() {
         this._nodes = [];
@@ -110,41 +160,115 @@ class ArrayDeque {
     get size() {
         return this._nodes.length;
     }
+    /**
+     * O(n) time complexity of adding at the beginning and the end
+     */
+    /**
+     * The function "addLast" adds a value to the end of an array.
+     * @param {E} 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.
+     */
     addLast(value) {
         return this._nodes.push(value);
     }
+    /**
+     * 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.
+     */
     pollLast() {
         var _a;
         return (_a = this._nodes.pop()) !== null && _a !== void 0 ? _a : null;
     }
+    /**
+     * 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.
+     */
     pollFirst() {
         var _a;
         return (_a = this._nodes.shift()) !== null && _a !== void 0 ? _a : null;
     }
+    /**
+     * O(n) time complexity of adding at the beginning and the end
+     */
+    /**
+     * The function "addFirst" adds a value to the beginning of an array.
+     * @param {E} value - The value parameter represents the value that you want to add to the beginning of the array.
+     * @returns The return value of the `addFirst` function is the new length of the array `_nodes` after adding the
+     * `value` at the beginning.
+     */
     addFirst(value) {
         return this._nodes.unshift(value);
     }
+    /**
+     * 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 (`E`) of the `_nodes` array. If the array is
+     * empty, it will return `null`.
+     */
     peekFirst() {
         var _a;
         return (_a = this._nodes[0]) !== null && _a !== void 0 ? _a : null;
     }
+    /**
+     * 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.
+     */
     peekLast() {
         var _a;
         return (_a = this._nodes[this._nodes.length - 1]) !== null && _a !== void 0 ? _a : null;
     }
+    /**
+     * O(1) time complexity of obtaining the value
+     */
+    /**
+     * 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.
+     */
     get(index) {
         var _a;
         return (_a = this._nodes[index]) !== null && _a !== void 0 ? _a : null;
     }
+    /**
+     * 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 {E} 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.
+     */
     set(index, value) {
         return (this._nodes[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 {E} 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.
+     */
     insert(index, value) {
         return this._nodes.splice(index, 0, value);
     }
+    /**
+     * 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.
+     */
     remove(index) {
         return this._nodes.splice(index, 1);
     }
+    /**
+     * 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`.
+     */
     isEmpty() {
         return this._nodes.length === 0;
     }

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

@@ -1 +1 @@
-{"version":3,"file":"deque.js","sourceRoot":"","sources":["../../../src/data-structures/queue/deque.ts"],"names":[],"mappings":";;;AAOA,gDAAgD;AAIhD,MAAa,KAAe,SAAQ,8BAAmB;CAAG;AAA1D,sBAA0D;AAK1D,MAAa,WAAW;IACtB,YAAY,QAAiB;QAIrB,WAAM,GAAuB,EAAE,CAAC;QAMhC,cAAS,GAAG,MAAM,CAAC,gBAAgB,CAAC;QAUpC,WAAM,GAAG,CAAC,CAAC,CAAC;QAUZ,UAAK,GAAG,CAAC,CAAC,CAAC;QAUX,UAAK,GAAG,CAAC,CAAC;QAvChB,IAAI,QAAQ,KAAK,SAAS;YAAE,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IACxD,CAAC;IAID,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAID,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,IAAI,QAAQ,CAAC,KAAa;QACxB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;IACzB,CAAC;IAID,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAI,KAAK,CAAC,KAAa;QACrB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAID,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,IAAI,IAAI,CAAC,KAAa;QACpB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAID,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAOD,QAAQ,CAAC,KAAQ;QACf,IAAI,IAAI,CAAC,KAAK,KAAK,CAAC,EAAE;YACpB,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC;YAC3C,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC;YAClB,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC;SAClB;aAAM;YACL,IAAI,CAAC,MAAM,EAAE,CAAC;SACf;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC;QACjC,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAMD,OAAO,CAAC,KAAQ;QACd,IAAI,IAAI,CAAC,KAAK,KAAK,CAAC,EAAE;YACpB,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC;YAC3C,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC;YAClB,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC;SAClB;aAAM;YACL,IAAI,CAAC,KAAK,EAAE,CAAC;SACd;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC;QAChC,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAMD,SAAS;QACP,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,OAAO;QACxB,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;QAC/B,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAChC,IAAI,CAAC,MAAM,EAAE,CAAC;QACd,IAAI,CAAC,KAAK,EAAE,CAAC;QACb,OAAO,KAAK,CAAC;IACf,CAAC;IAMD,SAAS;QACP,IAAI,IAAI,CAAC,KAAK;YAAE,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAClD,CAAC;IAMD,QAAQ;QACN,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,OAAO;QACxB,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC9B,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,IAAI,CAAC,KAAK,EAAE,CAAC;QACb,IAAI,CAAC,KAAK,EAAE,CAAC;QAEb,OAAO,KAAK,CAAC;IACf,CAAC;IAMD,QAAQ;QACN,IAAI,IAAI,CAAC,KAAK;YAAE,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACjD,CAAC;IASD,GAAG,CAAC,KAAa;QACf,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,IAAI,IAAI,CAAC;IAClD,CAAC;IAMD,OAAO;QACL,OAAO,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC;IACzB,CAAC;IAES,QAAQ,CAAC,KAAuB;QACxC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAES,QAAQ,CAAC,KAAa;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF;AArJD,kCAqJC;AAID,MAAa,UAAU;IAAvB;QACY,WAAM,GAAQ,EAAE,CAAC;IA8H7B,CAAC;IA5HC,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;IAC5B,CAAC;IAWD,OAAO,CAAC,KAAQ;QACd,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;IAMD,QAAQ;;QACN,OAAO,MAAA,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,mCAAI,IAAI,CAAC;IACnC,CAAC;IAOD,SAAS;;QACP,OAAO,MAAA,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,mCAAI,IAAI,CAAC;IACrC,CAAC;IAYD,QAAQ,CAAC,KAAQ;QACf,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;IAOD,SAAS;;QACP,OAAO,MAAA,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,mCAAI,IAAI,CAAC;IAChC,CAAC;IAMD,QAAQ;;QACN,OAAO,MAAA,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,mCAAI,IAAI,CAAC;IACrD,CAAC;IAaD,GAAG,CAAC,KAAa;;QACf,OAAO,MAAA,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,mCAAI,IAAI,CAAC;IACpC,CAAC;IAUD,GAAG,CAAC,KAAa,EAAE,KAAQ;QACzB,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,CAAC;IACtC,CAAC;IAYD,MAAM,CAAC,KAAa,EAAE,KAAQ;QAC5B,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;IAC7C,CAAC;IAQD,MAAM,CAAC,KAAa;QAClB,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IACtC,CAAC;IAOD,OAAO;QACL,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC;IAClC,CAAC;CACF;AA/HD,gCA+HC"}
+{"version":3,"file":"deque.js","sourceRoot":"","sources":["../../../src/data-structures/queue/deque.ts"],"names":[],"mappings":";;;AAAA;;;;;;GAMG;AACH,gDAAgD;AAEhD,8CAA8C;AAC9C,8DAA8D;AAC9D,MAAa,KAAe,SAAQ,8BAAmB;CAAG;AAA1D,sBAA0D;AAE1D,8CAA8C;AAC9C,8DAA8D;AAC9D,0BAA0B;AAC1B,MAAa,WAAW;IACtB,YAAY,QAAiB;QAIrB,WAAM,GAAuB,EAAE,CAAC;QAMhC,cAAS,GAAG,MAAM,CAAC,gBAAgB,CAAC;QAUpC,WAAM,GAAG,CAAC,CAAC,CAAC;QAUZ,UAAK,GAAG,CAAC,CAAC,CAAC;QAUX,UAAK,GAAG,CAAC,CAAC;QAvChB,IAAI,QAAQ,KAAK,SAAS;YAAE,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IACxD,CAAC;IAID,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAID,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,IAAI,QAAQ,CAAC,KAAa;QACxB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;IACzB,CAAC;IAID,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAI,KAAK,CAAC,KAAa;QACrB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAID,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,IAAI,IAAI,CAAC,KAAa;QACpB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAID,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,KAAQ;QACf,IAAI,IAAI,CAAC,KAAK,KAAK,CAAC,EAAE;YACpB,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC;YAC3C,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC;YAClB,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC;SAClB;aAAM;YACL,IAAI,CAAC,MAAM,EAAE,CAAC;SACf;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC;QACjC,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAED;;;OAGG;IACH,OAAO,CAAC,KAAQ;QACd,IAAI,IAAI,CAAC,KAAK,KAAK,CAAC,EAAE;YACpB,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC;YAC3C,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC;YAClB,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC;SAClB;aAAM;YACL,IAAI,CAAC,KAAK,EAAE,CAAC;SACd;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC;QAChC,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAED;;;OAGG;IACH,SAAS;QACP,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,OAAO;QACxB,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;QAC/B,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAChC,IAAI,CAAC,MAAM,EAAE,CAAC;QACd,IAAI,CAAC,KAAK,EAAE,CAAC;QACb,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACH,SAAS;QACP,IAAI,IAAI,CAAC,KAAK;YAAE,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAClD,CAAC;IAED;;;OAGG;IACH,QAAQ;QACN,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,OAAO;QACxB,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC9B,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,IAAI,CAAC,KAAK,EAAE,CAAC;QACb,IAAI,CAAC,KAAK,EAAE,CAAC;QAEb,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACH,QAAQ;QACN,IAAI,IAAI,CAAC,KAAK;YAAE,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;OAMG;IACH,GAAG,CAAC,KAAa;QACf,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,IAAI,IAAI,CAAC;IAClD,CAAC;IAED;;;OAGG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC;IACzB,CAAC;IAES,QAAQ,CAAC,KAAuB;QACxC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAES,QAAQ,CAAC,KAAa;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF;AArJD,kCAqJC;AAED,8CAA8C;AAC9C,8DAA8D;AAC9D,MAAa,UAAU;IAAvB;QACY,WAAM,GAAQ,EAAE,CAAC;IA8H7B,CAAC;IA5HC,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;IAC5B,CAAC;IAED;;OAEG;IAEH;;;;OAIG;IACH,OAAO,CAAC,KAAQ;QACd,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;IAED;;;OAGG;IACH,QAAQ;;QACN,OAAO,MAAA,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,mCAAI,IAAI,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACH,SAAS;;QACP,OAAO,MAAA,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,mCAAI,IAAI,CAAC;IACrC,CAAC;IAED;;OAEG;IAEH;;;;;OAKG;IACH,QAAQ,CAAC,KAAQ;QACf,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACH,SAAS;;QACP,OAAO,MAAA,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,mCAAI,IAAI,CAAC;IAChC,CAAC;IAED;;;OAGG;IACH,QAAQ;;QACN,OAAO,MAAA,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,mCAAI,IAAI,CAAC;IACrD,CAAC;IAED;;OAEG;IAEH;;;;;;OAMG;IACH,GAAG,CAAC,KAAa;;QACf,OAAO,MAAA,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,mCAAI,IAAI,CAAC;IACpC,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CAAC,KAAa,EAAE,KAAQ;QACzB,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,KAAa,EAAE,KAAQ;QAC5B,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,KAAa;QAClB,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC;IAClC,CAAC;CACF;AA/HD,gCA+HC"}

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

@@ -0,0 +1,2 @@
+export * from './queue';
+export * from './deque';

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

@@ -0,0 +1,107 @@
+/**
+ * @license MIT
+ * @copyright Tyler Zeng <zrwusa@gmail.com>
+ * @class
+ */
+import { SinglyLinkedList } from '../linked-list';
+export declare class LinkedListQueue<E = any> extends SinglyLinkedList<E> {
+    /**
+     * The enqueue function adds a value to the end of an array.
+     * @param {E} value - The value parameter represents the value that you want to add to the queue.
+     */
+    enqueue(value: E): void;
+    /**
+     * The `dequeue` function removes and returns the first element from a queue, or returns null if the queue is empty.
+     * @returns The method is returning the element at the front of the queue, or null if the queue is empty.
+     */
+    dequeue(): E | undefined;
+    /**
+     * The `peek` function returns the value of the head node in a linked list, or `undefined` if the list is empty.
+     * @returns The `peek()` method is returning the value of the `head` node if it exists, otherwise it returns `undefined`.
+     */
+    peek(): E | undefined;
+}
+export declare class Queue<E = any> {
+    /**
+     * The constructor initializes an instance of a class with an optional array of elements and sets the offset to 0.
+     * @param {E[]} [elements] - The `elements` parameter is an optional array of elements of type `E`. 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?: E[]);
+    private _nodes;
+    get nodes(): E[];
+    set nodes(value: E[]);
+    private _offset;
+    get offset(): number;
+    set offset(value: 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.
+     */
+    get size(): number;
+    /**
+     * The function "fromArray" creates a new Queue object from an array of elements.Creates a queue from an existing array.
+     * @public
+     * @static
+     * @param {E[]} elements - The "elements" parameter is an array of elements of type E.
+     * @returns The method is returning a new instance of the Queue class, initialized with the elements from the input
+     * array.
+     */
+    static fromArray<E>(elements: E[]): Queue<E>;
+    /**
+     * The push 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 {E} element - The `element` parameter represents the element that you want to add to the queue.
+     * @returns The `add` method is returning a `Queue<E>` object.
+     */
+    push(element: E): Queue<E>;
+    /**
+     * The `shift` function removes and returns the first element in the queue, and adjusts the internal data structure if
+     * necessary to optimize performance.
+     * @returns The function `shift()` returns either the first element in the queue or `null` if the queue is empty.
+     */
+    shift(): E | undefined;
+    /**
+     * 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(): E | undefined;
+    /**
+     * 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(): E | undefined;
+    /**
+     * The enqueue function adds a value to the end of a queue.
+     * @param {E} value - The value parameter represents the value that you want to add to the queue.
+     */
+    enqueue(value: E): void;
+    /**
+     * The `dequeue` function removes and returns the first element from a queue, or returns null if the queue is empty.
+     * @returns The method is returning a value of type E or null.
+     */
+    dequeue(): E | undefined;
+    getAt(index: number): E | undefined;
+    /**
+     * 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;
+    /**
+     * The toArray() function returns an array of elements from the current offset to the end of the _nodes array.
+     * @returns An array of type E is being returned.
+     */
+    toArray(): E[];
+    /**
+     * The clear function resets the nodes array and offset to their initial values.
+     */
+    clear(): void;
+    /**
+     * 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<E>;
+    [Symbol.iterator](): Generator<E, void, unknown>;
+}

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

@@ -1,14 +1,31 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Queue = exports.LinkedListQueue = void 0;
+/**
+ * @license MIT
+ * @copyright Tyler Zeng <zrwusa@gmail.com>
+ * @class
+ */
 const linked_list_1 = require("../linked-list");
 class LinkedListQueue extends linked_list_1.SinglyLinkedList {
+    /**
+     * The enqueue function adds a value to the end of an array.
+     * @param {E} value - The value parameter represents the value that you want to add to the queue.
+     */
     enqueue(value) {
         this.push(value);
     }
+    /**
+     * The `dequeue` function removes and returns the first element from a queue, or returns null if the queue is empty.
+     * @returns The method is returning the element at the front of the queue, or null if the queue is empty.
+     */
     dequeue() {
         return this.shift();
     }
+    /**
+     * The `peek` function returns the value of the head node in a linked list, or `undefined` if the list is empty.
+     * @returns The `peek()` method is returning the value of the `head` node if it exists, otherwise it returns `undefined`.
+     */
     peek() {
         var _a;
         return (_a = this.head) === null || _a === void 0 ? void 0 : _a.val;
@@ -16,6 +33,12 @@ class LinkedListQueue extends linked_list_1.SinglyLinkedList {
 }
 exports.LinkedListQueue = LinkedListQueue;
 class Queue {
+    /**
+     * The constructor initializes an instance of a class with an optional array of elements and sets the offset to 0.
+     * @param {E[]} [elements] - The `elements` parameter is an optional array of elements of type `E`. 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) {
         this._nodes = elements || [];
         this._offset = 0;
@@ -32,16 +55,38 @@ class Queue {
     set offset(value) {
         this._offset = value;
     }
+    /**
+     * 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.
+     */
     get size() {
         return this.nodes.length - this.offset;
     }
+    /**
+     * The function "fromArray" creates a new Queue object from an array of elements.Creates a queue from an existing array.
+     * @public
+     * @static
+     * @param {E[]} elements - The "elements" parameter is an array of elements of type E.
+     * @returns The method is returning a new instance of the Queue class, initialized with the elements from the input
+     * array.
+     */
     static fromArray(elements) {
         return new Queue(elements);
     }
+    /**
+     * The push 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 {E} element - The `element` parameter represents the element that you want to add to the queue.
+     * @returns The `add` method is returning a `Queue<E>` object.
+     */
     push(element) {
         this.nodes.push(element);
         return this;
     }
+    /**
+     * The `shift` function removes and returns the first element in the queue, and adjusts the internal data structure if
+     * necessary to optimize performance.
+     * @returns The function `shift()` returns either the first element in the queue or `null` if the queue is empty.
+     */
     shift() {
         if (this.size === 0)
             return undefined;
@@ -49,35 +94,70 @@ class Queue {
         this.offset += 1;
         if (this.offset * 2 < this.nodes.length)
             return first;
+        // only remove dequeued elements when reaching half size
+        // to decrease latency of shifting elements.
         this.nodes = this.nodes.slice(this.offset);
         this.offset = 0;
         return first;
     }
+    /**
+     * 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() {
         return this.size > 0 ? this.nodes[this.offset] : undefined;
     }
+    /**
+     * 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() {
         return this.size > 0 ? this.nodes[this.nodes.length - 1] : undefined;
     }
+    /**
+     * The enqueue function adds a value to the end of a queue.
+     * @param {E} value - The value parameter represents the value that you want to add to the queue.
+     */
     enqueue(value) {
         this.push(value);
     }
+    /**
+     * The `dequeue` function removes and returns the first element from a queue, or returns null if the queue is empty.
+     * @returns The method is returning a value of type E or null.
+     */
     dequeue() {
         return this.shift();
     }
     getAt(index) {
         return this.nodes[index];
     }
+    /**
+     * 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() {
         return this.size === 0;
     }
+    /**
+     * The toArray() function returns an array of elements from the current offset to the end of the _nodes array.
+     * @returns An array of type E is being returned.
+     */
     toArray() {
         return this.nodes.slice(this.offset);
     }
+    /**
+     * The clear function resets the nodes array and offset to their initial values.
+     */
     clear() {
         this.nodes = [];
         this.offset = 0;
     }
+    /**
+     * 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() {
         return new Queue(this.nodes.slice(this.offset));
     }

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

@@ -1 +1 @@
-{"version":3,"file":"queue.js","sourceRoot":"","sources":["../../../src/data-structures/queue/queue.ts"],"names":[],"mappings":";;;AAKA,gDAAgD;AAEhD,MAAa,eAAyB,SAAQ,8BAAmB;IAK/D,OAAO,CAAC,KAAQ;QACd,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACnB,CAAC;IAMD,OAAO;QACL,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC;IACtB,CAAC;IAMD,IAAI;;QACF,OAAO,MAAA,IAAI,CAAC,IAAI,0CAAE,GAAG,CAAC;IACxB,CAAC;CACF;AAxBD,0CAwBC;AAED,MAAa,KAAK;IAOhB,YAAY,QAAc;QACxB,IAAI,CAAC,MAAM,GAAG,QAAQ,IAAI,EAAE,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC;IACnB,CAAC;IAID,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAI,KAAK,CAAC,KAAU;QAClB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAID,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,IAAI,MAAM,CAAC,KAAa;QACtB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;IACvB,CAAC;IAMD,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;IACzC,CAAC;IAUD,MAAM,CAAC,SAAS,CAAI,QAAa;QAC/B,OAAO,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC7B,CAAC;IAOD,IAAI,CAAC,OAAU;QACb,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAOD,KAAK;QACH,IAAI,IAAI,CAAC,IAAI,KAAK,CAAC;YAAE,OAAO,SAAS,CAAC;QAEtC,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QAC1B,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC;QAEjB,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM;YAAE,OAAO,KAAK,CAAC;QAItD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC3C,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;QAChB,OAAO,KAAK,CAAC;IACf,CAAC;IAOD,IAAI;QACF,OAAO,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7D,CAAC;IAOD,QAAQ;QACN,OAAO,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACvE,CAAC;IAMD,OAAO,CAAC,KAAQ;QACd,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACnB,CAAC;IAMD,OAAO;QACL,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC;IACtB,CAAC;IAED,KAAK,CAAC,KAAa;QACjB,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAMD,OAAO;QACL,OAAO,IAAI,CAAC,IAAI,KAAK,CAAC,CAAC;IACzB,CAAC;IAMD,OAAO;QACL,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACvC,CAAC;IAKD,KAAK;QACH,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;QAChB,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;IAClB,CAAC;IAMD,KAAK;QACH,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAClD,CAAC;IAED,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC;QAChB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE;YAC7B,MAAM,IAAI,CAAC;SACZ;IACH,CAAC;CACF;AA7JD,sBA6JC"}
+{"version":3,"file":"queue.js","sourceRoot":"","sources":["../../../src/data-structures/queue/queue.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH,gDAAgD;AAEhD,MAAa,eAAyB,SAAQ,8BAAmB;IAC/D;;;OAGG;IACH,OAAO,CAAC,KAAQ;QACd,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACnB,CAAC;IAED;;;OAGG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC;IACtB,CAAC;IAED;;;OAGG;IACH,IAAI;;QACF,OAAO,MAAA,IAAI,CAAC,IAAI,0CAAE,GAAG,CAAC;IACxB,CAAC;CACF;AAxBD,0CAwBC;AAED,MAAa,KAAK;IAChB;;;;;OAKG;IACH,YAAY,QAAc;QACxB,IAAI,CAAC,MAAM,GAAG,QAAQ,IAAI,EAAE,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC;IACnB,CAAC;IAID,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAI,KAAK,CAAC,KAAU;QAClB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAID,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,IAAI,MAAM,CAAC,KAAa;QACtB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;IACvB,CAAC;IAED;;;OAGG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;IACzC,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,SAAS,CAAI,QAAa;QAC/B,OAAO,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACH,IAAI,CAAC,OAAU;QACb,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,KAAK;QACH,IAAI,IAAI,CAAC,IAAI,KAAK,CAAC;YAAE,OAAO,SAAS,CAAC;QAEtC,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QAC1B,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC;QAEjB,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM;YAAE,OAAO,KAAK,CAAC;QAEtD,wDAAwD;QACxD,4CAA4C;QAC5C,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC3C,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;QAChB,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACH,IAAI;QACF,OAAO,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IACH,QAAQ;QACN,OAAO,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACvE,CAAC;IAED;;;OAGG;IACH,OAAO,CAAC,KAAQ;QACd,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACnB,CAAC;IAED;;;OAGG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC;IACtB,CAAC;IAED,KAAK,CAAC,KAAa;QACjB,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,IAAI,KAAK,CAAC,CAAC;IACzB,CAAC;IAED;;;OAGG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACvC,CAAC;IAED;;OAEG;IACH,KAAK;QACH,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;QAChB,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;IAClB,CAAC;IAED;;;OAGG;IACH,KAAK;QACH,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAClD,CAAC;IAED,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC;QAChB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE;YAC7B,MAAM,IAAI,CAAC;SACZ;IACH,CAAC;CACF;AA7JD,sBA6JC"}

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

@@ -0,0 +1 @@
+export * from './stack';

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

@@ -0,0 +1,63 @@
+/**
+ * @license MIT
+ * @copyright Tyler Zeng <zrwusa@gmail.com>
+ * @class
+ */
+export declare class Stack<E = any> {
+    protected _elements: E[];
+    /**
+     * The constructor initializes an array of elements, which can be provided as an optional parameter.
+     * @param {E[]} [elements] - The `elements` parameter is an optional parameter of type `E[]`, which represents an array
+     * of elements of type `E`. 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?: E[]);
+    /**
+     * The function "fromArray" creates a new Stack object from an array of elements.
+     * @param {E[]} elements - The `elements` parameter is an array of elements of type `E`.
+     * @returns {Stack} The method is returning a new instance of the Stack class, initialized with the elements from the input
+     * array.
+     */
+    static fromArray<E>(elements: E[]): Stack<E>;
+    /**
+     * 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;
+    /**
+     * The size() function returns the number of elements in an array.
+     * @returns The size of the elements array.
+     */
+    size(): number;
+    /**
+     * 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(): E | null;
+    /**
+     * The push function adds an element to the stack and returns the updated stack.
+     * @param {E} element - The parameter "element" is of type E, which means it can be any data type.
+     * @returns The `push` method is returning the updated `Stack<E>` object.
+     */
+    push(element: E): Stack<E>;
+    /**
+     * 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(): E | null;
+    /**
+     * The toArray function returns a copy of the elements in an array.
+     * @returns An array of type E.
+     */
+    toArray(): E[];
+    /**
+     * The clear function clears the elements array.
+     */
+    clear(): void;
+    /**
+     * 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<E>;
+}