data-structure-typed 1.18.0 → 1.18.6

package/backup/recursive-type/src/data-structures/graph/abstract-graph.ts

@@ -0,0 +1,985 @@
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+import {arrayRemove, uuidV4} from '../../utils';
+import {PriorityQueue} from '../priority-queue';
+import type {DijkstraResult, VertexId} from '../types';
+import {IGraph} from '../interfaces';
+
+export abstract class AbstractVertex<T = number> {
+
+    protected constructor(id: VertexId, val?: T) {
+        this._id = id;
+        this._val = val;
+    }
+
+    private _id: VertexId;
+
+    get id(): VertexId {
+        return this._id;
+    }
+
+    set id(v: VertexId) {
+        this._id = v;
+    }
+
+    private _val: T | undefined;
+
+    get val(): T | undefined {
+        return this._val;
+    }
+
+    set val(value: T | undefined) {
+        this._val = value;
+    }
+
+    // /**
+    //  * 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 val
+    //  */
+    // abstract _createVertex(id: VertexId, val?: T): AbstractVertex<T>;
+}
+
+export abstract class AbstractEdge<T> {
+
+    protected constructor(weight?: number, val?: T) {
+        this._weight = weight !== undefined ? weight : 1;
+        this._val = val;
+        this._hashCode = uuidV4();
+    }
+
+    private _val: T | undefined;
+
+    get val(): T | undefined {
+        return this._val;
+    }
+
+    set val(value: T | undefined) {
+        this._val = value;
+    }
+
+    private _weight: number;
+
+    get weight(): number {
+        return this._weight;
+    }
+
+    set weight(v: number) {
+        this._weight = v;
+    }
+
+    protected _hashCode: string;
+
+    get hashCode(): string {
+        return this._hashCode;
+    }
+
+    // /**
+    //  * 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 srcOrV1
+    //  * @param destOrV2
+    //  * @param weight
+    //  * @param val
+    //  */
+    // abstract _createEdge(srcOrV1: VertexId | string, destOrV2: VertexId | string, weight?: number, val?: E): E;
+
+    protected _setHashCode(v: string) {
+        this._hashCode = v;
+    }
+}
+
+// Connected Component === Largest Connected Sub-Graph
+export abstract class AbstractGraph<V extends AbstractVertex<any>, E extends AbstractEdge<any>> implements IGraph<V, E> {
+    private _vertices: Map<VertexId, V> = new Map<VertexId, V>();
+
+    get vertices(): Map<VertexId, V> {
+        return this._vertices;
+    }
+
+    /**
+     * 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 val
+     */
+    abstract _createVertex(id: VertexId, 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.
+     * @param srcOrV1
+     * @param destOrV2
+     * @param weight
+     * @param val
+     */
+    abstract _createEdge(srcOrV1: VertexId | string, destOrV2: VertexId | string, weight?: number, val?: E): E;
+
+    abstract removeEdgeBetween(srcOrId: V | VertexId, destOrId: V | VertexId): E | null;
+
+    abstract removeEdge(edge: E): E | null;
+
+    _getVertex(vertexOrId: VertexId | V): V | null {
+        const vertexId = this._getVertexId(vertexOrId);
+        return this._vertices.get(vertexId) || null;
+    }
+
+    getVertex(vertexId: VertexId): V | null {
+        return this._vertices.get(vertexId) || null;
+    }
+
+    _getVertexId(vertexOrId: V | VertexId): VertexId {
+        return vertexOrId instanceof AbstractVertex ? vertexOrId.id : vertexOrId;
+    }
+
+    /**
+     * The function checks if a vertex exists in a graph.
+     * @param {V | VertexId} vertexOrId - The parameter `vertexOrId` can accept either a vertex object (`V`) or a vertex ID
+     * (`VertexId`).
+     * @returns The method `hasVertex` returns a boolean value.
+     */
+    hasVertex(vertexOrId: V | VertexId): boolean {
+        return this._vertices.has(this._getVertexId(vertexOrId));
+    }
+
+    abstract getEdge(srcOrId: V | VertexId, destOrId: V | VertexId): E | null;
+
+    createAddVertex(id: VertexId, val?: V['val']): boolean {
+        const newVertex = this._createVertex(id, val);
+        return this.addVertex(newVertex);
+    }
+
+    addVertex(newVertex: V): boolean {
+        if (this.hasVertex(newVertex)) {
+            throw (new Error('Duplicated vertex id is not allowed'));
+        }
+        this._vertices.set(newVertex.id, newVertex);
+        return true;
+    }
+
+    /**
+     * 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`).
+     * @returns The method `removeVertex` returns a boolean value.
+     */
+    removeVertex(vertexOrId: V | VertexId): boolean {
+        const vertexId = this._getVertexId(vertexOrId);
+        return this._vertices.delete(vertexId);
+    }
+
+    /**
+     * 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[]`).
+     * @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 {
+        const removed: boolean[] = [];
+        for (const v of vertices) {
+            removed.push(this.removeVertex(v));
+        }
+        return removed.length > 0;
+    }
+
+    abstract degreeOf(vertexOrId: V | VertexId): number;
+
+    abstract edgeSet(): E[];
+
+    abstract edgesOf(vertexOrId: V | VertexId): E[];
+
+    /**
+     * The function checks if there is an edge between two vertices in a graph.
+     * @param {VertexId | V} v1 - The parameter v1 can be either a VertexId or a V. A VertexId represents the identifier of
+     * a vertex in a graph, while V represents the type of the vertex itself.
+     * @param {VertexId | V} v2 - The parameter `v2` represents the second vertex in an edge. It can be either a `VertexId`
+     * or a `V` type.
+     * @returns The function `hasEdge` returns a boolean value. It returns `true` if there is an edge between the
+     * vertices `v1` and `v2`, and `false` otherwise.
+     */
+    hasEdge(v1: VertexId | V, v2: VertexId | V): boolean {
+        const edge = this.getEdge(v1, v2);
+        return !!edge;
+    }
+
+    createAddEdge(src: V | VertexId, dest: V | VertexId, weight: number, val: E['val']): boolean {
+        if (src instanceof AbstractVertex) src = src.id;
+        if (dest instanceof AbstractVertex) dest = dest.id;
+        const newEdge = this._createEdge(src, dest, weight, val);
+        return this.addEdge(newEdge);
+    }
+
+    abstract addEdge(edge: E): 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
+     * 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).
+     * @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 {
+        const edge = this.getEdge(srcOrId, destOrId);
+        if (edge) {
+            edge.weight = weight;
+            return true;
+        } else {
+            return false;
+        }
+    }
+
+    abstract getNeighbors(vertexOrId: V | VertexId): V[];
+
+    /**
+     * 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`).
+     * It is the starting vertex for finding paths.
+     * @param {V | VertexId} v2 - The parameter `v2` represents the destination vertex or its ID. It is the vertex that we
+     * want to find paths to from the starting vertex `v1`.
+     * @returns an array of arrays of vertices (V[][]). Each inner array represents a path between the given vertices (v1
+     * and v2).
+     */
+    getAllPathsBetween(v1: V | VertexId, v2: V | VertexId): V[][] {
+        const paths: V[][] = [];
+        const vertex1 = this._getVertex(v1);
+        const vertex2 = this._getVertex(v2);
+        if (!(vertex1 && vertex2)) {
+            return [];
+        }
+
+        const dfs = (cur: V, dest: V, visiting: Map<V, boolean>, path: V[]) => {
+            visiting.set(cur, true);
+
+            if (cur === dest) {
+                paths.push([vertex1, ...path]);
+            }
+
+            const neighbors = this.getNeighbors(cur);
+            for (const neighbor of neighbors) {
+                if (!visiting.get(neighbor)) {
+                    path.push(neighbor);
+                    dfs(neighbor, dest, visiting, path);
+                    arrayRemove(path, (vertex: V) => vertex === neighbor);
+                }
+            }
+
+            visiting.set(cur, false);
+        };
+
+        dfs(vertex1, vertex2, new Map<V, boolean>(), []);
+        return paths;
+    }
+
+    /**
+     * 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.
+     * @returns The function `getPathSumWeight` returns the sum of the weights of the edges in the given path.
+     */
+    getPathSumWeight(path: V[]): number {
+        let sum = 0;
+        for (let i = 0; i < path.length; i++) {
+            sum += this.getEdge(path[i], path[i + 1])?.weight || 0;
+        }
+        return sum;
+    }
+
+    /**
+     * 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 vertex ID of the graph.
+     * @param {V | VertexId} v2 - The parameter `v2` represents the second vertex in the graph. It can be either a vertex
+     * object or a vertex ID.
+     * @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
+     * the edges. If isWeight is set to false or not provided, the function will calculate the
+     * @returns The function `getMinCostBetween` returns a number representing the minimum cost between two vertices (`v1`
+     * and `v2`) in a graph. If the `isWeight` parameter is `true`, it calculates the minimum weight between the vertices.
+     * If `isWeight` is `false` or not provided, it calculates the minimum number of edges between the vertices. If the
+     * vertices are not
+     */
+    getMinCostBetween(v1: V | VertexId, v2: V | VertexId, isWeight?: boolean): number | null {
+        if (isWeight === undefined) isWeight = false;
+
+        if (isWeight) {
+            const allPaths = this.getAllPathsBetween(v1, v2);
+            let min = Infinity;
+            for (const path of allPaths) {
+                min = Math.min(this.getPathSumWeight(path), min);
+            }
+            return min;
+        } else {
+            // BFS
+            const vertex2 = this._getVertex(v2);
+            const vertex1 = this._getVertex(v1);
+            if (!(vertex1 && vertex2)) {
+                return null;
+            }
+
+            const visited: Map<V, boolean> = new Map();
+            const queue: V[] = [vertex1];
+            visited.set(vertex1, true);
+            let cost = 0;
+            while (queue.length > 0) {
+                for (let i = 0; i < queue.length; i++) {
+                    const cur = queue.shift();
+                    if (cur === vertex2) {
+                        return cost;
+                    }
+                    // TODO consider optimizing to AbstractGraph
+                    if (cur !== undefined) {
+                        const neighbors = this.getNeighbors(cur);
+                        for (const neighbor of neighbors) {
+                            if (!visited.has(neighbor)) {
+                                visited.set(neighbor, true);
+                                queue.push(neighbor);
+                            }
+                        }
+                    }
+                }
+                cost++;
+            }
+            return 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 or its ID.
+     * @param {V | VertexId} v2 - The parameter `v2` represents the destination vertex or its ID. It is the vertex that we
+     * want to find the minimum path to from the source vertex `v1`.
+     * @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
+     * to false, the function will use breadth-first search (BFS) to find the minimum path. If
+     * @returns The function `getMinPathBetween` returns an array of vertices (`V[]`) representing the minimum path between
+     * two vertices (`v1` and `v2`). If no path is found, it returns `null`.
+     */
+    getMinPathBetween(v1: V | VertexId, v2: V | VertexId, isWeight?: boolean): V[] | null {
+        if (isWeight === undefined) isWeight = false;
+
+        if (isWeight) {
+            const allPaths = this.getAllPathsBetween(v1, v2);
+            let min = Infinity;
+            let minIndex = -1;
+            let index = 0;
+            for (const path of allPaths) {
+                const pathSumWeight = this.getPathSumWeight(path);
+                if (pathSumWeight < min) {
+                    min = pathSumWeight;
+                    minIndex = index;
+                }
+                index++;
+            }
+            return allPaths[minIndex] || null;
+        } else {
+            // BFS
+            let minPath: V[] = [];
+            const vertex1 = this._getVertex(v1);
+            const vertex2 = this._getVertex(v2);
+            if (!(vertex1 && vertex2)) {
+                return [];
+            }
+
+            const dfs = (cur: V, dest: V, visiting: Map<V, boolean>, path: V[]) => {
+                visiting.set(cur, true);
+
+                if (cur === dest) {
+                    minPath = [vertex1, ...path];
+                    return;
+                }
+
+                const neighbors = this.getNeighbors(cur);
+                for (const neighbor of neighbors) {
+                    if (!visiting.get(neighbor)) {
+                        path.push(neighbor);
+                        dfs(neighbor, dest, visiting, path);
+                        arrayRemove(path, (vertex: V) => vertex === neighbor);
+                    }
+                }
+
+                visiting.set(cur, false);
+            };
+
+            dfs(vertex1, vertex2, new Map<V, boolean>(), []);
+            return minPath;
+        }
+    }
+
+    /**
+     * 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
+     * vertex object or a vertex ID.
+     * @param {V | VertexId | 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
+     * distance from the source vertex to the destination vertex should be calculated and returned in the result. If
+     * `getMinDist` is set to `true`, the `minDist` property in the result will contain the minimum distance
+     * @param {boolean} [genPaths] - The `genPaths` parameter is a boolean flag that determines whether or not to generate
+     * paths in the Dijkstra algorithm. If `genPaths` is set to `true`, the algorithm will calculate and return the
+     * 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> {
+        if (getMinDist === undefined) getMinDist = false;
+        if (genPaths === undefined) genPaths = false;
+
+        if (dest === undefined) dest = null;
+        let minDist = Infinity;
+        let minDest: V | null = null;
+        let minPath: V[] = [];
+        const paths: V[][] = [];
+
+        const vertices = this._vertices;
+        const distMap: Map<V, number> = new Map();
+        const seen: Set<V> = new Set();
+        const preMap: Map<V, V | null> = new Map(); // predecessor
+        const srcVertex = this._getVertex(src);
+
+        const destVertex = dest ? this._getVertex(dest) : null;
+
+        if (!srcVertex) {
+            return null;
+        }
+
+        for (const vertex of vertices) {
+            const vertexOrId = vertex[1];
+            if (vertexOrId instanceof AbstractVertex) distMap.set(vertexOrId, Infinity);
+        }
+        distMap.set(srcVertex, 0);
+        preMap.set(srcVertex, null);
+
+        const getMinOfNoSeen = () => {
+            let min = Infinity;
+            let minV: V | null = null;
+            for (const [key, val] of distMap) {
+                if (!seen.has(key)) {
+                    if (val < min) {
+                        min = val;
+                        minV = key;
+                    }
+                }
+            }
+            return minV;
+        };
+
+        const getPaths = (minV: V | null) => {
+            for (const vertex of vertices) {
+                const vertexOrId = vertex[1];
+
+                if (vertexOrId instanceof AbstractVertex) {
+                    const path: V[] = [vertexOrId];
+                    let parent = preMap.get(vertexOrId);
+                    while (parent) {
+                        path.push(parent);
+                        parent = preMap.get(parent);
+                    }
+                    const reversed = path.reverse();
+                    if (vertex[1] === minV) minPath = reversed;
+                    paths.push(reversed);
+                }
+            }
+        };
+
+        for (let i = 1; i < vertices.size; i++) {
+            const cur = getMinOfNoSeen();
+            if (cur) {
+                seen.add(cur);
+                if (destVertex && destVertex === cur) {
+                    if (getMinDist) {
+                        minDist = distMap.get(destVertex) || Infinity;
+                    }
+                    if (genPaths) {
+                        getPaths(destVertex);
+                    }
+                    return {distMap, preMap, seen, paths, minDist, minPath};
+                }
+                const neighbors = this.getNeighbors(cur);
+                for (const neighbor of neighbors) {
+                    if (!seen.has(neighbor)) {
+                        const edge = this.getEdge(cur, neighbor);
+                        if (edge) {
+                            const curFromMap = distMap.get(cur);
+                            const neighborFromMap = distMap.get(neighbor);
+                            // TODO after no-non-null-assertion not ensure the logic
+                            if (curFromMap !== undefined && neighborFromMap !== undefined) {
+                                if (edge.weight + curFromMap < neighborFromMap) {
+                                    distMap.set(neighbor, edge.weight + curFromMap);
+                                    preMap.set(neighbor, cur);
+                                }
+                            }
+
+                        }
+                    }
+                }
+            }
+        }
+
+        getMinDist && distMap.forEach((d, v) => {
+            if (v !== srcVertex) {
+                if (d < minDist) {
+                    minDist = d;
+                    if (genPaths) minDest = v;
+                }
+            }
+        });
+
+        genPaths && getPaths(minDest);
+
+        return {distMap, preMap, seen, paths, minDist, minPath};
+    }
+
+    /**
+     * Dijkstra algorithm time: O(logVE) space: O(V + E)
+     * 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
+     * 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
+     * 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
+     * distance from the source vertex to the destination vertex should be calculated and returned in the result. If
+     * `getMinDist` is set to `true`, the `minDist` property in the result will contain the minimum distance
+     * @param {boolean} [genPaths] - The `genPaths` parameter is a boolean flag that determines whether or not to generate
+     * paths in the Dijkstra algorithm. If `genPaths` is set to `true`, the algorithm will calculate and return the
+     * 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> {
+        if (getMinDist === undefined) getMinDist = false;
+        if (genPaths === undefined) genPaths = false;
+
+        if (dest === undefined) dest = null;
+        let minDist = Infinity;
+        let minDest: V | null = null;
+        let minPath: V[] = [];
+        const paths: V[][] = [];
+        const vertices = this._vertices;
+        const distMap: Map<V, number> = new Map();
+        const seen: Set<V> = new Set();
+        const preMap: Map<V, V | null> = new Map(); // predecessor
+
+        const srcVertex = this._getVertex(src);
+        const destVertex = dest ? this._getVertex(dest) : null;
+
+        if (!srcVertex) {
+            return null;
+        }
+
+        for (const vertex of vertices) {
+            const vertexOrId = vertex[1];
+            if (vertexOrId instanceof AbstractVertex) distMap.set(vertexOrId, Infinity);
+        }
+
+        const heap = new PriorityQueue<{ id: number, val: V }>({comparator: (a, b) => a.id - b.id});
+        heap.add({id: 0, val: srcVertex});
+
+        distMap.set(srcVertex, 0);
+        preMap.set(srcVertex, null);
+
+        const getPaths = (minV: V | null) => {
+            for (const vertex of vertices) {
+                const vertexOrId = vertex[1];
+                if (vertexOrId instanceof AbstractVertex) {
+                    const path: V[] = [vertexOrId];
+                    let parent = preMap.get(vertexOrId);
+                    while (parent) {
+                        path.push(parent);
+                        parent = preMap.get(parent);
+                    }
+                    const reversed = path.reverse();
+                    if (vertex[1] === minV) minPath = reversed;
+                    paths.push(reversed);
+                }
+
+            }
+        };
+
+        while (heap.size > 0) {
+            const curHeapNode = heap.poll();
+            const dist = curHeapNode?.id;
+            const cur = curHeapNode?.val;
+            if (dist !== undefined) {
+                if (cur) {
+                    seen.add(cur);
+                    if (destVertex && destVertex === cur) {
+                        if (getMinDist) {
+                            minDist = distMap.get(destVertex) || Infinity;
+                        }
+                        if (genPaths) {
+                            getPaths(destVertex);
+                        }
+                        return {distMap, preMap, seen, paths, minDist, minPath};
+                    }
+                    const neighbors = this.getNeighbors(cur);
+                    for (const neighbor of neighbors) {
+                        if (!seen.has(neighbor)) {
+                            const weight = this.getEdge(cur, neighbor)?.weight;
+                            if (typeof weight === 'number') {
+                                const distSrcToNeighbor = distMap.get(neighbor);
+                                if (distSrcToNeighbor) {
+                                    if (dist + weight < distSrcToNeighbor) {
+                                        heap.add({id: dist + weight, val: neighbor});
+                                        preMap.set(neighbor, cur);
+                                        distMap.set(neighbor, dist + weight);
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        }
+
+
+        if (getMinDist) {
+            distMap.forEach((d, v) => {
+                if (v !== srcVertex) {
+                    if (d < minDist) {
+                        minDist = d;
+                        if (genPaths) minDest = v;
+                    }
+                }
+            });
+        }
+
+
+        if (genPaths) {
+            getPaths(minDest);
+        }
+
+
+        return {distMap, preMap, seen, paths, minDist, minPath};
+    }
+
+    /**
+     * Dijkstra's algorithm only solves the single-source shortest path problem, while the Bellman-Ford algorithm and Floyd-Warshall algorithm can address shortest paths between all pairs of nodes.
+     * Dijkstra's algorithm is suitable for graphs with non-negative edge weights, whereas the Bellman-Ford algorithm and Floyd-Warshall algorithm can handle negative-weight edges.
+     * The time complexity of Dijkstra's algorithm and the Bellman-Ford algorithm depends on the size of the graph, while the time complexity of the Floyd-Warshall algorithm is O(V^3), where V is the number of nodes. For dense graphs, Floyd-Warshall might become slower.
+     */
+
+    /**
+     * Dijkstra algorithm time: O(logVE) space: O(V + E)
+     * 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.
+     */
+
+    abstract getEndsOfEdge(edge: E): [V, V] | null;
+
+    /**
+     * BellmanFord time:O(VE) space:O(V)
+     * one to rest pairs
+     * 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
+     * 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
+     * calculate the minimum distance from the source vertex to all other vertices in the graph. If `getMin` is set to
+     * `true`, the algorithm will find the minimum distance and update the `min` variable with the minimum
+     * @param {boolean} [genPath] - A boolean flag indicating whether to generate paths for all vertices from the source
+     * vertex.
+     * @returns The function `bellmanFord` returns an object with the following properties:
+     */
+    bellmanFord(src: V | VertexId, scanNegativeCycle?: boolean, getMin?: boolean, genPath?: boolean) {
+        if (getMin === undefined) getMin = false;
+        if (genPath === undefined) genPath = false;
+
+        const srcVertex = this._getVertex(src);
+        const paths: V[][] = [];
+        const distMap: Map<V, number> = new Map();
+        const preMap: Map<V, V> = new Map(); // predecessor
+        let min = Infinity;
+        let minPath: V[] = [];
+        // TODO
+        let hasNegativeCycle: boolean | undefined;
+        if (scanNegativeCycle) hasNegativeCycle = false;
+        if (!srcVertex) return {hasNegativeCycle, distMap, preMap, paths, min, minPath};
+
+        const vertices = this._vertices;
+        const numOfVertices = vertices.size;
+        const edges = this.edgeSet();
+        const numOfEdges = edges.length;
+
+        this._vertices.forEach(vertex => {
+            distMap.set(vertex, Infinity);
+        });
+
+        distMap.set(srcVertex, 0);
+
+        for (let i = 1; i < numOfVertices; ++i) {
+            for (let j = 0; j < numOfEdges; ++j) {
+                const ends = this.getEndsOfEdge(edges[j]);
+                if (ends) {
+                    const [s, d] = ends;
+                    const weight = edges[j].weight;
+                    const sWeight = distMap.get(s);
+                    const dWeight = distMap.get(d);
+                    if (sWeight !== undefined && dWeight !== undefined) {
+                        if (distMap.get(s) !== Infinity && sWeight + weight < dWeight) {
+                            distMap.set(d, sWeight + weight);
+                            genPath && preMap.set(d, s);
+                        }
+                    }
+                }
+            }
+        }
+
+        let minDest: V | null = null;
+        if (getMin) {
+            distMap.forEach((d, v) => {
+                if (v !== srcVertex) {
+                    if (d < min) {
+                        min = d;
+                        if (genPath) minDest = v;
+                    }
+                }
+            });
+        }
+
+        if (genPath) {
+            for (const vertex of vertices) {
+                const vertexOrId = vertex[1];
+                if (vertexOrId instanceof AbstractVertex) {
+                    const path: V[] = [vertexOrId];
+                    let parent = preMap.get(vertexOrId);
+                    while (parent !== undefined) {
+                        path.push(parent);
+                        parent = preMap.get(parent);
+                    }
+                    const reversed = path.reverse();
+                    if (vertex[1] === minDest) minPath = reversed;
+                    paths.push(reversed);
+                }
+            }
+        }
+
+        for (let j = 0; j < numOfEdges; ++j) {
+            const ends = this.getEndsOfEdge(edges[j]);
+            if (ends) {
+                const [s] = ends;
+                const weight = edges[j].weight;
+                const sWeight = distMap.get(s);
+                if (sWeight) {
+                    if (sWeight !== Infinity && sWeight + weight < sWeight) hasNegativeCycle = true;
+                }
+            }
+        }
+
+        return {hasNegativeCycle, distMap, preMap, paths, min, minPath};
+    }
+
+    /**
+     * BellmanFord time:O(VE) space:O(V)
+     * one to rest pairs
+     * 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
+     */
+
+    /**
+     * Floyd algorithm time: O(V^3) space: O(V^2), not support graph with negative weight cycle
+     * all pairs
+     * The Floyd-Warshall algorithm is used to find the shortest paths between all pairs of nodes in a graph. It employs dynamic programming to compute the shortest paths from any node to any other node. The Floyd-Warshall algorithm's advantage lies in its ability to handle graphs with negative-weight edges, and it can simultaneously compute shortest paths between any two nodes.
+     * The function implements the Floyd-Warshall algorithm to find the shortest path between all pairs of vertices in a
+     * graph.
+     * @returns The function `floyd()` returns an object with two properties: `costs` and `predecessor`. The `costs`
+     * property is a 2D array of numbers representing the shortest path costs between vertices in a graph. The
+     * `predecessor` property is a 2D array of vertices (or `null`) representing the predecessor vertices in the shortest
+     * path between vertices in the
+     */
+    floyd(): { costs: number[][], predecessor: (V | null)[][] } {
+        const idAndVertices = [...this._vertices];
+        const n = idAndVertices.length;
+
+        const costs: number[][] = [];
+        const predecessor: (V | null)[][] = [];
+        // successors
+
+        for (let i = 0; i < n; i++) {
+            costs[i] = [];
+            predecessor[i] = [];
+            for (let j = 0; j < n; j++) {
+                predecessor[i][j] = null;
+            }
+        }
+
+        for (let i = 0; i < n; i++) {
+            for (let j = 0; j < n; j++) {
+                costs[i][j] = this.getEdge(idAndVertices[i][1], idAndVertices[j][1])?.weight || Infinity;
+            }
+        }
+
+        for (let k = 0; k < n; k++) {
+            for (let i = 0; i < n; i++) {
+                for (let j = 0; j < n; j++) {
+                    if (costs[i][j] > costs[i][k] + costs[k][j]) {
+                        costs[i][j] = costs[i][k] + costs[k][j];
+                        predecessor[i][j] = idAndVertices[k][1];
+                    }
+                }
+            }
+        }
+        return {costs, predecessor};
+
+    }
+
+    /**
+     * Floyd algorithm time: O(V^3) space: O(V^2), not support graph with negative weight cycle
+     * all pairs
+     * The Floyd-Warshall algorithm is used to find the shortest paths between all pairs of nodes in a graph. It employs dynamic programming to compute the shortest paths from any node to any other node. The Floyd-Warshall algorithm's advantage lies in its ability to handle graphs with negative-weight edges, and it can simultaneously compute shortest paths between any two nodes.
+     */
+
+    /**
+     * 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;
+     * Tarjan can find the SSC(strongly connected components), articulation points, and bridges of directed graphs.
+     * The `tarjan` function is used to perform various graph analysis tasks such as finding articulation points, bridges,
+     * strongly connected components (SCCs), and cycles in a graph.
+     * @param {boolean} [needArticulationPoints] - A boolean value indicating whether or not to calculate and return the
+     * articulation points in the graph. Articulation points are the vertices in a graph whose removal would increase the
+     * number of connected components in the graph.
+     * @param {boolean} [needBridges] - A boolean flag indicating whether the algorithm should find and return the bridges
+     * (edges whose removal would increase the number of connected components in the graph).
+     * @param {boolean} [needSCCs] - A boolean value indicating whether the Strongly Connected Components (SCCs) of the
+     * graph are needed. If set to true, the function will calculate and return the SCCs of the graph. If set to false, the
+     * SCCs will not be calculated or returned.
+     * @param {boolean} [needCycles] - A boolean flag indicating whether the algorithm should find cycles in the graph. If
+     * set to true, the algorithm will return a map of cycles, where the keys are the low values of the SCCs and the values
+     * are arrays of vertices that form cycles within the SCCs.
+     * @returns The function `tarjan` returns an object with the following properties:
+     */
+    tarjan(needArticulationPoints?: boolean, needBridges?: boolean, needSCCs?: boolean, needCycles?: boolean) {
+        // !! in undirected graph we will not let child visit parent when DFS
+        // !! articulation point(in DFS search tree not in graph): (cur !== root && cur.has(child)) && (low(child) >= dfn(cur)) || (cur === root && cur.children() >= 2)
+        // !! bridge: low(child) > dfn(cur)
+
+        const defaultConfig = false;
+        if (needArticulationPoints === undefined) needArticulationPoints = defaultConfig;
+        if (needBridges === undefined) needBridges = defaultConfig;
+        if (needSCCs === undefined) needSCCs = defaultConfig;
+        if (needCycles === undefined) needCycles = defaultConfig;
+
+        const dfnMap: Map<V, number> = new Map();
+        const lowMap: Map<V, number> = new Map();
+        const vertices = this._vertices;
+        vertices.forEach(v => {
+            dfnMap.set(v, -1);
+            lowMap.set(v, Infinity);
+        });
+
+        const [root] = vertices.values();
+
+        const articulationPoints: V[] = [];
+        const bridges: E[] = [];
+        let dfn = 0;
+        const dfs = (cur: V, parent: V | null) => {
+            dfn++;
+            dfnMap.set(cur, dfn);
+            lowMap.set(cur, dfn);
+
+            const neighbors = this.getNeighbors(cur);
+            let childCount = 0; // child in DFS tree not child in graph
+            for (const neighbor of neighbors) {
+                if (neighbor !== parent) {
+                    if (dfnMap.get(neighbor) === -1) {
+                        childCount++;
+                        dfs(neighbor, cur);
+                    }
+                    const childLow = lowMap.get(neighbor);
+                    const curLow = lowMap.get(cur);
+                    // TODO after no-non-null-assertion not ensure the logic
+                    if (curLow !== undefined && childLow !== undefined) {
+                        lowMap.set(cur, Math.min(curLow, childLow));
+                    }
+                    const curFromMap = dfnMap.get(cur);
+                    if (childLow !== undefined && curFromMap !== undefined) {
+                        if (needArticulationPoints) {
+                            if ((cur === root && childCount >= 2) || ((cur !== root) && (childLow >= curFromMap))) {
+                                // todo not ensure the logic if (cur === root && childCount >= 2 || ((cur !== root) && (childLow >= curFromMap))) {
+                                articulationPoints.push(cur);
+                            }
+                        }
+
+                        if (needBridges) {
+                            if (childLow > curFromMap) {
+                                const edgeCurToNeighbor = this.getEdge(cur, neighbor);
+                                if (edgeCurToNeighbor) {
+                                    bridges.push(edgeCurToNeighbor);
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+
+        };
+
+        dfs(root, null);
+
+        let SCCs: Map<number, V[]> = new Map();
+
+        const getSCCs = () => {
+            const SCCs: Map<number, V[]> = new Map();
+            lowMap.forEach((low, vertex) => {
+                if (!SCCs.has(low)) {
+                    SCCs.set(low, [vertex]);
+                } else {
+                    SCCs.get(low)?.push(vertex);
+                }
+            });
+            return SCCs;
+        };
+
+        if (needSCCs) {
+            SCCs = getSCCs();
+        }
+
+        const cycles: Map<number, V[]> = new Map();
+        if (needCycles) {
+            let SCCs: Map<number, V[]> = new Map();
+            if (SCCs.size < 1) {
+                SCCs = getSCCs();
+            }
+
+            SCCs.forEach((SCC, low) => {
+                if (SCC.length > 1) {
+                    cycles.set(low, SCC);
+                }
+            });
+        }
+
+        return {dfnMap, lowMap, bridges, articulationPoints, SCCs, cycles};
+    }
+
+
+    /**--- start find cycles --- */
+
+    protected _setVertices(value: Map<VertexId, V>) {
+        this._vertices = value;
+    }
+
+
+    // unionFind() {}
+
+    /**--- end find cycles --- */
+
+
+    // Minimum Spanning Tree
+}