data-structure-typed 1.34.7 → 1.34.9

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

@@ -1,17 +1,17 @@
-import type { DijkstraResult, VertexId } from '../../types';
+import type { DijkstraResult, VertexKey } from '../../types';
 import { IAbstractGraph } from '../../interfaces';
 export declare abstract class AbstractVertex<V = any> {
     /**
-     * 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.
      */
-    protected constructor(id: VertexId, val?: V);
-    private _id;
-    get id(): VertexId;
-    set id(v: VertexId);
+    protected constructor(key: VertexKey, val?: V);
+    private _key;
+    get key(): VertexKey;
+    set key(v: VertexKey);
     private _val;
     get val(): V | undefined;
     set val(value: V | undefined);
@@ -48,14 +48,14 @@ export declare abstract class AbstractEdge<V = any> {
 }
 export declare abstract class AbstractGraph<V extends AbstractVertex<any> = AbstractVertex<any>, E extends AbstractEdge<any> = AbstractEdge<any>> implements IAbstractGraph<V, E> {
     private _vertices;
-    get vertices(): Map<VertexId, V>;
+    get vertices(): Map<VertexKey, 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.
-     * @param id
+     * @param key
      * @param val
      */
-    abstract createVertex(id: VertexId, val?: V): V;
+    abstract createVertex(key: VertexKey, val?: V): 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.
@@ -64,77 +64,77 @@ export declare abstract class AbstractGraph<V extends AbstractVertex<any> = Abst
      * @param weight
      * @param val
      */
-    abstract createEdge(srcOrV1: VertexId | string, destOrV2: VertexId | string, weight?: number, val?: E): E;
+    abstract createEdge(srcOrV1: VertexKey | string, destOrV2: VertexKey | string, weight?: number, val?: E): E;
     abstract removeEdge(edge: E): E | null;
-    abstract getEdge(srcOrId: V | VertexId, destOrId: V | VertexId): E | null;
-    abstract degreeOf(vertexOrId: V | VertexId): number;
+    abstract getEdge(srcOrKey: V | VertexKey, destOrKey: V | VertexKey): E | null;
+    abstract degreeOf(vertexOrKey: V | VertexKey): number;
     abstract edgeSet(): E[];
-    abstract edgesOf(vertexOrId: V | VertexId): E[];
-    abstract getNeighbors(vertexOrId: V | VertexId): V[];
+    abstract edgesOf(vertexOrKey: V | VertexKey): E[];
+    abstract getNeighbors(vertexOrKey: V | VertexKey): V[];
     abstract getEndsOfEdge(edge: E): [V, V] | null;
     /**
      * 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: VertexId): V | null;
+    getVertex(vertexKey: VertexKey): V | 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: V | VertexId): boolean;
+    hasVertex(vertexOrKey: V | VertexKey): boolean;
     addVertex(vertex: V): boolean;
-    addVertex(id: VertexId, val?: V['val']): boolean;
+    addVertex(key: VertexKey, val?: V['val']): boolean;
     /**
      * 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: V | VertexId): boolean;
+    removeVertex(vertexOrKey: V | VertexKey): boolean;
     /**
      * 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.
      */
-    removeAllVertices(vertices: V[] | VertexId[]): boolean;
+    removeAllVertices(vertices: V[] | VertexKey[]): boolean;
     /**
      * 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: VertexId | V, v2: VertexId | V): boolean;
+    hasEdge(v1: VertexKey | V, v2: VertexKey | V): boolean;
     addEdge(edge: E): boolean;
-    addEdge(src: V | VertexId, dest: V | VertexId, weight?: number, val?: E['val']): boolean;
+    addEdge(src: V | VertexKey, dest: V | VertexKey, weight?: number, val?: E['val']): boolean;
     /**
      * 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: VertexId | V, destOrId: VertexId | V, weight: number): boolean;
+    setEdgeWeight(srcOrKey: VertexKey | V, destOrKey: VertexKey | V, weight: number): boolean;
     /**
      * 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: V | VertexId, v2: V | VertexId): V[][];
+    getAllPathsBetween(v1: V | VertexKey, v2: V | VertexKey): V[][];
     /**
      * The function calculates the sum of weights along a given path.
      * @param {V[]} path - An array of vertices (V) representing a path in a graph.
@@ -144,8 +144,8 @@ export declare abstract class AbstractGraph<V extends AbstractVertex<any> = Abst
     /**
      * 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
@@ -155,13 +155,13 @@ export declare abstract class AbstractGraph<V extends AbstractVertex<any> = Abst
      * vertices. If `isWeight` is `false` or not provided, it uses a breadth-first search (BFS) algorithm to calculate the
      * minimum number of
      */
-    getMinCostBetween(v1: V | VertexId, v2: V | VertexId, isWeight?: boolean): number | null;
+    getMinCostBetween(v1: V | VertexKey, v2: V | VertexKey, isWeight?: boolean): number | null;
     /**
      * 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
@@ -169,7 +169,7 @@ export declare abstract class AbstractGraph<V extends AbstractVertex<any> = Abst
      * @returns The function `getMinPathBetween` returns an array of vertices (`V[]`) representing the minimum path between
      * two vertices (`v1` and `v2`). If there is no path between the vertices, it returns `null`.
      */
-    getMinPathBetween(v1: V | VertexId, v2: V | VertexId, isWeight?: boolean): V[] | null;
+    getMinPathBetween(v1: V | VertexKey, v2: V | VertexKey, isWeight?: boolean): V[] | null;
     /**
      * Dijkstra algorithm time: O(VE) space: O(V + E)
      * /
@@ -178,9 +178,9 @@ export declare abstract class AbstractGraph<V extends AbstractVertex<any> = Abst
      * 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
@@ -191,7 +191,7 @@ export declare abstract class AbstractGraph<V extends AbstractVertex<any> = Abst
      * shortest paths from the source vertex to all other vertices in the graph. If `genPaths
      * @returns The function `dijkstraWithoutHeap` returns an object of type `DijkstraResult<V>`.
      */
-    dijkstraWithoutHeap(src: V | VertexId, dest?: V | VertexId | null, getMinDist?: boolean, genPaths?: boolean): DijkstraResult<V>;
+    dijkstraWithoutHeap(src: V | VertexKey, dest?: V | VertexKey | null, getMinDist?: boolean, genPaths?: boolean): DijkstraResult<V>;
     /**
      * Dijkstra algorithm time: O(logVE) space: O(V + E)
      *
@@ -205,9 +205,9 @@ export declare abstract class AbstractGraph<V extends AbstractVertex<any> = Abst
      * 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
@@ -218,7 +218,7 @@ export declare abstract class AbstractGraph<V extends AbstractVertex<any> = Abst
      * shortest paths from the source vertex to all other vertices in the graph. If `genPaths
      * @returns The function `dijkstra` returns an object of type `DijkstraResult<V>`.
      */
-    dijkstra(src: V | VertexId, dest?: V | VertexId | null, getMinDist?: boolean, genPaths?: boolean): DijkstraResult<V>;
+    dijkstra(src: V | VertexKey, dest?: V | VertexKey | null, getMinDist?: boolean, genPaths?: boolean): DijkstraResult<V>;
     /**
      * BellmanFord time:O(VE) space:O(V)
      * one to rest pairs
@@ -230,7 +230,7 @@ export declare abstract class AbstractGraph<V extends AbstractVertex<any> = Abst
      * 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
@@ -240,7 +240,7 @@ export declare abstract class AbstractGraph<V extends AbstractVertex<any> = Abst
      * vertex.
      * @returns The function `bellmanFord` returns an object with the following properties:
      */
-    bellmanFord(src: V | VertexId, scanNegativeCycle?: boolean, getMin?: boolean, genPath?: boolean): {
+    bellmanFord(src: V | VertexKey, scanNegativeCycle?: boolean, getMin?: boolean, genPath?: boolean): {
         hasNegativeCycle: boolean | undefined;
         distMap: Map<V, number>;
         preMap: Map<V, V>;
@@ -288,7 +288,7 @@ export declare abstract class AbstractGraph<V extends AbstractVertex<any> = Abst
         predecessor: (V | null)[][];
     };
     /**
-     * Tarjan is an algorithm based on DFS,which is used to solve the connectivity problem of graphs.
+     * Tarjan is an algorithm based on dfs,which is used to solve the connectivity problem of graphs.
      * Tarjan can find cycles in directed or undirected graph
      * Tarjan can find the articulation points and bridges(critical edges) of undirected graphs in linear time,
      * Tarjan solve the bi-connected components of undirected graphs;
@@ -296,7 +296,7 @@ export declare abstract class AbstractGraph<V extends AbstractVertex<any> = Abst
      * /
   
      /**
-     * Tarjan is an algorithm based on DFS,which is used to solve the connectivity problem of graphs.
+     * Tarjan is an algorithm based on dfs,which is used to solve the connectivity problem of graphs.
      * Tarjan can find cycles in directed or undirected graph
      * Tarjan can find the articulation points and bridges(critical edges) of undirected graphs in linear time,
      * Tarjan solve the bi-connected components of undirected graphs;
@@ -326,7 +326,7 @@ export declare abstract class AbstractGraph<V extends AbstractVertex<any> = Abst
     };
     protected abstract _addEdgeOnly(edge: E): boolean;
     protected _addVertexOnly(newVertex: V): boolean;
-    protected _getVertex(vertexOrId: VertexId | V): V | null;
-    protected _getVertexId(vertexOrId: V | VertexId): VertexId;
-    protected _setVertices(value: Map<VertexId, V>): void;
+    protected _getVertex(vertexOrKey: VertexKey | V): V | null;
+    protected _getVertexKey(vertexOrKey: V | VertexKey): VertexKey;
+    protected _setVertices(value: Map<VertexKey, V>): void;
 }