data-structure-typed 1.34.6 → 1.34.8

package/lib/data-structures/graph/abstract-graph.js

@@ -9,21 +9,21 @@ import { arrayRemove, uuidV4 } from '../../utils';
 import { PriorityQueue } from '../priority-queue';
 export class AbstractVertex {
     /**
-     * The function is a protected constructor that takes an id and an optional value as parameters.
-     * @param {VertexId} id - The `id` parameter is of type `VertexId` and represents the identifier of the vertex. It is
+     * The function is a protected constructor that takes an key and an optional value as parameters.
+     * @param {VertexKey} key - The `key` parameter is of type `VertexKey` and represents the identifier of the vertex. It is
      * used to uniquely identify the vertex object.
      * @param {V} [val] - The parameter "val" is an optional parameter of type V. It is used to assign a value to the
      * vertex. If no value is provided, it will be set to undefined.
      */
-    constructor(id, val) {
-        this._id = id;
+    constructor(key, val) {
+        this._key = key;
         this._val = val;
     }
-    get id() {
-        return this._id;
+    get key() {
+        return this._key;
     }
-    set id(v) {
-        this._id = v;
+    set key(v) {
+        this._key = v;
     }
     get val() {
         return this._val;
@@ -84,46 +84,46 @@ export class AbstractGraph {
     }
     /**
      * The function "getVertex" returns the vertex with the specified ID or null if it doesn't exist.
-     * @param {VertexId} vertexId - The `vertexId` parameter is the identifier of the vertex that you want to retrieve from
+     * @param {VertexKey} vertexKey - The `vertexKey` parameter is the identifier of the vertex that you want to retrieve from
      * the `_vertices` map.
-     * @returns The method `getVertex` returns the vertex with the specified `vertexId` if it exists in the `_vertices`
+     * @returns The method `getVertex` returns the vertex with the specified `vertexKey` if it exists in the `_vertices`
      * map. If the vertex does not exist, it returns `null`.
      */
-    getVertex(vertexId) {
-        return this._vertices.get(vertexId) || null;
+    getVertex(vertexKey) {
+        return this._vertices.get(vertexKey) || null;
     }
     /**
      * The function checks if a vertex exists in a graph.
-     * @param {V | VertexId} vertexOrId - The parameter `vertexOrId` can be either a vertex object (`V`) or a vertex ID
-     * (`VertexId`).
+     * @param {V | VertexKey} vertexOrKey - The parameter `vertexOrKey` can be either a vertex object (`V`) or a vertex ID
+     * (`VertexKey`).
      * @returns a boolean value.
      */
-    hasVertex(vertexOrId) {
-        return this._vertices.has(this._getVertexId(vertexOrId));
+    hasVertex(vertexOrKey) {
+        return this._vertices.has(this._getVertexKey(vertexOrKey));
     }
-    addVertex(idOrVertex, val) {
-        if (idOrVertex instanceof AbstractVertex) {
-            return this._addVertexOnly(idOrVertex);
+    addVertex(keyOrVertex, val) {
+        if (keyOrVertex instanceof AbstractVertex) {
+            return this._addVertexOnly(keyOrVertex);
         }
         else {
-            const newVertex = this.createVertex(idOrVertex, val);
+            const newVertex = this.createVertex(keyOrVertex, val);
             return this._addVertexOnly(newVertex);
         }
     }
     /**
      * The `removeVertex` function removes a vertex from a graph by its ID or by the vertex object itself.
-     * @param {V | VertexId} vertexOrId - The parameter `vertexOrId` can be either a vertex object (`V`) or a vertex ID
-     * (`VertexId`).
+     * @param {V | VertexKey} vertexOrKey - The parameter `vertexOrKey` can be either a vertex object (`V`) or a vertex ID
+     * (`VertexKey`).
      * @returns The method is returning a boolean value.
      */
-    removeVertex(vertexOrId) {
-        const vertexId = this._getVertexId(vertexOrId);
-        return this._vertices.delete(vertexId);
+    removeVertex(vertexOrKey) {
+        const vertexKey = this._getVertexKey(vertexOrKey);
+        return this._vertices.delete(vertexKey);
     }
     /**
      * The function removes all vertices from a graph and returns a boolean indicating if any vertices were removed.
-     * @param {V[] | VertexId[]} vertices - The `vertices` parameter can be either an array of vertices (`V[]`) or an array
-     * of vertex IDs (`VertexId[]`).
+     * @param {V[] | VertexKey[]} vertices - The `vertices` parameter can be either an array of vertices (`V[]`) or an array
+     * of vertex IDs (`VertexKey[]`).
      * @returns a boolean value. It returns true if at least one vertex was successfully removed, and false if no vertices
      * were removed.
      */
@@ -136,10 +136,10 @@ export class AbstractGraph {
     }
     /**
      * The function checks if there is an edge between two vertices and returns a boolean value indicating the result.
-     * @param {VertexId | V} v1 - The parameter v1 can be either a VertexId or a V. A VertexId represents the unique
+     * @param {VertexKey | V} v1 - The parameter v1 can be either a VertexKey or a V. A VertexKey represents the unique
      * identifier of a vertex in a graph, while V represents the type of the vertex object itself.
-     * @param {VertexId | V} v2 - The parameter `v2` represents the second vertex in the edge. It can be either a
-     * `VertexId` or a `V` type, which represents the type of the vertex.
+     * @param {VertexKey | V} v2 - The parameter `v2` represents the second vertex in the edge. It can be either a
+     * `VertexKey` or a `V` type, which represents the type of the vertex.
      * @returns A boolean value is being returned.
      */
     hasEdge(v1, v2) {
@@ -155,30 +155,30 @@ export class AbstractGraph {
                 if (!(this.hasVertex(srcOrEdge) && this.hasVertex(dest)))
                     return false;
                 if (srcOrEdge instanceof AbstractVertex)
-                    srcOrEdge = srcOrEdge.id;
+                    srcOrEdge = srcOrEdge.key;
                 if (dest instanceof AbstractVertex)
-                    dest = dest.id;
+                    dest = dest.key;
                 const newEdge = this.createEdge(srcOrEdge, dest, weight, val);
                 return this._addEdgeOnly(newEdge);
             }
             else {
-                throw new Error('dest must be a Vertex or vertex id while srcOrEdge is an Edge');
+                throw new Error('dest must be a Vertex or vertex key while srcOrEdge is an Edge');
             }
         }
     }
     /**
      * The function sets the weight of an edge between two vertices in a graph.
-     * @param {VertexId | V} srcOrId - The `srcOrId` parameter can be either a `VertexId` or a `V` object. It represents
+     * @param {VertexKey | V} srcOrKey - The `srcOrKey` parameter can be either a `VertexKey` or a `V` object. It represents
      * the source vertex of the edge.
-     * @param {VertexId | V} destOrId - The `destOrId` parameter represents the destination vertex of the edge. It can be
-     * either a `VertexId` or a vertex object `V`.
-     * @param {number} weight - The weight parameter represents the weight of the edge between the source vertex (srcOrId)
-     * and the destination vertex (destOrId).
+     * @param {VertexKey | V} destOrKey - The `destOrKey` parameter represents the destination vertex of the edge. It can be
+     * either a `VertexKey` or a vertex object `V`.
+     * @param {number} weight - The weight parameter represents the weight of the edge between the source vertex (srcOrKey)
+     * and the destination vertex (destOrKey).
      * @returns a boolean value. If the edge exists between the source and destination vertices, the function will update
      * the weight of the edge and return true. If the edge does not exist, the function will return false.
      */
-    setEdgeWeight(srcOrId, destOrId, weight) {
-        const edge = this.getEdge(srcOrId, destOrId);
+    setEdgeWeight(srcOrKey, destOrKey, weight) {
+        const edge = this.getEdge(srcOrKey, destOrKey);
         if (edge) {
             edge.weight = weight;
             return true;
@@ -189,9 +189,9 @@ export class AbstractGraph {
     }
     /**
      * The function `getAllPathsBetween` finds all paths between two vertices in a graph using depth-first search.
-     * @param {V | VertexId} v1 - The parameter `v1` represents either a vertex object (`V`) or a vertex ID (`VertexId`).
+     * @param {V | VertexKey} v1 - The parameter `v1` represents either a vertex object (`V`) or a vertex ID (`VertexKey`).
      * It is the starting vertex for finding paths.
-     * @param {V | VertexId} v2 - The parameter `v2` represents either a vertex object (`V`) or a vertex ID (`VertexId`).
+     * @param {V | VertexKey} v2 - The parameter `v2` represents either a vertex object (`V`) or a vertex ID (`VertexKey`).
      * @returns The function `getAllPathsBetween` returns an array of arrays of vertices (`V[][]`).
      */
     getAllPathsBetween(v1, v2) {
@@ -235,8 +235,8 @@ export class AbstractGraph {
     /**
      * The function `getMinCostBetween` calculates the minimum cost between two vertices in a graph, either based on edge
      * weights or using a breadth-first search algorithm.
-     * @param {V | VertexId} v1 - The parameter `v1` represents the starting vertex or its ID.
-     * @param {V | VertexId} v2 - The parameter `v2` represents the destination vertex or its ID. It is the vertex to which
+     * @param {V | VertexKey} v1 - The parameter `v1` represents the starting vertex or its ID.
+     * @param {V | VertexKey} v2 - The parameter `v2` represents the destination vertex or its ID. It is the vertex to which
      * you want to find the minimum cost or weight from the source vertex `v1`.
      * @param {boolean} [isWeight] - isWeight is an optional parameter that indicates whether the graph edges have weights.
      * If isWeight is set to true, the function will calculate the minimum cost between v1 and v2 based on the weights of
@@ -293,9 +293,9 @@ export class AbstractGraph {
     /**
      * The function `getMinPathBetween` returns the minimum path between two vertices in a graph, either based on weight or
      * using a breadth-first search algorithm.
-     * @param {V | VertexId} v1 - The parameter `v1` represents the starting vertex of the path. It can be either a vertex
-     * object (`V`) or a vertex ID (`VertexId`).
-     * @param {V | VertexId} v2 - V | VertexId - The second vertex or vertex ID between which we want to find the minimum
+     * @param {V | VertexKey} v1 - The parameter `v1` represents the starting vertex of the path. It can be either a vertex
+     * object (`V`) or a vertex ID (`VertexKey`).
+     * @param {V | VertexKey} v2 - V | VertexKey - The second vertex or vertex ID between which we want to find the minimum
      * path.
      * @param {boolean} [isWeight] - A boolean flag indicating whether to consider the weight of edges in finding the
      * minimum path. If set to true, the function will use Dijkstra's algorithm to find the minimum weighted path. If set
@@ -357,9 +357,9 @@ export class AbstractGraph {
      * Dijkstra algorithm time: O(VE) space: O(V + E)
      * The function `dijkstraWithoutHeap` implements Dijkstra's algorithm to find the shortest path between two vertices in
      * a graph without using a heap data structure.
-     * @param {V | VertexId} src - The source vertex from which to start the Dijkstra's algorithm. It can be either a
+     * @param {V | VertexKey} src - The source vertex from which to start the Dijkstra's algorithm. It can be either a
      * vertex object or a vertex ID.
-     * @param {V | VertexId | null} [dest] - The `dest` parameter in the `dijkstraWithoutHeap` function is an optional
+     * @param {V | VertexKey | null} [dest] - The `dest` parameter in the `dijkstraWithoutHeap` function is an optional
      * parameter that specifies the destination vertex for the Dijkstra algorithm. It can be either a vertex object or its
      * identifier. If no destination is provided, the value is set to `null`.
      * @param {boolean} [getMinDist] - The `getMinDist` parameter is a boolean flag that determines whether the minimum
@@ -391,9 +391,9 @@ export class AbstractGraph {
             return null;
         }
         for (const vertex of vertices) {
-            const vertexOrId = vertex[1];
-            if (vertexOrId instanceof AbstractVertex)
-                distMap.set(vertexOrId, Infinity);
+            const vertexOrKey = vertex[1];
+            if (vertexOrKey instanceof AbstractVertex)
+                distMap.set(vertexOrKey, Infinity);
         }
         distMap.set(srcVertex, 0);
         preMap.set(srcVertex, null);
@@ -412,10 +412,10 @@ export class AbstractGraph {
         };
         const getPaths = (minV) => {
             for (const vertex of vertices) {
-                const vertexOrId = vertex[1];
-                if (vertexOrId instanceof AbstractVertex) {
-                    const path = [vertexOrId];
-                    let parent = preMap.get(vertexOrId);
+                const vertexOrKey = vertex[1];
+                if (vertexOrKey instanceof AbstractVertex) {
+                    const path = [vertexOrKey];
+                    let parent = preMap.get(vertexOrKey);
                     while (parent) {
                         path.push(parent);
                         parent = preMap.get(parent);
@@ -485,9 +485,9 @@ export class AbstractGraph {
      * Dijkstra's algorithm is used to find the shortest paths from a source node to all other nodes in a graph. Its basic idea is to repeatedly choose the node closest to the source node and update the distances of other nodes using this node as an intermediary. Dijkstra's algorithm requires that the edge weights in the graph are non-negative.
      * The `dijkstra` function implements Dijkstra's algorithm to find the shortest path between a source vertex and an
      * optional destination vertex, and optionally returns the minimum distance, the paths, and other information.
-     * @param {V | VertexId} src - The `src` parameter represents the source vertex from which the Dijkstra algorithm will
+     * @param {V | VertexKey} src - The `src` parameter represents the source vertex from which the Dijkstra algorithm will
      * start. It can be either a vertex object or a vertex ID.
-     * @param {V | VertexId | null} [dest] - The `dest` parameter is the destination vertex or vertex ID. It specifies the
+     * @param {V | VertexKey | null} [dest] - The `dest` parameter is the destination vertex or vertex ID. It specifies the
      * vertex to which the shortest path is calculated from the source vertex. If no destination is provided, the algorithm
      * will calculate the shortest paths to all other vertices from the source vertex.
      * @param {boolean} [getMinDist] - The `getMinDist` parameter is a boolean flag that determines whether the minimum
@@ -519,14 +519,14 @@ export class AbstractGraph {
         if (!srcVertex)
             return null;
         for (const vertex of vertices) {
-            const vertexOrId = vertex[1];
-            if (vertexOrId instanceof AbstractVertex)
-                distMap.set(vertexOrId, Infinity);
+            const vertexOrKey = vertex[1];
+            if (vertexOrKey instanceof AbstractVertex)
+                distMap.set(vertexOrKey, Infinity);
         }
         const heap = new PriorityQueue({
-            comparator: (a, b) => a.id - b.id
+            comparator: (a, b) => a.key - b.key
         });
-        heap.add({ id: 0, val: srcVertex });
+        heap.add({ key: 0, val: srcVertex });
         distMap.set(srcVertex, 0);
         preMap.set(srcVertex, null);
         /**
@@ -536,10 +536,10 @@ export class AbstractGraph {
          */
         const getPaths = (minV) => {
             for (const vertex of vertices) {
-                const vertexOrId = vertex[1];
-                if (vertexOrId instanceof AbstractVertex) {
-                    const path = [vertexOrId];
-                    let parent = preMap.get(vertexOrId);
+                const vertexOrKey = vertex[1];
+                if (vertexOrKey instanceof AbstractVertex) {
+                    const path = [vertexOrKey];
+                    let parent = preMap.get(vertexOrKey);
                     while (parent) {
                         path.push(parent);
                         parent = preMap.get(parent);
@@ -553,7 +553,7 @@ export class AbstractGraph {
         };
         while (heap.size > 0) {
             const curHeapNode = heap.poll();
-            const dist = curHeapNode === null || curHeapNode === void 0 ? void 0 : curHeapNode.id;
+            const dist = curHeapNode === null || curHeapNode === void 0 ? void 0 : curHeapNode.key;
             const cur = curHeapNode === null || curHeapNode === void 0 ? void 0 : curHeapNode.val;
             if (dist !== undefined) {
                 if (cur) {
@@ -575,7 +575,7 @@ export class AbstractGraph {
                                 const distSrcToNeighbor = distMap.get(neighbor);
                                 if (distSrcToNeighbor) {
                                     if (dist + weight < distSrcToNeighbor) {
-                                        heap.add({ id: dist + weight, val: neighbor });
+                                        heap.add({ key: dist + weight, val: neighbor });
                                         preMap.set(neighbor, cur);
                                         distMap.set(neighbor, dist + weight);
                                     }
@@ -613,7 +613,7 @@ export class AbstractGraph {
      * The Bellman-Ford algorithm is also used to find the shortest paths from a source node to all other nodes in a graph. Unlike Dijkstra's algorithm, it can handle edge weights that are negative. Its basic idea involves iterative relaxation of all edges for several rounds to gradually approximate the shortest paths. Due to its ability to handle negative-weight edges, the Bellman-Ford algorithm is more flexible in some scenarios.
      * The `bellmanFord` function implements the Bellman-Ford algorithm to find the shortest path from a source vertex to
      * all other vertices in a graph, and optionally detects negative cycles and generates the minimum path.
-     * @param {V | VertexId} src - The `src` parameter is the source vertex from which the Bellman-Ford algorithm will
+     * @param {V | VertexKey} src - The `src` parameter is the source vertex from which the Bellman-Ford algorithm will
      * start calculating the shortest paths. It can be either a vertex object or a vertex ID.
      * @param {boolean} [scanNegativeCycle] - A boolean flag indicating whether to scan for negative cycles in the graph.
      * @param {boolean} [getMin] - The `getMin` parameter is a boolean flag that determines whether the algorithm should
@@ -679,10 +679,10 @@ export class AbstractGraph {
         }
         if (genPath) {
             for (const vertex of vertices) {
-                const vertexOrId = vertex[1];
-                if (vertexOrId instanceof AbstractVertex) {
-                    const path = [vertexOrId];
-                    let parent = preMap.get(vertexOrId);
+                const vertexOrKey = vertex[1];
+                if (vertexOrKey instanceof AbstractVertex) {
+                    const path = [vertexOrKey];
+                    let parent = preMap.get(vertexOrKey);
                     while (parent !== undefined) {
                         path.push(parent);
                         parent = preMap.get(parent);
@@ -900,17 +900,17 @@ export class AbstractGraph {
     _addVertexOnly(newVertex) {
         if (this.hasVertex(newVertex)) {
             return false;
-            // throw (new Error('Duplicated vertex id is not allowed'));
+            // throw (new Error('Duplicated vertex key is not allowed'));
         }
-        this._vertices.set(newVertex.id, newVertex);
+        this._vertices.set(newVertex.key, newVertex);
         return true;
     }
-    _getVertex(vertexOrId) {
-        const vertexId = this._getVertexId(vertexOrId);
-        return this._vertices.get(vertexId) || null;
+    _getVertex(vertexOrKey) {
+        const vertexKey = this._getVertexKey(vertexOrKey);
+        return this._vertices.get(vertexKey) || null;
     }
-    _getVertexId(vertexOrId) {
-        return vertexOrId instanceof AbstractVertex ? vertexOrId.id : vertexOrId;
+    _getVertexKey(vertexOrKey) {
+        return vertexOrKey instanceof AbstractVertex ? vertexOrKey.key : vertexOrKey;
     }
     _setVertices(value) {
         this._vertices = value;

package/lib/data-structures/graph/directed-graph.d.ts

@@ -1,35 +1,35 @@
 import { AbstractEdge, AbstractGraph, AbstractVertex } from './abstract-graph';
-import type { VertexId } from '../../types';
+import type { VertexKey } from '../../types';
 import { IDirectedGraph } from '../../interfaces';
 export declare class DirectedVertex<V = any> extends AbstractVertex<V> {
     /**
      * The constructor function initializes a vertex with an optional value.
-     * @param {VertexId} id - The `id` parameter is of type `VertexId` and represents the identifier of the vertex. It is
+     * @param {VertexKey} key - The `key` parameter is of type `VertexKey` and represents the identifier of the vertex. It is
      * used to uniquely identify the vertex within a graph or data structure.
      * @param {V} [val] - The "val" parameter is an optional parameter of type V. It is used to initialize the value of the
      * vertex. If no value is provided, the vertex will be initialized with a default value.
      */
-    constructor(id: VertexId, val?: V);
+    constructor(key: VertexKey, val?: V);
 }
 export declare class DirectedEdge<V = any> extends AbstractEdge<V> {
     /**
      * The constructor function initializes the source and destination vertices of an edge, along with an optional weight
      * and value.
-     * @param {VertexId} src - The `src` parameter is the source vertex ID. It represents the starting point of an edge in
+     * @param {VertexKey} src - The `src` parameter is the source vertex ID. It represents the starting point of an edge in
      * a graph.
-     * @param {VertexId} dest - The `dest` parameter represents the destination vertex of an edge. It is of type
-     * `VertexId`, which is likely a unique identifier for a vertex in a graph.
+     * @param {VertexKey} dest - The `dest` parameter represents the destination vertex of an edge. It is of type
+     * `VertexKey`, which is likely a unique identifier for a vertex in a graph.
      * @param {number} [weight] - The weight parameter is an optional number that represents the weight of the edge.
      * @param {V} [val] - The `val` parameter is an optional parameter of type `V`. It represents the value associated with
      * the edge.
      */
-    constructor(src: VertexId, dest: VertexId, weight?: number, val?: V);
+    constructor(src: VertexKey, dest: VertexKey, weight?: number, val?: V);
     private _src;
-    get src(): VertexId;
-    set src(v: VertexId);
+    get src(): VertexKey;
+    set src(v: VertexKey);
     private _dest;
-    get dest(): VertexId;
-    set dest(v: VertexId);
+    get dest(): VertexKey;
+    set dest(v: VertexKey);
 }
 export declare class DirectedGraph<V extends DirectedVertex<any> = DirectedVertex, E extends DirectedEdge<any> = DirectedEdge> extends AbstractGraph<V, E> implements IDirectedGraph<V, E> {
     /**
@@ -46,45 +46,45 @@ export declare class DirectedGraph<V extends DirectedVertex<any> = DirectedVerte
      */
     /**
      * The function creates a new vertex with an optional value and returns it.
-     * @param {VertexId} id - The `id` parameter is the unique identifier for the vertex. It is of type `VertexId`, which
+     * @param {VertexKey} key - The `key` parameter is the unique identifier for the vertex. It is of type `VertexKey`, which
      * could be a number or a string depending on how you want to identify your vertices.
      * @param [val] - The 'val' parameter is an optional value that can be assigned to the vertex. If a value is provided,
      * it will be assigned to the 'val' property of the vertex. If no value is provided, the 'val' property will be
-     * assigned the same value as the 'id' parameter
+     * assigned the same value as the 'key' parameter
      * @returns a new instance of a DirectedVertex object, casted as type V.
      */
-    createVertex(id: VertexId, val?: V['val']): V;
+    createVertex(key: VertexKey, val?: V['val']): V;
     /**
      * In TypeScript, a subclass inherits the interface implementation of its parent class, without needing to implement the same interface again in the subclass. This behavior differs from Java's approach. In Java, if a parent class implements an interface, the subclass needs to explicitly implement the same interface, even if the parent class has already implemented it.
      * This means that using abstract methods in the parent class cannot constrain the grandchild classes. Defining methods within an interface also cannot constrain the descendant classes. When inheriting from this class, developers need to be aware that this method needs to be overridden.
      */
     /**
      * The function creates a directed edge between two vertices with an optional weight and value.
-     * @param {VertexId} src - The source vertex ID of the edge. It represents the starting point of the edge.
-     * @param {VertexId} dest - The `dest` parameter is the identifier of the destination vertex for the edge.
+     * @param {VertexKey} src - The source vertex ID of the edge. It represents the starting point of the edge.
+     * @param {VertexKey} dest - The `dest` parameter is the identifier of the destination vertex for the edge.
      * @param {number} [weight] - The weight parameter is an optional number that represents the weight of the edge. If no
      * weight is provided, it defaults to 1.
      * @param [val] - The 'val' parameter is an optional value that can be assigned to the edge. It can be of any type and
      * is used to store additional information or data associated with the edge.
      * @returns a new instance of a DirectedEdge object, casted as type E.
      */
-    createEdge(src: VertexId, dest: VertexId, weight?: number, val?: E['val']): E;
+    createEdge(src: VertexKey, dest: VertexKey, weight?: number, val?: E['val']): E;
     /**
      * The `getEdge` function retrieves an edge between two vertices based on their source and destination IDs.
-     * @param {V | null | VertexId} srcOrId - The source vertex or its ID. It can be either a vertex object or a vertex ID.
-     * @param {V | null | VertexId} destOrId - The `destOrId` parameter in the `getEdge` function represents the
-     * destination vertex of the edge. It can be either a vertex object (`V`), a vertex ID (`VertexId`), or `null` if the
+     * @param {V | null | VertexKey} srcOrKey - The source vertex or its ID. It can be either a vertex object or a vertex ID.
+     * @param {V | null | VertexKey} destOrKey - The `destOrKey` parameter in the `getEdge` function represents the
+     * destination vertex of the edge. It can be either a vertex object (`V`), a vertex ID (`VertexKey`), or `null` if the
      * destination is not specified.
      * @returns the first edge found between the source and destination vertices, or null if no such edge is found.
      */
-    getEdge(srcOrId: V | null | VertexId, destOrId: V | null | VertexId): E | null;
+    getEdge(srcOrKey: V | null | VertexKey, destOrKey: V | null | VertexKey): E | null;
     /**
      * The function removes an edge between two vertices in a graph and returns the removed edge.
-     * @param {V | VertexId} srcOrId - The source vertex or its ID.
-     * @param {V | VertexId} destOrId - The `destOrId` parameter represents the destination vertex or its ID.
+     * @param {V | VertexKey} srcOrKey - The source vertex or its ID.
+     * @param {V | VertexKey} destOrKey - The `destOrKey` parameter represents the destination vertex or its ID.
      * @returns the removed edge (E) if it exists, or null if either the source or destination vertex does not exist.
      */
-    removeEdgeSrcToDest(srcOrId: V | VertexId, destOrId: V | VertexId): E | null;
+    removeEdgeSrcToDest(srcOrKey: V | VertexKey, destOrKey: V | VertexKey): E | null;
     /**
      * The function removes an edge from a graph and returns the removed edge, or null if the edge was not found.
      * @param {E} edge - The `edge` parameter is an object that represents an edge in a graph. It has two properties: `src`
@@ -94,51 +94,51 @@ export declare class DirectedGraph<V extends DirectedVertex<any> = DirectedVerte
     removeEdge(edge: E): E | null;
     /**
      * The function removes edges between two vertices and returns the removed edges.
-     * @param {VertexId | V} v1 - The parameter `v1` can be either a `VertexId` or a `V`. A `VertexId` represents the
+     * @param {VertexKey | V} v1 - The parameter `v1` can be either a `VertexKey` or a `V`. A `VertexKey` represents the
      * unique identifier of a vertex in a graph, while `V` represents the actual vertex object.
-     * @param {VertexId | V} v2 - The parameter `v2` represents either a `VertexId` or a `V` object. It is used to specify
+     * @param {VertexKey | V} v2 - The parameter `v2` represents either a `VertexKey` or a `V` object. It is used to specify
      * the second vertex in the edge that needs to be removed.
      * @returns an array of removed edges (E[]).
      */
-    removeEdgesBetween(v1: VertexId | V, v2: VertexId | V): E[];
+    removeEdgesBetween(v1: VertexKey | V, v2: VertexKey | V): E[];
     /**
      * The function `incomingEdgesOf` returns an array of incoming edges for a given vertex or vertex ID.
-     * @param {V | VertexId} vertexOrId - The parameter `vertexOrId` can be either a vertex object (`V`) or a vertex ID
-     * (`VertexId`).
+     * @param {V | VertexKey} vertexOrKey - The parameter `vertexOrKey` can be either a vertex object (`V`) or a vertex ID
+     * (`VertexKey`).
      * @returns The method `incomingEdgesOf` returns an array of edges (`E[]`).
      */
-    incomingEdgesOf(vertexOrId: V | VertexId): E[];
+    incomingEdgesOf(vertexOrKey: V | VertexKey): E[];
     /**
      * The function `outgoingEdgesOf` returns an array of outgoing edges from a given vertex or vertex ID.
-     * @param {V | VertexId} vertexOrId - The parameter `vertexOrId` can accept either a vertex object (`V`) or a vertex ID
-     * (`VertexId`).
+     * @param {V | VertexKey} vertexOrKey - The parameter `vertexOrKey` can accept either a vertex object (`V`) or a vertex ID
+     * (`VertexKey`).
      * @returns The method `outgoingEdgesOf` returns an array of edges (`E[]`).
      */
-    outgoingEdgesOf(vertexOrId: V | VertexId): E[];
+    outgoingEdgesOf(vertexOrKey: V | VertexKey): E[];
     /**
      * The function "degreeOf" returns the total degree of a vertex, which is the sum of its out-degree and in-degree.
-     * @param {VertexId | V} vertexOrId - The parameter `vertexOrId` can be either a `VertexId` or a `V`.
+     * @param {VertexKey | V} vertexOrKey - The parameter `vertexOrKey` can be either a `VertexKey` or a `V`.
      * @returns The sum of the out-degree and in-degree of the specified vertex or vertex ID.
      */
-    degreeOf(vertexOrId: VertexId | V): number;
+    degreeOf(vertexOrKey: VertexKey | V): number;
     /**
      * The function "inDegreeOf" returns the number of incoming edges for a given vertex.
-     * @param {VertexId | V} vertexOrId - The parameter `vertexOrId` can be either a `VertexId` or a `V`.
+     * @param {VertexKey | V} vertexOrKey - The parameter `vertexOrKey` can be either a `VertexKey` or a `V`.
      * @returns The number of incoming edges of the specified vertex or vertex ID.
      */
-    inDegreeOf(vertexOrId: VertexId | V): number;
+    inDegreeOf(vertexOrKey: VertexKey | V): number;
     /**
      * The function `outDegreeOf` returns the number of outgoing edges from a given vertex.
-     * @param {VertexId | V} vertexOrId - The parameter `vertexOrId` can be either a `VertexId` or a `V`.
+     * @param {VertexKey | V} vertexOrKey - The parameter `vertexOrKey` can be either a `VertexKey` or a `V`.
      * @returns The number of outgoing edges from the specified vertex or vertex ID.
      */
-    outDegreeOf(vertexOrId: VertexId | V): number;
+    outDegreeOf(vertexOrKey: VertexKey | V): number;
     /**
      * The function "edgesOf" returns an array of both outgoing and incoming edges of a given vertex or vertex ID.
-     * @param {VertexId | V} vertexOrId - The parameter `vertexOrId` can be either a `VertexId` or a `V`.
+     * @param {VertexKey | V} vertexOrKey - The parameter `vertexOrKey` can be either a `VertexKey` or a `V`.
      * @returns The function `edgesOf` returns an array of edges.
      */
-    edgesOf(vertexOrId: VertexId | V): E[];
+    edgesOf(vertexOrKey: VertexKey | V): E[];
     /**
      * The function "getEdgeSrc" returns the source vertex of an edge, or null if the edge does not exist.
      * @param {E} e - The parameter "e" is of type E, which represents an edge in a graph.
@@ -153,20 +153,20 @@ export declare class DirectedGraph<V extends DirectedVertex<any> = DirectedVerte
     getEdgeDest(e: E): V | null;
     /**
      * The function `getDestinations` returns an array of destination vertices connected to a given vertex.
-     * @param {V | VertexId | null} vertex - The `vertex` parameter represents the starting vertex from which we want to
-     * find the destinations. It can be either a `V` object, a `VertexId` value, or `null`.
+     * @param {V | VertexKey | null} vertex - The `vertex` parameter represents the starting vertex from which we want to
+     * find the destinations. It can be either a `V` object, a `VertexKey` value, or `null`.
      * @returns an array of vertices (V[]).
      */
-    getDestinations(vertex: V | VertexId | null): V[];
+    getDestinations(vertex: V | VertexKey | null): V[];
     /**
      * The `topologicalSort` function performs a topological sort on a graph and returns an array of vertices or vertex IDs
      * in the sorted order, or null if the graph contains a cycle.
-     * @param {'vertex' | 'id'} [propertyName] - The `propertyName` parameter is an optional parameter that specifies the
-     * property to use for sorting the vertices. It can have two possible values: 'vertex' or 'id'. If 'vertex' is
-     * specified, the vertices themselves will be used for sorting. If 'id' is specified, the ids of
+     * @param {'vertex' | 'key'} [propertyName] - The `propertyName` parameter is an optional parameter that specifies the
+     * property to use for sorting the vertices. It can have two possible values: 'vertex' or 'key'. If 'vertex' is
+     * specified, the vertices themselves will be used for sorting. If 'key' is specified, the ids of
      * @returns an array of vertices or vertex IDs in topological order. If there is a cycle in the graph, it returns null.
      */
-    topologicalSort(propertyName?: 'vertex' | 'id'): Array<V | VertexId> | null;
+    topologicalSort(propertyName?: 'vertex' | 'key'): Array<V | VertexKey> | null;
     /**
      * The `edgeSet` function returns an array of all the edges in the graph.
      * @returns The `edgeSet()` method returns an array of edges (`E[]`).
@@ -174,11 +174,11 @@ export declare class DirectedGraph<V extends DirectedVertex<any> = DirectedVerte
     edgeSet(): E[];
     /**
      * The function `getNeighbors` returns an array of neighboring vertices of a given vertex or vertex ID in a graph.
-     * @param {V | VertexId} vertexOrId - The parameter `vertexOrId` can be either a vertex object (`V`) or a vertex ID
-     * (`VertexId`).
+     * @param {V | VertexKey} vertexOrKey - The parameter `vertexOrKey` can be either a vertex object (`V`) or a vertex ID
+     * (`VertexKey`).
      * @returns an array of vertices (V[]).
      */
-    getNeighbors(vertexOrId: V | VertexId): V[];
+    getNeighbors(vertexOrKey: V | VertexKey): V[];
     /**
      * The function "getEndsOfEdge" returns the source and destination vertices of an edge if it exists in the graph,
      * otherwise it returns null.