data-structure-typed 1.50.1 → 1.50.3

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

@@ -24,8 +24,16 @@ export declare class Queue<E = any> extends IterableElementBase<E> {
      */
     constructor(elements?: Iterable<E>);
     protected _elements: E[];
+    /**
+     * The elements function returns the elements of this set.
+     * @return An array of the elements in the stack
+     */
     get elements(): E[];
     protected _offset: number;
+    /**
+     * The offset function returns the offset of the current page.
+     * @return The value of the protected variable _offset
+     */
     get offset(): number;
     /**
      * The size function returns the number of elements in an array.
@@ -33,8 +41,12 @@ export declare class Queue<E = any> extends IterableElementBase<E> {
      */
     get size(): number;
     /**
-     * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
-     * Space Complexity: O(1) - no additional space is used.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      *
      * The `first` function returns the first element of the array `_elements` if it exists, otherwise it returns `undefined`.
      * @returns The `get first()` method returns the first element of the data structure, represented by the `_elements` array at
@@ -42,12 +54,12 @@ export declare class Queue<E = any> extends IterableElementBase<E> {
      */
     get first(): E | undefined;
     /**
-     * Time Complexity: O(1) - constant time as it adds an element to the end of the array.
-     * Space Complexity: O(1) - no additional space is used.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
-     * Space Complexity: O(1) - no additional space is used.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      *
      * The `last` function returns the last element in an array-like data structure, or undefined if the structure is empty.
      * @returns The method `get last()` returns the last element of the `_elements` array if the array is not empty. If the
@@ -55,10 +67,13 @@ export declare class Queue<E = any> extends IterableElementBase<E> {
      */
     get last(): E | undefined;
     /**
-     * Time Complexity: O(n) - where n is the number of elements in the queue. In the worst case, it may need to shift all elements to update the offset.
-     * Space Complexity: O(1) - no additional space is used.
+     * Time Complexity: O(n)
+     * Space Complexity: O(n)
      */
     /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(n)
+     *
      * The function "fromArray" creates a new Queue object from an array of elements.Creates a queue from an existing array.
      * @public
      * @static
@@ -68,12 +83,12 @@ export declare class Queue<E = any> extends IterableElementBase<E> {
      */
     static fromArray<E>(elements: E[]): Queue<E>;
     /**
-     * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
-     * Space Complexity: O(1) - no additional space is used.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(1) - constant time as it adds an element to the end of the array.
-     * Space Complexity: O(1) - no additional space is used.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      *
      * 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.
@@ -81,12 +96,12 @@ export declare class Queue<E = any> extends IterableElementBase<E> {
      */
     push(element: E): boolean;
     /**
-     * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
-     * Space Complexity: O(1) - no additional space is used.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(n) - where n is the number of elements in the queue. In the worst case, it may need to shift all elements to update the offset.
-     * Space Complexity: O(1) - no additional space is used.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      *
      * The `shift` function removes and returns the first element in the queue, and adjusts the internal data structure if
      * necessary to optimize performance.
@@ -94,12 +109,24 @@ export declare class Queue<E = any> extends IterableElementBase<E> {
      */
     shift(): E | undefined;
     /**
-     * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
-     * Space Complexity: O(1) - no additional space is used.
+     * The delete function removes an element from the list.
+     * @param element: E Specify the element to be deleted
+     * @return A boolean value indicating whether the element was successfully deleted or not
+     */
+    delete(element: E): boolean;
+    /**
+     * The deleteAt function deletes the element at a given index.
+     * @param index: number Determine the index of the element to be deleted
+     * @return A boolean value
+     */
+    deleteAt(index: number): boolean;
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
-     * Space Complexity: O(1) - no additional space is used.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      *
      * The `peek` function returns the first element of the array `_elements` if it exists, otherwise it returns `undefined`.
      * @returns The `peek()` method returns the first element of the data structure, represented by the `_elements` array at
@@ -107,12 +134,12 @@ export declare class Queue<E = any> extends IterableElementBase<E> {
      */
     peek(): E | undefined;
     /**
-     * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
-     * Space Complexity: O(1) - no additional space is used.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
-     * Space Complexity: O(1) - no additional space is used.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      *
      * The `peekLast` function returns the last element in an array-like data structure, or undefined if the structure is empty.
      * @returns The method `peekLast()` returns the last element of the `_elements` array if the array is not empty. If the
@@ -120,75 +147,83 @@ export declare class Queue<E = any> extends IterableElementBase<E> {
      */
     peekLast(): E | undefined;
     /**
-     * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
-     * Space Complexity: O(1) - no additional space is used.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
-     * Space Complexity: O(1) - no additional space is used.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      *
      * 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): boolean;
     /**
-     * Time Complexity: O(n) - same as shift().
-     * Space Complexity: O(1) - same as shift().
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(n) - same as shift().
-     * Space Complexity: O(1) - same as shift().
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      *
      * The `dequeue` function removes and returns the first element from a queue, or returns undefined if the queue is empty.
      * @returns The method is returning a value of type E or undefined.
      */
     dequeue(): E | undefined;
     /**
-     * Time Complexity: O(1) - constant time as it retrieves the value at the specified index.
-     * Space Complexity: O(1) - no additional space is used.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(1) - constant time as it retrieves the value at the specified index.
-     * Space Complexity: O(1) - no additional space is used.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      *
      * @param index
      */
-    getAt(index: number): E | undefined;
+    at(index: number): E | undefined;
     /**
-     * Time Complexity: O(1) - constant time as it retrieves the value at the specified index.
-     * Space Complexity: O(1) - no additional space is used.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(1) - constant time as it retrieves the value at the specified index.
-     * Space Complexity: O(1) - no additional space is used.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      *
      * 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;
     /**
-     * Time Complexity: O(1) - constant time as it returns a shallow copy of the internal array.
-     * Space Complexity: O(n) - where n is the number of elements in the queue.
+     * Time Complexity: O(1)
+     * Space Complexity: O(n)
      */
     /**
-     * Time Complexity: O(1) - constant time as it returns a shallow copy of the internal array.
-     * Space Complexity: O(n) - where n is the number of elements in the queue.
+     * Time Complexity: O(1)
+     * Space Complexity: O(n)
      *
      * The toArray() function returns an array of elements from the current offset to the end of the _elements array.
      * @returns An array of type E is being returned.
      */
     toArray(): E[];
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The clear function resets the elements array and offset to their initial values.
      */
     clear(): void;
     /**
-     * Time Complexity: O(n) - where n is the number of elements in the queue. It creates a shallow copy of the internal array.
-     * Space Complexity: O(n) - the space required is proportional to the number of elements in the queue.
+     * Time Complexity: O(n)
+     * Space Complexity: O(n)
+     * where n is the number of elements in the queue. It creates a shallow copy of the internal array. the space required is proportional to the number of elements in the queue.
      */
     /**
-     * Time Complexity: O(n) - where n is the number of elements in the queue. It creates a shallow copy of the internal array.
-     * Space Complexity: O(n) - the space required is proportional to the number of elements in the queue.
+     * Time Complexity: O(n)
+     * Space Complexity: O(n)
      *
      * 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.
@@ -238,6 +273,12 @@ export declare class Queue<E = any> extends IterableElementBase<E> {
      * Time Complexity: O(n)
      * Space Complexity: O(n)
      */
+    /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(n)
+     *
+     * The function `_getIterator` returns an iterable iterator for the elements in the class.
+     */
     protected _getIterator(): IterableIterator<E>;
 }
 /**
@@ -267,4 +308,17 @@ export declare class LinkedListQueue<E = any> extends SinglyLinkedList<E> {
      * @returns The `peek()` method is returning the value of the `head` node if it exists, otherwise it returns `undefined`.
      */
     peek(): E | undefined;
+    /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(n)
+     */
+    /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(n)
+     * The `clone` function returns a new instance of the `LinkedListQueue` class with the same values as
+     * the current instance.
+     * @returns The `clone()` method is returning a new instance of `LinkedListQueue` with the same
+     * values as the original `LinkedListQueue`.
+     */
+    clone(): LinkedListQueue<E>;
 }

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

@@ -24,10 +24,18 @@ export class Queue extends IterableElementBase {
         }
     }
     _elements = [];
