min-heap-typed 1.39.4 → 1.39.6

package/dist/data-structures/linked-list/singly-linked-list.js

@@ -11,18 +11,18 @@ exports.SinglyLinkedList = exports.SinglyLinkedListNode = void 0;
 class SinglyLinkedListNode {
     /**
      * The constructor function initializes an instance of a class with a given value and sets the next property to null.
-     * @param {E} val - The "val" parameter is of type E, which means it can be any data type. It represents the value that
+     * @param {E} value - The "value" parameter is of type E, which means it can be any data type. It represents the value that
      * will be stored in the node of a linked list.
      */
-    constructor(val) {
-        this._val = val;
+    constructor(value) {
+        this._value = value;
         this._next = null;
     }
-    get val() {
-        return this._val;
+    get value() {
+        return this._value;
     }
-    set val(value) {
-        this._val = value;
+    set value(value) {
+        this._value = value;
     }
     get next() {
         return this._next;
@@ -70,12 +70,12 @@ class SinglyLinkedList {
         return singlyLinkedList;
     }
     /**
-     * The `push` function adds a new node with the given val to the end of a singly linked list.
-     * @param {E} val - The "val" parameter represents the value that you want to add to the linked list. It can be of
+     * The `push` function adds a new node with the given value to the end of a singly linked list.
+     * @param {E} value - The "value" parameter represents the value that you want to add to the linked list. It can be of
      * any type (E) as specified in the generic type declaration of the class or function.
      */
-    push(val) {
-        const newNode = new SinglyLinkedListNode(val);
+    push(value) {
+        const newNode = new SinglyLinkedListNode(value);
         if (!this.head) {
             this.head = newNode;
             this.tail = newNode;
@@ -87,12 +87,12 @@ class SinglyLinkedList {
         this._length++;
     }
     /**
-     * The `push` function adds a new node with the given val to the end of a singly linked list.
-     * @param {E} val - The "val" parameter represents the value that you want to add to the linked list. It can be of
+     * The `push` function adds a new node with the given value to the end of a singly linked list.
+     * @param {E} value - The "value" parameter represents the value that you want to add to the linked list. It can be of
      * any type (E) as specified in the generic type declaration of the class or function.
      */
-    addLast(val) {
-        this.push(val);
+    addLast(value) {
+        this.push(value);
     }
     /**
      * The `pop()` function removes and returns the value of the last element in a linked list, updating the head and tail
@@ -104,21 +104,21 @@ class SinglyLinkedList {
         if (!this.head)
             return undefined;
         if (this.head === this.tail) {
-            const val = this.head.val;
+            const value = this.head.value;
             this.head = null;
             this.tail = null;
             this._length--;
-            return val;
+            return value;
         }
         let current = this.head;
         while (current.next !== this.tail) {
             current = current.next;
         }
-        const val = this.tail.val;
+        const value = this.tail.value;
         current.next = null;
         this.tail = current;
         this._length--;
-        return val;
+        return value;
     }
     /**
      * The `popLast()` function removes and returns the value of the last element in a linked list, updating the head and tail
@@ -139,7 +139,7 @@ class SinglyLinkedList {
         const removedNode = this.head;
         this.head = this.head.next;
         this._length--;
-        return removedNode.val;
+        return removedNode.value;
     }
     /**
      * The `popFirst()` function removes and returns the value of the first node in a linked list.
@@ -150,11 +150,11 @@ class SinglyLinkedList {
     }
     /**
      * The unshift function adds a new node with the given value to the beginning of a singly linked list.
-     * @param {E} val - The parameter "val" represents the value of the new node that will be added to the beginning of the
+     * @param {E} value - The parameter "value" represents the value of the new node that will be added to the beginning of the
      * linked list.
      */
-    unshift(val) {
-        const newNode = new SinglyLinkedListNode(val);
+    unshift(value) {
+        const newNode = new SinglyLinkedListNode(value);
         if (!this.head) {
             this.head = newNode;
             this.tail = newNode;
@@ -167,11 +167,11 @@ class SinglyLinkedList {
     }
     /**
      * The addFirst function adds a new node with the given value to the beginning of a singly linked list.
-     * @param {E} val - The parameter "val" represents the value of the new node that will be added to the beginning of the
+     * @param {E} value - The parameter "value" represents the value of the new node that will be added to the beginning of the
      * linked list.
      */
-    addFirst(val) {
-        this.unshift(val);
+    addFirst(value) {
+        this.unshift(value);
     }
     /**
      * The function `getAt` returns the value at a specified index in a linked list, or null if the index is out of range.
@@ -187,7 +187,7 @@ class SinglyLinkedList {
         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 singly linked list.
@@ -221,7 +221,7 @@ class SinglyLinkedList {
         const removedNode = prevNode.next;
         prevNode.next = removedNode.next;
         this._length--;
-        return removedNode.val;
+        return removedNode.value;
     }
     /**
      * The delete function removes a node with a specific value from a singly linked list.
@@ -235,14 +235,14 @@ class SinglyLinkedList {
             return false;
         let value;
         if (valueOrNode instanceof SinglyLinkedListNode) {
-            value = valueOrNode.val;
+            value = valueOrNode.value;
         }
         else {
             value = valueOrNode;
         }
         let current = this.head, prev = null;
         while (current) {
-            if (current.val === value) {
+            if (current.value === value) {
                 if (prev === null) {
                     this.head = current.next;
                     if (current === this.tail) {
@@ -267,23 +267,23 @@ class SinglyLinkedList {
      * The `insertAt` function inserts a value at a specified index in a singly linked list.
      * @param {number} index - The index parameter represents the position at which the new value should be inserted in the
      * linked list. It is of type number.
-     * @param {E} val - The `val` parameter represents the value that you want to insert into the linked list at the
+     * @param {E} value - The `value` parameter represents the value that you want to insert into the 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 SinglyLinkedListNode(val);
+        const newNode = new SinglyLinkedListNode(value);
         const prevNode = this.getNodeAt(index - 1);
         newNode.next = prevNode.next;
         prevNode.next = newNode;
@@ -314,7 +314,7 @@ class SinglyLinkedList {
         const array = [];
         let current = this.head;
         while (current) {
-            array.push(current.val);
+            array.push(current.value);
             current = current.next;
         }
         return array;
@@ -347,8 +347,8 @@ class SinglyLinkedList {
     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;
         }
@@ -364,7 +364,7 @@ class SinglyLinkedList {
         let index = 0;
         let current = this.head;
         while (current) {
-            if (current.val === value) {
+            if (current.value === value) {
                 return index;
             }
             index++;
@@ -382,7 +382,7 @@ class SinglyLinkedList {
     getNode(value) {
         let current = this.head;
         while (current) {
-            if (current.val === value) {
+            if (current.value === value) {
                 return current;
             }
             current = current.next;
@@ -402,18 +402,18 @@ class SinglyLinkedList {
             return false;
         let existingValue;
         if (existingValueOrNode instanceof SinglyLinkedListNode) {
-            existingValue = existingValueOrNode.val;
+            existingValue = existingValueOrNode.value;
         }
         else {
             existingValue = existingValueOrNode;
         }
-        if (this.head.val === existingValue) {
+        if (this.head.value === existingValue) {
             this.unshift(newValue);
             return true;
         }
         let current = this.head;
         while (current.next) {
-            if (current.next.val === existingValue) {
+            if (current.next.value === existingValue) {
                 const newNode = new SinglyLinkedListNode(newValue);
                 newNode.next = current.next;
                 current.next = newNode;
@@ -461,7 +461,7 @@ class SinglyLinkedList {
         let count = 0;
         let current = this.head;
         while (current) {
-            if (current.val === value) {
+            if (current.value === value) {
                 count++;
             }
             current = current.next;
@@ -470,7 +470,7 @@ class SinglyLinkedList {
     }
     /**
      * 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.
      */
@@ -478,7 +478,7 @@ class SinglyLinkedList {
         let current = this.head;
         let index = 0;
         while (current) {
-            callback(current.val, index);
+            callback(current.value, index);
             current = current.next;
             index++;
         }
@@ -495,7 +495,7 @@ class SinglyLinkedList {
         const mappedList = new SinglyLinkedList();
         let current = this.head;
         while (current) {
-            mappedList.push(callback(current.val));
+            mappedList.push(callback(current.value));
             current = current.next;
         }
         return mappedList;
@@ -511,8 +511,8 @@ class SinglyLinkedList {
         const filteredList = new SinglyLinkedList();
         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;
         }
@@ -521,7 +521,7 @@ class SinglyLinkedList {
     /**
      * 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.
@@ -532,7 +532,7 @@ class SinglyLinkedList {
         let accumulator = initialValue;
         let current = this.head;
         while (current) {
-            accumulator = callback(accumulator, current.val);
+            accumulator = callback(accumulator, current.value);
             current = current.next;
         }
         return accumulator;
@@ -543,7 +543,7 @@ class SinglyLinkedList {
     *[Symbol.iterator]() {
         let current = this.head;
         while (current) {
-            yield current.val;
+            yield current.value;
             current = current.next;
         }
     }

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

@@ -4,7 +4,7 @@
  * @class
  */
 import { SinglyLinkedList } from '../linked-list';
-export declare class LinkedListQueue<E = any> extends SinglyLinkedList<E> {
+export declare class SkipQueue<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.

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

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Queue = exports.LinkedListQueue = void 0;
+exports.Queue = exports.SkipQueue = 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 {
+class SkipQueue 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.
@@ -28,10 +28,10 @@ class LinkedListQueue extends linked_list_1.SinglyLinkedList {
      */
     peek() {
         var _a;
-        return (_a = this.head) === null || _a === void 0 ? void 0 : _a.val;
+        return (_a = this.head) === null || _a === void 0 ? void 0 : _a.value;
     }
 }
-exports.LinkedListQueue = LinkedListQueue;
+exports.SkipQueue = SkipQueue;
 class Queue {
     /**
      * The constructor initializes an instance of a class with an optional array of elements and sets the offset to 0.

package/dist/interfaces/binary-tree.d.ts

@@ -1,7 +1,7 @@
 import { BinaryTreeNode } from '../data-structures';
 import { BinaryTreeDeletedResult, BTNKey, BinaryTreeNodeNested, BTNCallback } from '../types';
 export interface IBinaryTree<V = any, N extends BinaryTreeNode<V, N> = BinaryTreeNodeNested<V>> {
-    createNode(key: BTNKey, val?: N['val']): N;
-    add(keyOrNode: BTNKey | N | null, val?: N['val']): N | null | undefined;
+    createNode(key: BTNKey, value?: N['value']): N;
+    add(keyOrNode: BTNKey | N | null, value?: N['value']): N | null | undefined;
     delete<C extends BTNCallback<N>>(identifier: ReturnType<C> | null, callback: C): BinaryTreeDeletedResult<N>[];
 }

package/dist/interfaces/graph.d.ts

@@ -1,5 +1,5 @@
 import { VertexKey } from '../types';
-export interface IGraph<V, E> {
-    createVertex(key: VertexKey, val?: V): V;
-    createEdge(srcOrV1: VertexKey | string, destOrV2: VertexKey | string, weight?: number, val?: E): E;
+export interface IGraph<V, E, VO, EO> {
+    createVertex(key: VertexKey, value?: V): VO;
+    createEdge(srcOrV1: VertexKey, destOrV2: VertexKey, weight?: number, value?: E): EO;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "min-heap-typed",
-  "version": "1.39.4",
+  "version": "1.39.6",
   "description": "Min Heap. Javascript & Typescript Data Structure.",
   "main": "dist/index.js",
   "scripts": {
@@ -131,6 +131,6 @@
     "typescript": "^4.9.5"
   },
   "dependencies": {
-    "data-structure-typed": "^1.39.4"
+    "data-structure-typed": "^1.39.6"
   }
 }

package/src/data-structures/binary-tree/avl-tree.ts

@@ -13,8 +13,8 @@ import {IBinaryTree} from '../../interfaces';
 export class AVLTreeNode<V = any, N extends AVLTreeNode<V, N> = AVLTreeNodeNested<V>> extends BSTNode<V, N> {
   height: number;
 
-  constructor(key: BTNKey, val?: V) {
-    super(key, val);
+  constructor(key: BTNKey, value?: V) {
+    super(key, value);
     this.height = 0;
   }
 }
@@ -37,13 +37,13 @@ export class AVLTree<V = any, N extends AVLTreeNode<V, N> = AVLTreeNode<V, AVLTr
    * The function creates a new AVL tree node with the specified key and value.
    * @param {BTNKey} key - The key parameter is the key value that will be associated with
    * the new node. It is used to determine the position of the node in the binary search tree.
-   * @param [val] - The parameter `val` is an optional value that can be assigned to the node. It is of
-   * type `V`, which means it can be any value that is assignable to the `val` property of the
+   * @param [value] - The parameter `value` is an optional value that can be assigned to the node. It is of
+   * type `V`, which means it can be any value that is assignable to the `value` property of the
    * node type `N`.
    * @returns a new AVLTreeNode object with the specified key and value.
    */
-  override createNode(key: BTNKey, val?: V): N {
-    return new AVLTreeNode<V, N>(key, val) as N;
+  override createNode(key: BTNKey, value?: V): N {
+    return new AVLTreeNode<V, N>(key, value) as N;
   }
 
   /**
@@ -51,13 +51,13 @@ export class AVLTree<V = any, N extends AVLTreeNode<V, N> = AVLTreeNode<V, AVLTr
    * a new node.
    * @param {BTNKey | N | null} keyOrNode - The `keyOrNode` parameter can accept either a
    * `BTNKey` or a `N` (which represents a node in the binary tree) or `null`.
-   * @param [val] - The `val` parameter is the value that you want to assign to the new node that you
+   * @param [value] - The `value` parameter is the value that you want to assign to the new node that you
    * are adding to the binary search tree.
    * @returns The method is returning the inserted node (`N`), `null`, or `undefined`.
    */
-  override add(keyOrNode: BTNKey | N | null, val?: V): N | null | undefined {
+  override add(keyOrNode: BTNKey | N | null, value?: V): N | null | undefined {
     // TODO support node as a param
-    const inserted = super.add(keyOrNode, val);
+    const inserted = super.add(keyOrNode, value);
     if (inserted) this._balancePath(inserted);
     return inserted;
   }
@@ -97,18 +97,18 @@ export class AVLTree<V = any, N extends AVLTreeNode<V, N> = AVLTreeNode<V, AVLTr
    * @returns The method is returning the `destNode` after swapping its properties with the `srcNode`.
    */
   protected override _swap(srcNode: N, destNode: N): N {
-    const {key, val, height} = destNode;
-    const tempNode = this.createNode(key, val);
+    const {key, value, height} = destNode;
+    const tempNode = this.createNode(key, value);
 
     if (tempNode) {
       tempNode.height = height;
 
       destNode.key = srcNode.key;
-      destNode.val = srcNode.val;
+      destNode.value = srcNode.value;
       destNode.height = srcNode.height;
 
       srcNode.key = tempNode.key;
-      srcNode.val = tempNode.val;
+      srcNode.value = tempNode.value;
       srcNode.height = tempNode.height;
     }
 

package/src/data-structures/binary-tree/binary-tree.ts

@@ -26,7 +26,7 @@ export class BinaryTreeNode<V = any, N extends BinaryTreeNode<V, N> = BinaryTree
   /**
    * The value stored in the node.
    */
-  val: V | undefined;
+  value: V | undefined;
 
   /**
    * The parent node of the current node.
@@ -36,11 +36,11 @@ export class BinaryTreeNode<V = any, N extends BinaryTreeNode<V, N> = BinaryTree
   /**
    * Creates a new instance of BinaryTreeNode.
    * @param {BTNKey} key - The key associated with the node.
-   * @param {V} val - The value stored in the node.
+   * @param {V} value - The value stored in the node.
    */
-  constructor(key: BTNKey, val?: V) {
+  constructor(key: BTNKey, value?: V) {
     this.key = key;
-    this.val = val;
+    this.value = value;
   }
 
   private _left: N | null | undefined;
@@ -159,11 +159,11 @@ export class BinaryTree<V = any, N extends BinaryTreeNode<V, N> = BinaryTreeNode
   /**
    * Creates a new instance of BinaryTreeNode with the given key and value.
    * @param {BTNKey} key - The key for the new node.
-   * @param {V} val - The value for the new node.
+   * @param {V} value - The value for the new node.
    * @returns {N} - The newly created BinaryTreeNode.
    */
-  createNode(key: BTNKey, val?: V): N {
-    return new BinaryTreeNode<V, N>(key, val) as N;
+  createNode(key: BTNKey, value?: V): N {
+    return new BinaryTreeNode<V, N>(key, value) as N;
   }
 
   /**
@@ -185,10 +185,10 @@ export class BinaryTree<V = any, N extends BinaryTreeNode<V, N> = BinaryTreeNode
   /**
    * Add a node with the given key and value to the binary tree.
    * @param {BTNKey | N | null} keyOrNode - The key or node to add to the binary tree.
-   * @param {V} val - The value for the new node (optional).
+   * @param {V} value - The value for the new node (optional).
    * @returns {N | null | undefined} - The inserted node, or null if nothing was inserted, or undefined if the operation failed.
    */
-  add(keyOrNode: BTNKey | N | null, val?: V): N | null | undefined {
+  add(keyOrNode: BTNKey | N | null, value?: V): N | null | undefined {
     const _bfs = (root: N, newNode: N | null): N | undefined | null => {
       const queue = new Queue<N | null>([root]);
       while (queue.size > 0) {
@@ -209,7 +209,7 @@ export class BinaryTree<V = any, N extends BinaryTreeNode<V, N> = BinaryTreeNode
     if (keyOrNode === null) {
       needInsert = null;
     } else if (typeof keyOrNode === 'number') {
-      needInsert = this.createNode(keyOrNode, val);
+      needInsert = this.createNode(keyOrNode, value);
     } else if (keyOrNode instanceof BinaryTreeNode) {
       needInsert = keyOrNode;
     } else {
@@ -221,7 +221,7 @@ export class BinaryTree<V = any, N extends BinaryTreeNode<V, N> = BinaryTreeNode
 
     if (this.root) {
       if (existNode) {
-        existNode.val = val;
+        existNode.value = value;
         inserted = existNode;
       } else {
         inserted = _bfs(this.root, needInsert);
@@ -252,15 +252,15 @@ export class BinaryTree<V = any, N extends BinaryTreeNode<V, N> = BinaryTreeNode
     // TODO not sure addMany not be run multi times
     return keysOrNodes.map((keyOrNode, i) => {
       if (keyOrNode instanceof BinaryTreeNode) {
-        return this.add(keyOrNode.key, keyOrNode.val);
+        return this.add(keyOrNode.key, keyOrNode.value);
       }
 
       if (keyOrNode === null) {
         return this.add(null);
       }
 
-      const val = values?.[i];
-      return this.add(keyOrNode, val);
+      const value = values?.[i];
+      return this.add(keyOrNode, value);
     });
   }
 
@@ -1212,15 +1212,15 @@ export class BinaryTree<V = any, N extends BinaryTreeNode<V, N> = BinaryTreeNode
    * @returns {N} - The destination node after the swap.
    */
   protected _swap(srcNode: N, destNode: N): N {
-    const {key, val} = destNode;
-    const tempNode = this.createNode(key, val);
+    const {key, value} = destNode;
+    const tempNode = this.createNode(key, value);
 
     if (tempNode) {
       destNode.key = srcNode.key;
-      destNode.val = srcNode.val;
+      destNode.value = srcNode.value;
 
       srcNode.key = tempNode.key;
-      srcNode.val = tempNode.val;
+      srcNode.value = tempNode.value;
     }
 
     return destNode;