data-structure-typed 1.39.5 → 1.39.6

package/dist/mjs/data-structures/hash/hash-table.d.ts

@@ -7,9 +7,9 @@
  */
 export declare class HashTableNode<K, V> {
     key: K;
-    val: V;
+    value: V;
     next: HashTableNode<K, V> | null;
-    constructor(key: K, val: V);
+    constructor(key: K, value: V);
 }
 import { HashFunction } from '../../types';
 export declare class HashTable<K, V> {
@@ -31,12 +31,12 @@ export declare class HashTable<K, V> {
      * The set function adds a key-value pair to the hash table, handling collisions and resizing if necessary.
      * @param {K} key - The key parameter represents the key of the key-value pair that you want to insert into the hash
      * table. It is of type K, which is a generic type representing the key's data type.
-     * @param {V} val - The parameter `val` represents the value that you want to associate with the given key in the hash
+     * @param {V} value - The parameter `value` represents the value that you want to associate with the given key in the hash
      * table.
      * @returns Nothing is being returned. The return type of the `put` method is `void`, which means it does not return any
      * value.
      */
-    set(key: K, val: V): void;
+    set(key: K, value: V): void;
     /**
      * The `get` function retrieves the value associated with a given key from a hash table.
      * @param {K} key - The `key` parameter represents the key of the element that we want to retrieve from the data

package/dist/mjs/data-structures/hash/hash-table.js

@@ -10,11 +10,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.HashTable = exports.HashTableNode = void 0;
 class HashTableNode {
     key;
-    val;
+    value;
     next;
-    constructor(key, val) {
+    constructor(key, value) {
         this.key = key;
-        this.val = val;
+        this.value = value;
         this.next = null;
     }
 }
@@ -57,14 +57,14 @@ class HashTable {
      * The set function adds a key-value pair to the hash table, handling collisions and resizing if necessary.
      * @param {K} key - The key parameter represents the key of the key-value pair that you want to insert into the hash
      * table. It is of type K, which is a generic type representing the key's data type.
-     * @param {V} val - The parameter `val` represents the value that you want to associate with the given key in the hash
+     * @param {V} value - The parameter `value` represents the value that you want to associate with the given key in the hash
      * table.
      * @returns Nothing is being returned. The return type of the `put` method is `void`, which means it does not return any
      * value.
      */
-    set(key, val) {
+    set(key, value) {
         const index = this._hash(key);
-        const newNode = new HashTableNode(key, val);
+        const newNode = new HashTableNode(key, value);
         if (!this._buckets[index]) {
             this._buckets[index] = newNode;
         }
@@ -74,7 +74,7 @@ class HashTable {
             while (currentNode) {
                 if (currentNode.key === key) {
                     // If the key already exists, update the value
-                    currentNode.val = val;
+                    currentNode.value = value;
                     return;
                 }
                 if (!currentNode.next) {
@@ -103,7 +103,7 @@ class HashTable {
         let currentNode = this._buckets[index];
         while (currentNode) {
             if (currentNode.key === key) {
-                return currentNode.val;
+                return currentNode.value;
             }
             currentNode = currentNode.next;
         }
@@ -231,7 +231,7 @@ class HashTable {
             let currentNode = bucket;
             while (currentNode) {
                 const newIndex = this._hash(currentNode.key);
-                const newNode = new HashTableNode(currentNode.key, currentNode.val);
+                const newNode = new HashTableNode(currentNode.key, currentNode.value);
                 if (!newBuckets[newIndex]) {
                     newBuckets[newIndex] = newNode;
                 }

package/dist/mjs/data-structures/linked-list/doubly-linked-list.d.ts

@@ -8,13 +8,13 @@
 export declare class DoublyLinkedListNode<E = any> {
     /**
      * The constructor function initializes the value, next, and previous properties of an object.
-     * @param {E} val - The "val" parameter is the value that will be stored in the node. It can be of any data type, as it
+     * @param {E} value - The "value" parameter is the value that will be stored in the node. It can be of any data type, as it
      * is defined as a generic type "E".
      */
-    constructor(val: E);
-    private _val;
-    get val(): E;
-    set val(value: E);
+    constructor(value: E);
+    private _value;
+    get value(): E;
+    set value(value: E);
     private _next;
     get next(): DoublyLinkedListNode<E> | null;
     set next(value: DoublyLinkedListNode<E> | null);
@@ -45,23 +45,23 @@ export declare class DoublyLinkedList<E = any> {
     static fromArray<E>(data: E[]): DoublyLinkedList<E>;
     /**
      * The push function adds a new node with the given value to the end of the doubly linked list.
-     * @param {E} val - The value to be added to the linked list.
+     * @param {E} value - The value to be added to the linked list.
      */
-    push(val: E): void;
+    push(value: E): void;
     /**
      * The addLast function adds a new node with the given value to the end of the doubly linked list.
-     * @param {E} val - The value to be added to the linked list.
+     * @param {E} value - The value to be added to the linked list.
      */
-    addLast(val: E): void;
+    addLast(value: E): void;
     /**
      * The `pop()` function removes and returns the value of the last node in a doubly linked list.
-     * @returns The method is returning the value of the removed node (removedNode.val) if the list is not empty. If the
+     * @returns The method is returning the value of the removed node (removedNode.value) if the list is not empty. If the
      * list is empty, it returns null.
      */
     pop(): E | undefined;
     /**
      * The `popLast()` function removes and returns the value of the last node in a doubly linked list.
-     * @returns The method is returning the value of the removed node (removedNode.val) if the list is not empty. If the
+     * @returns The method is returning the value of the removed node (removedNode.value) if the list is not empty. If the
      * list is empty, it returns null.
      */
     popLast(): E | undefined;
@@ -79,16 +79,16 @@ export declare class DoublyLinkedList<E = any> {
     popFirst(): E | undefined;
     /**
      * The unshift function adds a new node with the given value to the beginning of a doubly linked list.
-     * @param {E} val - The `val` parameter represents the value of the new node that will be added to the beginning of the
+     * @param {E} value - The `value` parameter represents the value of the new node that will be added to the beginning of the
      * doubly linked list.
      */
-    unshift(val: E): void;
+    unshift(value: E): void;
     /**
      * The addFirst function adds a new node with the given value to the beginning of a doubly linked list.
-     * @param {E} val - The `val` parameter represents the value of the new node that will be added to the beginning of the
+     * @param {E} value - The `value` parameter represents the value of the new node that will be added to the beginning of the
      * doubly linked list.
      */
-    addFirst(val: E): void;
+    addFirst(value: E): void;
     /**
      * The `getFirst` function returns the first node in a doubly linked list, or null if the list is empty.
      * @returns The method `getFirst()` returns the first node of the doubly linked list, or `null` if the list is empty.
@@ -119,21 +119,21 @@ export declare class DoublyLinkedList<E = any> {
     /**
      * The function `findNodeByValue` searches for a node with a specific value in a doubly linked list and returns the
      * node if found, otherwise it returns null.
-     * @param {E} val - The `val` parameter is the value that we want to search for in the doubly linked list.
-     * @returns The function `findNodeByValue` returns a `DoublyLinkedListNode<E>` if a node with the specified value `val`
+     * @param {E} value - The `value` parameter is the value that we want to search for in the doubly linked list.
+     * @returns The function `findNodeByValue` returns a `DoublyLinkedListNode<E>` if a node with the specified value `value`
      * is found in the linked list. If no such node is found, it returns `null`.
      */
-    getNode(val: E | null): DoublyLinkedListNode<E> | null;
+    getNode(value: E | null): DoublyLinkedListNode<E> | null;
     /**
      * The `insert` function inserts a value at a specified index in a doubly linked list.
      * @param {number} index - The index parameter represents the position at which the new value should be inserted in the
      * DoublyLinkedList. It is of type number.
-     * @param {E} val - The `val` parameter represents the value that you want to insert into the Doubly Linked List at the
+     * @param {E} value - The `value` parameter represents the value that you want to insert into the Doubly Linked List at the
      * specified index.
      * @returns The `insert` method returns a boolean value. It returns `true` if the insertion is successful, and `false`
      * if the index is out of bounds.
      */
-    insertAt(index: number, val: E): boolean;
+    insertAt(index: number, value: E): boolean;
     /**
      * The `insertBefore` function inserts a new value before an existing value or node in a doubly linked list.
      * @param {E | DoublyLinkedListNode<E>} existingValueOrNode - The existing value or node in the doubly linked list
@@ -182,15 +182,15 @@ export declare class DoublyLinkedList<E = any> {
      * @returns The method `find` returns the first element in the linked list that satisfies the condition specified by
      * the callback function. If no element satisfies the condition, it returns `null`.
      */
-    find(callback: (val: E) => boolean): E | null;
+    find(callback: (value: E) => boolean): E | null;
     /**
      * The function returns the index of the first occurrence of a given value in a linked list.
-     * @param {E} val - The parameter `val` is of type `E`, which means it can be any data type. It represents the value
+     * @param {E} value - The parameter `value` is of type `E`, which means it can be any data type. It represents the value
      * that we are searching for in the linked list.
-     * @returns The method `indexOf` returns the index of the first occurrence of the specified value `val` in the linked
+     * @returns The method `indexOf` returns the index of the first occurrence of the specified value `value` in the linked
      * list. If the value is not found, it returns -1.
      */
-    indexOf(val: E): number;
+    indexOf(value: E): number;
     /**
      * The `findBackward` function iterates through a linked list from the last node to the first node and returns the last
      * value that satisfies the given callback function, or null if no value satisfies the callback.
@@ -199,7 +199,7 @@ export declare class DoublyLinkedList<E = any> {
      * @returns The method `findBackward` returns the last value in the linked list that satisfies the condition specified by
      * the callback function. If no value satisfies the condition, it returns `null`.
      */
-    findBackward(callback: (val: E) => boolean): E | null;
+    findBackward(callback: (value: E) => boolean): E | null;
     /**
      * The `toArrayBackward` function converts a doubly linked list into an array in reverse order.
      * @returns The `toArrayBackward()` function returns an array of type `E[]`.
@@ -211,11 +211,11 @@ export declare class DoublyLinkedList<E = any> {
     reverse(): void;
     /**
      * The `forEach` function iterates over each element in a linked list and applies a callback function to each element.
-     * @param callback - The callback parameter is a function that takes two arguments: val and index. The val argument
+     * @param callback - The callback parameter is a function that takes two arguments: value and index. The value argument
      * represents the value of the current node in the linked list, and the index argument represents the index of the
      * current node in the linked list.
      */
-    forEach(callback: (val: E, index: number) => void): void;
+    forEach(callback: (value: E, index: number) => void): void;
     /**
      * The `map` function takes a callback function and applies it to each element in the DoublyLinkedList, returning a new
      * DoublyLinkedList with the transformed values.
@@ -224,7 +224,7 @@ export declare class DoublyLinkedList<E = any> {
      * DoublyLinkedList).
      * @returns The `map` function is returning a new instance of `DoublyLinkedList<U>` that contains the mapped values.
      */
-    map<U>(callback: (val: E) => U): DoublyLinkedList<U>;
+    map<U>(callback: (value: E) => U): DoublyLinkedList<U>;
     /**
      * The `filter` function iterates through a DoublyLinkedList and returns a new DoublyLinkedList containing only the
      * elements that satisfy the given callback function.
@@ -232,18 +232,18 @@ export declare class DoublyLinkedList<E = any> {
      * It is used to determine whether a value should be included in the filtered list or not.
      * @returns The filtered list, which is an instance of the DoublyLinkedList class.
      */
-    filter(callback: (val: E) => boolean): DoublyLinkedList<E>;
+    filter(callback: (value: E) => boolean): DoublyLinkedList<E>;
     /**
      * The `reduce` function iterates over a linked list and applies a callback function to each element, accumulating a
      * single value.
-     * @param callback - The `callback` parameter is a function that takes two arguments: `accumulator` and `val`. It is
+     * @param callback - The `callback` parameter is a function that takes two arguments: `accumulator` and `value`. It is
      * used to perform a specific operation on each element of the linked list.
      * @param {U} initialValue - The `initialValue` parameter is the initial value of the accumulator. It is the starting
      * point for the reduction operation.
      * @returns The `reduce` method is returning the final value of the accumulator after iterating through all the
      * elements in the linked list.
      */
-    reduce<U>(callback: (accumulator: U, val: E) => U, initialValue: U): U;
+    reduce<U>(callback: (accumulator: U, value: E) => U, initialValue: U): U;
     /**
      * The `insertAfter` function inserts a new node with a given value after an existing node in a doubly linked list.
      * @param {E | DoublyLinkedListNode<E>} existingValueOrNode - The existing value or node in the doubly linked list

package/dist/mjs/data-structures/linked-list/doubly-linked-list.js

@@ -11,20 +11,20 @@ exports.DoublyLinkedList = exports.DoublyLinkedListNode = void 0;
 class DoublyLinkedListNode {
     /**
      * The constructor function initializes the value, next, and previous properties of an object.
-     * @param {E} val - The "val" parameter is the value that will be stored in the node. It can be of any data type, as it
+     * @param {E} value - The "value" parameter is the value that will be stored in the node. It can be of any data type, as it
      * is defined as a generic type "E".
      */
-    constructor(val) {
-        this._val = val;
+    constructor(value) {
+        this._value = value;
         this._next = null;
         this._prev = null;
     }
-    _val;
-    get val() {
-        return this._val;
+    _value;
+    get value() {
+        return this._value;
     }
-    set val(value) {
-        this._val = value;
+    set value(value) {
+        this._value = value;
     }
     _next;
     get next() {
@@ -87,10 +87,10 @@ class DoublyLinkedList {
     }
     /**
      * The push function adds a new node with the given value to the end of the doubly linked list.
-     * @param {E} val - The value to be added to the linked list.
+     * @param {E} value - The value to be added to the linked list.
      */
-    push(val) {
-        const newNode = new DoublyLinkedListNode(val);
+    push(value) {
+        const newNode = new DoublyLinkedListNode(value);
         if (!this.head) {
             this.head = newNode;
             this.tail = newNode;
@@ -104,14 +104,14 @@ class DoublyLinkedList {
     }
     /**
      * The addLast function adds a new node with the given value to the end of the doubly linked list.
-     * @param {E} val - The value to be added to the linked list.
+     * @param {E} value - The value to be added to the linked list.
      */
-    addLast(val) {
-        this.push(val);
+    addLast(value) {
+        this.push(value);
     }
     /**
      * The `pop()` function removes and returns the value of the last node in a doubly linked list.
-     * @returns The method is returning the value of the removed node (removedNode.val) if the list is not empty. If the
+     * @returns The method is returning the value of the removed node (removedNode.value) if the list is not empty. If the
      * list is empty, it returns null.
      */
     pop() {
@@ -127,11 +127,11 @@ class DoublyLinkedList {
             this.tail.next = null;
         }
         this._length--;
-        return removedNode.val;
+        return removedNode.value;
     }
     /**
      * The `popLast()` function removes and returns the value of the last node in a doubly linked list.
-     * @returns The method is returning the value of the removed node (removedNode.val) if the list is not empty. If the
+     * @returns The method is returning the value of the removed node (removedNode.value) if the list is not empty. If the
      * list is empty, it returns null.
      */
     popLast() {
@@ -155,7 +155,7 @@ class DoublyLinkedList {
             this.head.prev = null;
         }
         this._length--;
-        return removedNode.val;
+        return removedNode.value;
     }
     /**
      * The `popFirst()` function removes and returns the value of the first node in a doubly linked list.
@@ -167,11 +167,11 @@ class DoublyLinkedList {
     }
     /**
      * The unshift function adds a new node with the given value to the beginning of a doubly linked list.
-     * @param {E} val - The `val` parameter represents the value of the new node that will be added to the beginning of the
+     * @param {E} value - The `value` parameter represents the value of the new node that will be added to the beginning of the
      * doubly linked list.
      */
-    unshift(val) {
-        const newNode = new DoublyLinkedListNode(val);
+    unshift(value) {
+        const newNode = new DoublyLinkedListNode(value);
         if (!this.head) {
             this.head = newNode;
             this.tail = newNode;
@@ -185,25 +185,25 @@ class DoublyLinkedList {
     }
     /**
      * The addFirst function adds a new node with the given value to the beginning of a doubly linked list.
-     * @param {E} val - The `val` parameter represents the value of the new node that will be added to the beginning of the
+     * @param {E} value - The `value` parameter represents the value of the new node that will be added to the beginning of the
      * doubly linked list.
      */
-    addFirst(val) {
-        this.unshift(val);
+    addFirst(value) {
+        this.unshift(value);
     }
     /**
      * The `getFirst` function returns the first node in a doubly linked list, or null if the list is empty.
      * @returns The method `getFirst()` returns the first node of the doubly linked list, or `null` if the list is empty.
      */
     getFirst() {
-        return this.head?.val;
+        return this.head?.value;
     }
     /**
      * The `getLast` function returns the last node in a doubly linked list, or null if the list is empty.
      * @returns The method `getLast()` returns the last node of the doubly linked list, or `null` if the list is empty.
      */
     getLast() {
-        return this.tail?.val;
+        return this.tail?.value;
     }
     /**
      * The `getAt` function returns the value at a specified index in a linked list, or null if the index is out of bounds.
@@ -219,7 +219,7 @@ class DoublyLinkedList {
         for (let i = 0; i < index; i++) {
             current = current.next;
         }
-        return current.val;
+        return current.value;
     }
     /**
      * The function `getNodeAt` returns the node at a given index in a doubly linked list, or null if the index is out of
@@ -241,14 +241,14 @@ class DoublyLinkedList {
     /**
      * The function `findNodeByValue` searches for a node with a specific value in a doubly linked list and returns the
      * node if found, otherwise it returns null.
-     * @param {E} val - The `val` parameter is the value that we want to search for in the doubly linked list.
-     * @returns The function `findNodeByValue` returns a `DoublyLinkedListNode<E>` if a node with the specified value `val`
+     * @param {E} value - The `value` parameter is the value that we want to search for in the doubly linked list.
+     * @returns The function `findNodeByValue` returns a `DoublyLinkedListNode<E>` if a node with the specified value `value`
      * is found in the linked list. If no such node is found, it returns `null`.
      */
-    getNode(val) {
+    getNode(value) {
         let current = this.head;
         while (current) {
-            if (current.val === val) {
+            if (current.value === value) {
                 return current;
             }
             current = current.next;
@@ -259,23 +259,23 @@ class DoublyLinkedList {
      * The `insert` function inserts a value at a specified index in a doubly linked list.
      * @param {number} index - The index parameter represents the position at which the new value should be inserted in the
      * DoublyLinkedList. It is of type number.
-     * @param {E} val - The `val` parameter represents the value that you want to insert into the Doubly Linked List at the
+     * @param {E} value - The `value` parameter represents the value that you want to insert into the Doubly Linked List at the
      * specified index.
      * @returns The `insert` method returns a boolean value. It returns `true` if the insertion is successful, and `false`
      * if the index is out of bounds.
      */
-    insertAt(index, val) {
+    insertAt(index, value) {
         if (index < 0 || index > this.length)
             return false;
         if (index === 0) {
-            this.unshift(val);
+            this.unshift(value);
             return true;
         }
         if (index === this.length) {
-            this.push(val);
+            this.push(value);
             return true;
         }
-        const newNode = new DoublyLinkedListNode(val);
+        const newNode = new DoublyLinkedListNode(value);
         const prevNode = this.getNodeAt(index - 1);
         const nextNode = prevNode.next;
         newNode.prev = prevNode;
@@ -339,7 +339,7 @@ class DoublyLinkedList {
         prevNode.next = nextNode;
         nextNode.prev = prevNode;
         this._length--;
-        return removedNode.val;
+        return removedNode.value;
     }
     /**
      * The `delete` function removes a node from a doubly linked list based on either the node itself or its value.
@@ -382,7 +382,7 @@ class DoublyLinkedList {
         const array = [];
         let current = this.head;
         while (current) {
-            array.push(current.val);
+            array.push(current.value);
             current = current.next;
         }
         return array;
@@ -412,8 +412,8 @@ class DoublyLinkedList {
     find(callback) {
         let current = this.head;
         while (current) {
-            if (callback(current.val)) {
-                return current.val;
+            if (callback(current.value)) {
+                return current.value;
             }
             current = current.next;
         }
@@ -421,16 +421,16 @@ class DoublyLinkedList {
     }
     /**
      * The function returns the index of the first occurrence of a given value in a linked list.
-     * @param {E} val - The parameter `val` is of type `E`, which means it can be any data type. It represents the value
+     * @param {E} value - The parameter `value` is of type `E`, which means it can be any data type. It represents the value
      * that we are searching for in the linked list.
-     * @returns The method `indexOf` returns the index of the first occurrence of the specified value `val` in the linked
+     * @returns The method `indexOf` returns the index of the first occurrence of the specified value `value` in the linked
      * list. If the value is not found, it returns -1.
      */
-    indexOf(val) {
+    indexOf(value) {
         let index = 0;
         let current = this.head;
         while (current) {
-            if (current.val === val) {
+            if (current.value === value) {
                 return index;
             }
             index++;
@@ -449,8 +449,8 @@ class DoublyLinkedList {
     findBackward(callback) {
         let current = this.tail;
         while (current) {
-            if (callback(current.val)) {
-                return current.val;
+            if (callback(current.value)) {
+                return current.value;
             }
             current = current.prev;
         }
@@ -464,7 +464,7 @@ class DoublyLinkedList {
         const array = [];
         let current = this.tail;
         while (current) {
-            array.push(current.val);
+            array.push(current.value);
             current = current.prev;
         }
         return array;
@@ -483,7 +483,7 @@ class DoublyLinkedList {
     }
     /**
      * The `forEach` function iterates over each element in a linked list and applies a callback function to each element.
-     * @param callback - The callback parameter is a function that takes two arguments: val and index. The val argument
+     * @param callback - The callback parameter is a function that takes two arguments: value and index. The value argument
      * represents the value of the current node in the linked list, and the index argument represents the index of the
      * current node in the linked list.
      */
@@ -491,7 +491,7 @@ class DoublyLinkedList {
         let current = this.head;
         let index = 0;
         while (current) {
-            callback(current.val, index);
+            callback(current.value, index);
             current = current.next;
             index++;
         }
@@ -508,7 +508,7 @@ class DoublyLinkedList {
         const mappedList = new DoublyLinkedList();
         let current = this.head;
         while (current) {
-            mappedList.push(callback(current.val));
+            mappedList.push(callback(current.value));
             current = current.next;
         }
         return mappedList;
@@ -524,8 +524,8 @@ class DoublyLinkedList {
         const filteredList = new DoublyLinkedList();
         let current = this.head;
         while (current) {
-            if (callback(current.val)) {
-                filteredList.push(current.val);
+            if (callback(current.value)) {
+                filteredList.push(current.value);
             }
             current = current.next;
         }
@@ -534,7 +534,7 @@ class DoublyLinkedList {
     /**
      * The `reduce` function iterates over a linked list and applies a callback function to each element, accumulating a
      * single value.
-     * @param callback - The `callback` parameter is a function that takes two arguments: `accumulator` and `val`. It is
+     * @param callback - The `callback` parameter is a function that takes two arguments: `accumulator` and `value`. It is
      * used to perform a specific operation on each element of the linked list.
      * @param {U} initialValue - The `initialValue` parameter is the initial value of the accumulator. It is the starting
      * point for the reduction operation.
@@ -545,7 +545,7 @@ class DoublyLinkedList {
         let accumulator = initialValue;
         let current = this.head;
         while (current) {
-            accumulator = callback(accumulator, current.val);
+            accumulator = callback(accumulator, current.value);
             current = current.next;
         }
         return accumulator;
@@ -589,7 +589,7 @@ class DoublyLinkedList {
     *[Symbol.iterator]() {
         let current = this.head;
         while (current) {
-            yield current.val;
+            yield current.value;
             current = current.next;
         }
     }