+    /**
+     * The elements function returns the elements of this set.
+     * @return An array of the elements in the stack
+     */
     get elements() {
         return this._elements;
     }
     _offset = 0;
+    /**
+     * The offset function returns the offset of the current page.
+     * @return The value of the protected variable _offset
+     */
     get offset() {
         return this._offset;
     }
@@ -39,8 +47,12 @@ export class Queue extends IterableElementBase {
         return this.elements.length - this.offset;
     }
     /**
-     * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
-     * Space Complexity: O(1) - no additional space is used.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      *
      * The `first` function returns the first element of the array `_elements` if it exists, otherwise it returns `undefined`.
      * @returns The `get first()` method returns the first element of the data structure, represented by the `_elements` array at
@@ -50,12 +62,12 @@ export class Queue extends IterableElementBase {
         return this.size > 0 ? this.elements[this.offset] : undefined;
     }
     /**
-     * Time Complexity: O(1) - constant time as it adds an element to the end of the array.
-     * Space Complexity: O(1) - no additional space is used.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
-     * Space Complexity: O(1) - no additional space is used.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      *
      * The `last` function returns the last element in an array-like data structure, or undefined if the structure is empty.
      * @returns The method `get last()` returns the last element of the `_elements` array if the array is not empty. If the
@@ -65,10 +77,13 @@ export class Queue extends IterableElementBase {
         return this.size > 0 ? this.elements[this.elements.length - 1] : undefined;
     }
     /**
-     * Time Complexity: O(n) - where n is the number of elements in the queue. In the worst case, it may need to shift all elements to update the offset.
-     * Space Complexity: O(1) - no additional space is used.
+     * Time Complexity: O(n)
+     * Space Complexity: O(n)
      */
     /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(n)
