data-structure-typed 1.18.0 → 1.18.5

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

@@ -0,0 +1,478 @@
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+import {arrayRemove} from '../../utils';
+import {AbstractEdge, AbstractGraph, AbstractVertex} from './abstract-graph';
+import type {TopologicalStatus, VertexId} from '../types';
+import {IDirectedGraph} from '../interfaces';
+
+export class DirectedVertex<T = number> extends AbstractVertex<T> {
+    /**
+     * The constructor function initializes a vertex with an optional value.
+     * @param {VertexId} id - The `id` parameter is the identifier for the vertex. It is of type `VertexId`, which is
+     * typically a unique identifier for each vertex in a graph.
+     * @param {T} [val] - The "val" parameter is an optional parameter of type T. It is used to specify the value
+     * associated with the vertex.
+     */
+    constructor(id: VertexId, val?: T) {
+        super(id, val);
+    }
+
+    // _createVertex(id: VertexId, val?: T): DirectedVertex<T> {
+    //     return new DirectedVertex<T>(id, val);
+    // }
+}
+
+export class DirectedEdge<T = number> extends AbstractEdge<T> {
+
+    /**
+     * 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
+     * a graph.
+     * @param {VertexId} dest - The `dest` parameter is the identifier of the destination vertex for an edge.
+     * @param {number} [weight] - The `weight` parameter is an optional number that represents the weight of the edge. It
+     * is used to assign a numerical value to the edge, which can be used in algorithms such as shortest path algorithms.
+     * If the weight is not provided, it will default to `undefined`.
+     * @param {T} [val] - The "val" parameter is an optional parameter of type T. It represents the value associated with
+     * the edge.
+     */
+    constructor(src: VertexId, dest: VertexId, weight?: number, val?: T) {
+        super(weight, val);
+        this._src = src;
+        this._dest = dest;
+    }
+
+    private _src: VertexId;
+
+    get src(): VertexId {
+        return this._src;
+    }
+
+    set src(v: VertexId) {
+        this._src = v;
+    }
+
+    private _dest: VertexId;
+
+    get dest(): VertexId {
+        return this._dest;
+    }
+
+    set dest(v: VertexId) {
+        this._dest = v;
+    }
+
+    // _createEdge(src: VertexId, dest: VertexId, weight?: number, val?: T): DirectedEdge<T> {
+    //     if (weight === undefined || weight === null) weight = 1;
+    //     return new DirectedEdge(src, dest, weight, val);
+    // }
+}
+
+// Strongly connected, One direction connected, Weakly connected
+export class DirectedGraph<V extends DirectedVertex<any>, E extends DirectedEdge<any>> extends AbstractGraph<V, E> implements IDirectedGraph<V, E> {
+    private readonly _vertexConstructor: new (id: VertexId, val?: V['val']) => V;
+    private readonly _edgeConstructor: new (src: VertexId, dest: VertexId, weight?: number, val?: E['val']) => E;
+
+    constructor(vertexConstructor: new (id: VertexId, val?: V['val']) => V, edgeConstructor: new (src: VertexId, dest: VertexId, weight?: number, val?: E['val']) => E) {
+        super();
+        this._vertexConstructor = vertexConstructor;
+        this._edgeConstructor = edgeConstructor;
+    }
+
+    private _outEdgeMap: Map<V, E[]> = new Map<V, E[]>();
+
+    get outEdgeMap(): Map<V, E[]> {
+        return this._outEdgeMap;
+    }
+
+    private _inEdgeMap: Map<V, E[]> = new Map<V, E[]>();
+
+    get inEdgeMap(): Map<V, E[]> {
+        return this._inEdgeMap;
+    }
+
+    /**
+     * 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
+     */
+    _createVertex(id: VertexId, val?: V['val']): V {
+        return new this._vertexConstructor(id, val);
+    }
+
+    /**
+     * 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 src
+     * @param dest
+     * @param weight
+     * @param val
+     */
+    _createEdge(src: VertexId, dest: VertexId, weight?: number, val?: E['val']): E {
+        if (weight === undefined || weight === null) weight = 1;
+        return new this._edgeConstructor(src, dest, weight, val);
+    }
+
+    /**
+     * The function `getEdge` returns the directed edge between two vertices, given their source and destination.
+     * @param {V | null | VertexId} srcOrId - The source vertex or its ID. It can be either a
+     * DirectedVertex object or a VertexId.
+     * @param {V | null | VertexId} destOrId - The `destOrId` parameter is the destination vertex or its
+     * ID. It can be either a `DirectedVertex` object or a `VertexId` value.
+     * @returns a E object or null.
+     */
+    getEdge(srcOrId: V | null | VertexId, destOrId: V | null | VertexId): E | null {
+        let edges: E[] = [];
+
+        if (srcOrId !== null && destOrId !== null) {
+            const src: V | null = this._getVertex(srcOrId);
+            const dest: V | null = this._getVertex(destOrId);
+
+            if (src && dest) {
+                const srcOutEdges = this._outEdgeMap.get(src);
+                if (srcOutEdges) {
+                    edges = srcOutEdges.filter(edge => edge.dest === dest.id);
+                }
+            }
+        }
+
+        return edges[0] || null;
+    }
+
+    /**
+     * The `addEdge` function adds a directed edge to a graph if the source and destination vertices exist.
+     * @param edge - The parameter `edge` is of type `E`, which represents a directed edge in a graph. It
+     * contains two properties:
+     * @returns The method `addEdge` returns a boolean value. It returns `true` if the edge was successfully added to the
+     * graph, and `false` if either the source or destination vertex of the edge is not present in the graph.
+     */
+    addEdge(edge: E): boolean {
+        if (!(this.hasVertex(edge.src) && this.hasVertex(edge.dest))) {
+            return false;
+        }
+
+        const srcVertex = this._getVertex(edge.src);
+        const destVertex = this._getVertex(edge.dest);
+
+        // TODO after no-non-null-assertion not ensure the logic
+        if (srcVertex && destVertex) {
+            const srcOutEdges = this._outEdgeMap.get(srcVertex);
+            if (srcOutEdges) {
+                srcOutEdges.push(edge);
+            } else {
+                this._outEdgeMap.set(srcVertex, [edge]);
+            }
+
+            const destInEdges = this._inEdgeMap.get(destVertex);
+            if (destInEdges) {
+                destInEdges.push(edge);
+            } else {
+                this._inEdgeMap.set(destVertex, [edge]);
+            }
+            return true;
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * The `removeEdgeBetween` function removes an edge between two vertices in a directed graph and returns the removed
+     * edge, or null if the edge was not found.
+     * @param {V | VertexId} srcOrId - The `srcOrId` parameter represents either a `V`
+     * object or a `VertexId` value. It is used to specify the source vertex of the edge that you want to remove.
+     * @param {V | VertexId} destOrId - The `destOrId` parameter represents the destination vertex of the
+     * edge that you want to remove. It can be either a `V` object or a `VertexId` value.
+     * @returns The function `removeEdgeBetween` returns the removed edge (`E`) if it exists, or `null` if
+     * the edge does not exist.
+     */
+    removeEdgeBetween(srcOrId: V | VertexId, destOrId: V | VertexId): E | null {
+
+        const src: V | null = this._getVertex(srcOrId);
+        const dest: V | null = this._getVertex(destOrId);
+        let removed: E | null = null;
+        if (!src || !dest) {
+            return null;
+        }
+
+        const srcOutEdges = this._outEdgeMap.get(src);
+        if (srcOutEdges) {
+            /**
+             * The removeEdge 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 represents the edge that you want to remove from the graph. It should be an
+             * object that has `src` and `dest` properties, which represent the source and destination vertices of the edge,
+             * respectively.
+             * @returns The method `removeEdge` returns the removed edge (`E`) if it exists, or `null` if the edge does not exist.
+             */
+            arrayRemove<E>(srcOutEdges, (edge: E) => edge.dest === dest.id);
+        }
+
+        const destInEdges = this._inEdgeMap.get(dest);
+        if (destInEdges) {
+            removed = arrayRemove<E>(destInEdges, (edge: E) => edge.src === src.id)[0] || null;
+        }
+        return removed;
+    }
+
+    /**
+     * The `removeEdge` function removes a directed edge from a graph and returns the removed edge, or null if the edge was
+     * not found.
+     * @param edge - The `edge` parameter is an object of type `E`, which represents a directed edge in a
+     * graph. It has two properties:
+     * @returns The function `removeEdge` returns a `E` object if an edge is successfully removed, or `null`
+     * if no edge is removed.
+     */
+    removeEdge(edge: E): E | null {
+        let removed: E | null = null;
+        const src = this._getVertex(edge.src);
+        const dest = this._getVertex(edge.dest);
+        if (src && dest) {
+            const srcOutEdges = this._outEdgeMap.get(src);
+            if (srcOutEdges && srcOutEdges.length > 0) {
+                arrayRemove(srcOutEdges, (edge: E) => edge.src === src.id);
+            }
+
+            const destInEdges = this._inEdgeMap.get(dest);
+            if (destInEdges && destInEdges.length > 0) {
+                removed = arrayRemove(destInEdges, (edge: E) => edge.dest === dest.id)[0];
+            }
+
+        }
+
+        return removed;
+    }
+
+    /**
+     * The function removeAllEdges removes all edges between two vertices.
+     * @param {VertexId | V} src - The `src` parameter can be either a `VertexId` or a `V`.
+     * @param {VertexId | V} dest - The `dest` parameter represents the destination vertex of an edge. It
+     * can be either a `VertexId` or a `V`.
+     * @returns An empty array of DirectedEdge objects is being returned.
+     */
+    removeAllEdges(src: VertexId | V, dest: VertexId | V): E[] {
+        return [];
+    }
+
+    /**
+     * The function returns an array of incoming edges of a given vertex or vertex ID.
+     * @param {V | VertexId} vertexOrId - The parameter `vertexOrId` can be either a `V`
+     * object or a `VertexId`.
+     * @returns The method `incomingEdgesOf` returns an array of `E` objects.
+     */
+    incomingEdgesOf(vertexOrId: V | VertexId): E[] {
+        const target = this._getVertex(vertexOrId);
+        if (target) {
+            return this.inEdgeMap.get(target) || []
+        }
+        return [];
+    }
+
+    /**
+     * The function `outgoingEdgesOf` returns an array of outgoing directed edges from a given vertex or vertex ID.
+     * @param {V | VertexId} vertexOrId - The parameter `vertexOrId` can be either a `V`
+     * object or a `VertexId`.
+     * @returns The method `outgoingEdgesOf` returns an array of `E` objects.
+     */
+    outgoingEdgesOf(vertexOrId: V | VertexId): E[] {
+        const target = this._getVertex(vertexOrId);
+        if (target) {
+            return this._outEdgeMap.get(target) || [];
+        }
+        return [];
+    }
+
+    /**
+     * The function "degreeOf" returns the total degree of a vertex in a directed graph, 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`.
+     * @returns The sum of the out-degree and in-degree of the given vertex or vertex ID.
+     */
+    degreeOf(vertexOrId: VertexId | V): number {
+        return this.outDegreeOf(vertexOrId) + this.inDegreeOf(vertexOrId);
+    }
+
+    /**
+     * The function "inDegreeOf" returns the number of incoming edges for a given vertex or vertex ID in a directed graph.
+     * @param {VertexId | V} vertexOrId - The parameter `vertexOrId` can be either a `VertexId` or a
+     * `V`.
+     * @returns The number of incoming edges of the specified vertex or vertex ID.
+     */
+    inDegreeOf(vertexOrId: VertexId | V): number {
+        return this.incomingEdgesOf(vertexOrId).length;
+    }
+
+    /**
+     * 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`.
+     * @returns The number of outgoing edges from the specified vertex or vertex ID.
+     */
+    outDegreeOf(vertexOrId: VertexId | V): number {
+        return this.outgoingEdgesOf(vertexOrId).length;
+    }
+
+    /**
+     * The function "edgesOf" returns an array of both outgoing and incoming directed edges of a given vertex or vertex ID.
+     * @param {VertexId | V} vertexOrId - The parameter `vertexOrId` can be either a `VertexId` or a
+     * `V`.
+     * @returns an array of directed edges.
+     */
+    edgesOf(vertexOrId: VertexId | V): E[] {
+        return [...this.outgoingEdgesOf(vertexOrId), ...this.incomingEdgesOf(vertexOrId)];
+    }
+
+    /**
+     * The function "getEdgeSrc" returns the source vertex of a directed edge, or null if the edge does not exist.
+     * @param e - A directed edge object of type E.
+     * @returns either a DirectedVertex object or null.
+     */
+    getEdgeSrc(e: E): V | null {
+        return this._getVertex(e.src);
+    }
+
+    /**
+     * The function "getEdgeDest" returns the destination vertex of a directed edge.
+     * @param e - E - This is an object representing a directed edge in a graph. It contains information
+     * about the source vertex, destination vertex, and any associated data.
+     * @returns either a DirectedVertex object or null.
+     */
+    getEdgeDest(e: E): V | null {
+        return this._getVertex(e.dest);
+    }
+
+    /**
+     * The function `getDestinations` returns an array of directed vertices that are the destinations of outgoing edges
+     * from a given vertex.
+     * @param {V | VertexId | null} vertex - The `vertex` parameter can be one of the following:
+     * @returns an array of DirectedVertex objects.
+     */
+    getDestinations(vertex: V | VertexId | null): V[] {
+        if (vertex === null) {
+            return [];
+        }
+        const destinations: V[] = [];
+        const outgoingEdges = this.outgoingEdgesOf(vertex);
+        for (const outEdge of outgoingEdges) {
+            const child = this.getEdgeDest(outEdge);
+            if (child) {
+                destinations.push(child);
+            }
+        }
+        return destinations;
+    }
+
+    /**
+     * The `topologicalSort` function performs a topological sort on a directed graph and returns the sorted vertices in
+     * reverse order, or null if the graph contains a cycle.
+     * @returns The function `topologicalSort()` returns an array of `V` or `VertexId` objects in
+     * topological order, or `null` if there is a cycle in the graph.
+     */
+    topologicalSort(): Array<V | VertexId> | null {
+        // When judging whether there is a cycle in the undirected graph, all nodes with degree of **<= 1** are enqueued
+        // When judging whether there is a cycle in the directed graph, all nodes with **in degree = 0** are enqueued
+        const statusMap: Map<V | VertexId, TopologicalStatus> = new Map<V | VertexId, TopologicalStatus>();
+        for (const entry of this.vertices) {
+            statusMap.set(entry[1], 0);
+        }
+
+        const sorted: (V | VertexId)[] = [];
+        let hasCycle = false;
+        const dfs = (cur: V | VertexId) => {
+            statusMap.set(cur, 1);
+            const children = this.getDestinations(cur);
+            for (const child of children) {
+                const childStatus = statusMap.get(child);
+                if (childStatus === 0) {
+                    dfs(child);
+                } else if (childStatus === 1) {
+                    hasCycle = true;
+                }
+            }
+            statusMap.set(cur, 2);
+            sorted.push(cur);
+        };
+
+        for (const entry of this.vertices) {
+            if (statusMap.get(entry[1]) === 0) {
+                dfs(entry[1]);
+            }
+        }
+
+        if (hasCycle) return null;
+
+        return sorted.reverse();
+    }
+
+    /**
+     * The `edgeSet` function returns an array of all directed edges in the graph.
+     * @returns The `edgeSet()` method returns an array of `E` objects.
+     */
+    edgeSet(): E[] {
+        let edges: E[] = [];
+        this._outEdgeMap.forEach(outEdges => {
+            edges = [...edges, ...outEdges];
+        });
+        return edges;
+    }
+
+    /**--- start find cycles --- */
+
+    /**
+     * The function `getNeighbors` returns an array of neighboring vertices of a given vertex in a directed graph.
+     * @param {V | VertexId} vertexOrId - The parameter `vertexOrId` can be either a `V`
+     * object or a `VertexId`.
+     * @returns an array of DirectedVertex objects.
+     */
+    getNeighbors(vertexOrId: V | VertexId): V[] {
+        const neighbors: V[] = [];
+        const vertex = this._getVertex(vertexOrId);
+        if (vertex) {
+            const outEdges = this.outgoingEdgesOf(vertex);
+            for (const outEdge of outEdges) {
+                const neighbor = this._getVertex(outEdge.dest);
+                // TODO after no-non-null-assertion not ensure the logic
+                if (neighbor) {
+                    neighbors.push(neighbor);
+                }
+            }
+        }
+        return neighbors;
+    }
+
+    /**--- end find cycles --- */
+
+    /**
+     * The function "getEndsOfEdge" returns the source and destination vertices of a directed edge if it exists in the
+     * graph, otherwise it returns null.
+     * @param edge - A directed edge object with a generic type E.
+     * @returns an array containing the starting and ending vertices of the given directed edge, or null if the edge does
+     * not exist in the graph.
+     */
+    getEndsOfEdge(edge: E): [V, V] | null {
+        if (!this.hasEdge(edge.src, edge.dest)) {
+            return null;
+        }
+        const v1 = this._getVertex(edge.src);
+        const v2 = this._getVertex(edge.dest);
+        if (v1 && v2) {
+            return [v1, v2];
+        } else {
+            return null;
+        }
+    }
+
+    protected _setOutEdgeMap(value: Map<V, E[]>) {
+        this._outEdgeMap = value;
+    }
+
+    protected _setInEdgeMap(value: Map<V, E[]>) {
+        this._inEdgeMap = value;
+    }
+}

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

@@ -0,0 +1,3 @@
+export * from './abstract-graph';
+export * from './directed-graph';
+export * from './undirected-graph';