data-structure-typed 0.8.18 → 1.3.0

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

@@ -1,37 +1,165 @@
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
 import { DoublyLinkedList } from '../linked-list';
 export declare class Deque<T> extends DoublyLinkedList<T> {
 }
-export declare class ObjectDeque<T> {
-    protected _nodes: {
-        [key: number]: T;
-    };
-    protected _capacity: number;
-    protected _first: number;
-    protected _last: number;
-    protected _size: number;
+export declare class ObjectDeque<T = number> {
     constructor(capacity?: number);
-    size(): number;
-    offerFirst(value: T): void;
-    offerLast(value: T): void;
+    private _nodes;
+    get nodes(): {
+        [p: number]: T;
+    };
+    private _capacity;
+    get capacity(): number;
+    set capacity(value: number);
+    private _first;
+    get first(): number;
+    set first(value: number);
+    private _last;
+    get last(): number;
+    set last(value: number);
+    private _size;
+    get size(): number;
+    /**
+     * The "addFirst" function adds a value to the beginning of an array-like data structure.
+     * @param {T} value - The `value` parameter represents the value that you want to add to the beginning of the data
+     * structure.
+     */
+    addFirst(value: T): void;
+    /**
+     * The addLast function adds a value to the end of an array-like data structure.
+     * @param {T} value - The `value` parameter represents the value that you want to add to the end of the data structure.
+     */
+    addLast(value: T): void;
+    /**
+     * 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(): T | undefined;
+    /**
+     * 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(): T | undefined;
+    /**
+     * The `pollLast()` function removes and returns the last element in a data structure.
+     * @returns The value that was removed from the data structure.
+     */
     pollLast(): T | undefined;
+    /**
+     * 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(): T | undefined;
+    /**
+     * 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: number): NonNullable<T> | 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(): boolean;
+    protected _seNodes(value: {
+        [p: number]: T;
+    }): void;
+    protected _setSize(value: number): void;
 }
 export declare class ArrayDeque<T> {
     protected _nodes: T[];
     get size(): number;
-    offerLast(value: T): number;
+    /**
+     * 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 {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.
+     */
+    addLast(value: T): number;
+    /**
+     * 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(): T | 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(): T | null;
-    offerFirst(value: T): number;
+    /**
+     * 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 {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 `addFirst` function is the new length of the array `_nodes` after adding the
+     * `value` at the beginning.
+     */
+    addFirst(value: T): number;
+    /**
+     * 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`.
+     */
     peekFirst(): T | 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(): T | 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: number): T | 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 {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.
+     */
     set(index: number, value: T): T;
+    /**
+     * 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.
+     */
     insert(index: number, value: T): T[];
+    /**
+     * 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: number): T[];
+    /**
+     * 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(): boolean;
 }

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

@@ -1,6 +1,13 @@
 "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
@@ -20,10 +27,36 @@ class ObjectDeque {
         if (capacity !== undefined)
             this._capacity = capacity;
     }
-    size() {
+    get nodes() {
+        return this._nodes;
+    }
+    get capacity() {
+        return this._capacity;
+    }
+    set capacity(value) {
+        this._capacity = value;
+    }
+    get first() {
+        return this._first;
+    }
+    set first(value) {
+        this._first = value;
+    }
+    get last() {
+        return this._last;
+    }
+    set last(value) {
+        this._last = value;
+    }
+    get size() {
         return this._size;
     }
-    offerFirst(value) {
+    /**
+     * The "addFirst" function adds a value to the beginning of an array-like data structure.
+     * @param {T} 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);
             this._first = mid;
@@ -35,7 +68,11 @@ class ObjectDeque {
         this._nodes[this._first] = value;
         this._size++;
     }
-    offerLast(value) {
+    /**
+     * The addLast function adds a value to the end of an array-like data structure.
+     * @param {T} 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);
             this._first = mid;
@@ -47,38 +84,71 @@ 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;
-        let value = this.peekFirst();
+        const value = this.peekFirst();
         delete this._nodes[this._first];
         this._first++;
         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;
-        let value = this.peekLast();
+        const value = this.peekLast();
         delete this._nodes[this._last];
         this._last--;
         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;
     }
+    _seNodes(value) {
+        this._nodes = value;
+    }
+    _setSize(value) {
+        this._size = value;
+    }
 }
 exports.ObjectDeque = ObjectDeque;
 // O(1) time complexity of obtaining the value
@@ -90,41 +160,115 @@ class ArrayDeque {
     get size() {
         return this._nodes.length;
     }
-    offerLast(value) {
+    /**
+     * 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 {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.
+     */
+    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;
     }
-    offerFirst(value) {
+    /**
+     * 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 {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 `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 (`T`) 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 {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.
+     */
     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 {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.
+     */
     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/queue.d.ts

@@ -1,76 +1,102 @@
 /**
  * @license MIT
- * @copyright 2020 Pablo
- *
+ * @copyright Tyler Zeng <zrwusa@gmail.com>
  * @class
  */
-export declare class Queue<T> {
+import { SinglyLinkedList } from '../linked-list';
+export declare class Queue<T = any> extends SinglyLinkedList<T> {
+    /**
+     * The enqueue function 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 queue.
+     */
+    enqueue(value: T): 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(): T | 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(): T | undefined;
+    [Symbol.iterator](): Generator<T, void, unknown>;
+}
+export declare class ArrayQueue<T = number> {
     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.
-     * @public
-     * @param {any} element
+     * 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.
      */
-    offer(element: T): Queue<T>;
+    get size(): number;
     /**
-     * Dequeues the front element in the queue.
+     * The function "fromArray" creates a new Queue object from an array of elements.Creates a queue from an existing array.
      * @public
-     * @returns {any}
+     * @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.
      */
-    poll(): T | null;
+    static fromArray<T>(elements: T[]): ArrayQueue<T>;
     /**
-     * Returns the front element of the queue.
-     * @public
-     * @returns {any}
+     * 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 {T} element - The `element` parameter represents the element that you want to add to the queue.
+     * @returns The `add` method is returning a `Queue<T>` object.
+     */
+    push(element: T): ArrayQueue<T>;
+    /**
+     * 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(): T | null;
+    /**
+     * 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 enqueue function adds a value to the end of a queue.
+     * @param {T} value - The value parameter represents the value that you want to add to the queue.
      */
-    size(): number;
+    enqueue(value: T): void;
     /**
-     * Checks if the queue is empty.
-     * @public
-     * @returns {boolean}
+     * 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 T or null.
+     */
+    dequeue(): T | null;
+    /**
+     * 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}
-     */
-    clone(): Queue<T>;
-    /**
-     * Creates a queue from an existing array.
-     * @public
-     * @static
-     * @param {array} elements
-     * @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.
      */
-    static fromArray<T>(elements: T[]): Queue<T>;
+    clone(): ArrayQueue<T>;
 }