+     *
      * The function "fromArray" creates a new Queue object from an array of elements.Creates a queue from an existing array.
      * @public
      * @static
@@ -80,12 +95,12 @@ export class Queue extends IterableElementBase {
         return new Queue(elements);
     }
     /**
-     * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
-     * Space Complexity: O(1) - no additional space is used.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(1) - constant time as it adds an element to the end of the array.
-     * Space Complexity: O(1) - no additional space is used.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      *
      * 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.
@@ -96,12 +111,12 @@ export class Queue extends IterableElementBase {
         return true;
     }
     /**
-     * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
-     * Space Complexity: O(1) - no additional space is used.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(n) - where n is the number of elements in the queue. In the worst case, it may need to shift all elements to update the offset.
-     * Space Complexity: O(1) - no additional space is used.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      *
      * The `shift` function removes and returns the first element in the queue, and adjusts the internal data structure if
      * necessary to optimize performance.
@@ -121,12 +136,30 @@ export class Queue extends IterableElementBase {
         return first;
     }
     /**
-     * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
-     * Space Complexity: O(1) - no additional space is used.
+     * The delete function removes an element from the list.
+     * @param element: E Specify the element to be deleted
+     * @return A boolean value indicating whether the element was successfully deleted or not
+     */
+    delete(element) {
+        const index = this.elements.indexOf(element);
+        return this.deleteAt(index);
+    }
+    /**
+     * The deleteAt function deletes the element at a given index.
+     * @param index: number Determine the index of the element to be deleted
+     * @return A boolean value
+     */
+    deleteAt(index) {
+        const spliced = this.elements.splice(index, 1);
+        return spliced.length === 1;
+    }
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
-     * Space Complexity: O(1) - no additional space is used.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      *
      * The `peek` function returns the first element of the array `_elements` if it exists, otherwise it returns `undefined`.
      * @returns The `peek()` method returns the first element of the data structure, represented by the `_elements` array at
@@ -136,12 +169,12 @@ export class Queue extends IterableElementBase {
         return this.first;
     }
     /**
-     * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
-     * Space Complexity: O(1) - no additional space is used.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
-     * Space Complexity: O(1) - no additional space is used.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      *
      * The `peekLast` function returns the last element in an array-like data structure, or undefined if the structure is empty.
      * @returns The method `peekLast()` returns the last element of the `_elements` array if the array is not empty. If the
@@ -151,12 +184,12 @@ export class Queue extends IterableElementBase {
         return this.last;
     }
     /**
-     * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
-     * Space Complexity: O(1) - no additional space is used.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
-     * Space Complexity: O(1) - no additional space is used.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      *
      * 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.
@@ -165,12 +198,12 @@ export class Queue extends IterableElementBase {
         return this.push(value);
     }
     /**
-     * Time Complexity: O(n) - same as shift().
-     * Space Complexity: O(1) - same as shift().
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(n) - same as shift().
-     * Space Complexity: O(1) - same as shift().
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      *
      * The `dequeue` function removes and returns the first element from a queue, or returns undefined if the queue is empty.
      * @returns The method is returning a value of type E or undefined.
@@ -179,25 +212,25 @@ export class Queue extends IterableElementBase {
         return this.shift();
     }
     /**
-     * Time Complexity: O(1) - constant time as it retrieves the value at the specified index.
-     * Space Complexity: O(1) - no additional space is used.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(1) - constant time as it retrieves the value at the specified index.
-     * Space Complexity: O(1) - no additional space is used.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      *
      * @param index
      */
-    getAt(index) {
+    at(index) {
         return this.elements[index];
     }
     /**
-     * Time Complexity: O(1) - constant time as it retrieves the value at the specified index.
-     * Space Complexity: O(1) - no additional space is used.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(1) - constant time as it retrieves the value at the specified index.
-     * Space Complexity: O(1) - no additional space is used.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      *
      * 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.
@@ -206,12 +239,12 @@ export class Queue extends IterableElementBase {
         return this.size === 0;
     }
     /**
-     * Time Complexity: O(1) - constant time as it returns a shallow copy of the internal array.
-     * Space Complexity: O(n) - where n is the number of elements in the queue.
+     * Time Complexity: O(1)
+     * Space Complexity: O(n)
      */
     /**
-     * Time Complexity: O(1) - constant time as it returns a shallow copy of the internal array.
-     * Space Complexity: O(n) - where n is the number of elements in the queue.
+     * Time Complexity: O(1)
+     * Space Complexity: O(n)
      *
      * The toArray() function returns an array of elements from the current offset to the end of the _elements array.
      * @returns An array of type E is being returned.
@@ -220,6 +253,13 @@ export class Queue extends IterableElementBase {
         return this.elements.slice(this.offset);
     }
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The clear function resets the elements array and offset to their initial values.
      */
     clear() {
@@ -227,12 +267,13 @@ export class Queue extends IterableElementBase {
         this._offset = 0;
     }
     /**
-     * Time Complexity: O(n) - where n is the number of elements in the queue. It creates a shallow copy of the internal array.
-     * Space Complexity: O(n) - the space required is proportional to the number of elements in the queue.
+     * Time Complexity: O(n)
+     * Space Complexity: O(n)
+     * where n is the number of elements in the queue. It creates a shallow copy of the internal array. the space required is proportional to the number of elements in the queue.
      */
     /**
-     * Time Complexity: O(n) - where n is the number of elements in the queue. It creates a shallow copy of the internal array.
-     * Space Complexity: O(n) - the space required is proportional to the number of elements in the queue.
+     * Time Complexity: O(n)
+     * Space Complexity: O(n)
      *
      * 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.
@@ -302,6 +343,12 @@ export class Queue extends IterableElementBase {
      * Time Complexity: O(n)
      * Space Complexity: O(n)
      */
+    /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(n)
+     *
+     * The function `_getIterator` returns an iterable iterator for the elements in the class.
+     */
     *_getIterator() {
         for (const item of this.elements) {
             yield item;
@@ -343,4 +390,19 @@ export class LinkedListQueue extends SinglyLinkedList {
     peek() {
         return this.first;
     }
+    /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(n)
+     */
+    /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(n)
+     * The `clone` function returns a new instance of the `LinkedListQueue` class with the same values as
+     * the current instance.
+     * @returns The `clone()` method is returning a new instance of `LinkedListQueue` with the same
+     * values as the original `LinkedListQueue`.
+     */
+    clone() {
+        return new LinkedListQueue(this.values());
+    }
 }