data-structure-typed 0.9.16 → 1.12.9

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

@@ -16,28 +16,138 @@ export declare class DirectedGraph<V extends DirectedVertex, E extends DirectedE
     protected _outEdgeMap: Map<V, E[]>;
     protected _inEdgeMap: Map<V, E[]>;
     constructor();
+    /**
+     * The function `getEdge` returns the first edge between two vertices, given their source and destination.
+     * @param {V | null | VertexId} srcOrId - The `srcOrId` parameter can be either a vertex object (`V`), a vertex ID
+     * (`VertexId`), or `null`. It represents the source vertex of the edge.
+     * @param {V | null | VertexId} destOrId - The `destOrId` parameter is either a vertex object (`V`), a vertex ID
+     * (`VertexId`), or `null`. It represents the destination vertex of the edge.
+     * @returns an edge (E) or null.
+     */
     getEdge(srcOrId: V | null | VertexId, destOrId: V | null | VertexId): E | null;
+    /**
+     * The `addEdge` function adds an edge to a graph if the source and destination vertices exist.
+     * @param {E} edge - The parameter `edge` is of type `E`, which represents an edge in the graph. It contains
+     * information about the source vertex (`src`) and the destination vertex (`dest`) of the edge.
+     * @returns The `addEdge` function returns a boolean value. It returns `true` if the edge was successfully added to the
+     * graph, and `false` if either the source or destination vertices of the edge are not present in the graph.
+     */
     addEdge(edge: E): boolean;
+    /**
+     * The function removes an edge between two vertices in a directed graph and returns the removed edge.
+     * @param {V | VertexId} srcOrId - The source vertex or its ID.
+     * @param {V | VertexId} destOrId - The `destOrId` parameter in the `removeEdgeBetween` function represents the
+     * destination vertex of the edge that needs to be removed. It can be either a vertex object (`V`) or a vertex ID
+     * (`VertexId`).
+     * @returns The function `removeEdgeBetween` returns the removed edge (`E`) if the edge between the source and
+     * destination vertices is successfully removed. If either the source or destination vertex is not found, or if the
+     * edge does not exist, it returns `null`.
+     */
     removeEdgeBetween(srcOrId: V | VertexId, destOrId: V | VertexId): E | null;
+    /**
+     * 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 is an object that represents an edge in a graph. It has two properties: `src`
+     * and `dest`, 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.
+     */
     removeEdge(edge: E): E | null;
+    /**
+     * The function removeAllEdges removes all edges between two vertices.
+     * @param {VertexId | V} src - The `src` parameter represents the source vertex from which the edges will be removed.
+     * It can be either a `VertexId` or a `V` type, which represents the identifier or object of the vertex.
+     * @param {VertexId | V} dest - The `dest` parameter represents the destination vertex of an edge. It can be either a
+     * `VertexId` or a vertex object `V`.
+     * @returns An empty array is being returned.
+     */
     removeAllEdges(src: VertexId | V, dest: VertexId | 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`).
+     * @returns The method `incomingEdgesOf` returns an array of edges (`E[]`).
+     */
     incomingEdgesOf(vertexOrId: V | VertexId): 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`).
+     * @returns The method `outgoingEdgesOf` returns an array of outgoing edges from a given vertex or vertex ID.
+     */
     outgoingEdgesOf(vertexOrId: V | VertexId): 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`.
+     * @returns the sum of the out-degree and in-degree of the specified vertex or vertex ID.
+     */
     degreeOf(vertexOrId: VertexId | 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`.
+     * @returns The number of incoming edges of the specified vertex or vertex ID.
+     */
     inDegreeOf(vertexOrId: VertexId | 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`.
+     * @returns The number of outgoing edges from the specified vertex or vertex ID.
+     */
     outDegreeOf(vertexOrId: VertexId | 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`.
+     * @returns The function `edgesOf` returns an array of edges.
+     */
     edgesOf(vertexOrId: VertexId | V): E[];
+    /**
+     * The function "getEdgeSrc" returns the source vertex of an edge, or null if the edge does not exist.
+     * @param {E} e - E - an edge object
+     * @returns the source vertex of the given edge, or null if the edge does not exist.
+     */
     getEdgeSrc(e: E): V | null;
+    /**
+     * The function "getEdgeDest" returns the vertex associated with the destination of an edge.
+     * @param {E} e - The parameter `e` is of type `E`, which represents an edge in a graph.
+     * @returns either a vertex object (of type V) or null.
+     */
     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` (which is a unique identifier for a vertex), or
+     * `null` if we want to find destinations from all vertices.
+     * @returns an array of vertices (V[]).
+     */
     getDestinations(vertex: V | VertexId | null): V[];
     /**--- start find cycles --- */
     /**
      * when stored with adjacency list time: O(V+E)
      * when stored with adjacency matrix time: O(V^2)
+     * 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 vertices in topological order if there is no cycle in
+     * the graph. If there is a cycle in the graph, it returns `null`.
      */
-    topologicalSort(): (V | VertexId)[] | null;
+    topologicalSort(): V[] | null;
     /**--- end find cycles --- */
+    /**
+     * The `edgeSet` function returns an array of all the edges in the graph.
+     * @returns The `edgeSet()` method returns an array of edges (`E[]`).
+     */
     edgeSet(): E[];
+    /**
+     * The function `getNeighbors` returns an array of neighboring vertices 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`).
+     * @returns an array of vertices (V[]).
+     */
     getNeighbors(vertexOrId: V | VertexId): V[];
+    /**
+     * The function "getEndsOfEdge" returns the source and destination vertices of an edge if it exists in the graph,
+     * otherwise it returns null.
+     * @param {E} edge - The parameter "edge" is of type E, which represents an edge in a graph.
+     * @returns an array containing two vertices [V, V] if the edge is found in the graph. If the edge is not found, it
+     * returns null.
+     */
     getEndsOfEdge(edge: E): [V, V] | null;
 }

package/dist/data-structures/graph/directed-graph.js

@@ -52,6 +52,10 @@ var __values = (this && this.__values) || function(o) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DirectedGraph = exports.DirectedEdge = exports.DirectedVertex = void 0;
+/**
+ * @copyright 2030 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT
+ */
 var utils_1 = require("../../utils");
 var abstract_graph_1 = require("./abstract-graph");
 var DirectedVertex = /** @class */ (function (_super) {
@@ -102,6 +106,14 @@ var DirectedGraph = /** @class */ (function (_super) {
         _this._inEdgeMap = new Map();
         return _this;
     }
+    /**
+     * The function `getEdge` returns the first edge between two vertices, given their source and destination.
+     * @param {V | null | VertexId} srcOrId - The `srcOrId` parameter can be either a vertex object (`V`), a vertex ID
+     * (`VertexId`), or `null`. It represents the source vertex of the edge.
+     * @param {V | null | VertexId} destOrId - The `destOrId` parameter is either a vertex object (`V`), a vertex ID
+     * (`VertexId`), or `null`. It represents the destination vertex of the edge.
+     * @returns an edge (E) or null.
+     */
     DirectedGraph.prototype.getEdge = function (srcOrId, destOrId) {
         var edges = [];
         if (srcOrId !== null && destOrId !== null) {
@@ -116,6 +128,13 @@ var DirectedGraph = /** @class */ (function (_super) {
         }
         return edges[0] || null;
     };
+    /**
+     * The `addEdge` function adds an edge to a graph if the source and destination vertices exist.
+     * @param {E} edge - The parameter `edge` is of type `E`, which represents an edge in the graph. It contains
+     * information about the source vertex (`src`) and the destination vertex (`dest`) of the edge.
+     * @returns The `addEdge` function returns a boolean value. It returns `true` if the edge was successfully added to the
+     * graph, and `false` if either the source or destination vertices of the edge are not present in the graph.
+     */
     DirectedGraph.prototype.addEdge = function (edge) {
         if (!(this.containsVertex(edge.src) && this.containsVertex(edge.dest))) {
             return false;
@@ -144,6 +163,16 @@ var DirectedGraph = /** @class */ (function (_super) {
             return false;
         }
     };
+    /**
+     * The function removes an edge between two vertices in a directed graph and returns the removed edge.
+     * @param {V | VertexId} srcOrId - The source vertex or its ID.
+     * @param {V | VertexId} destOrId - The `destOrId` parameter in the `removeEdgeBetween` function represents the
+     * destination vertex of the edge that needs to be removed. It can be either a vertex object (`V`) or a vertex ID
+     * (`VertexId`).
+     * @returns The function `removeEdgeBetween` returns the removed edge (`E`) if the edge between the source and
+     * destination vertices is successfully removed. If either the source or destination vertex is not found, or if the
+     * edge does not exist, it returns `null`.
+     */
     DirectedGraph.prototype.removeEdgeBetween = function (srcOrId, destOrId) {
         var src = this.getVertex(srcOrId);
         var dest = this.getVertex(destOrId);
@@ -153,6 +182,14 @@ var DirectedGraph = /** @class */ (function (_super) {
         }
         var 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.
+             */
             (0, utils_1.arrayRemove)(srcOutEdges, function (edge) { return edge.dest === dest.id; });
         }
         var destInEdges = this._inEdgeMap.get(dest);
@@ -161,6 +198,13 @@ var DirectedGraph = /** @class */ (function (_super) {
         }
         return removed;
     };
+    /**
+     * 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 is an object that represents an edge in a graph. It has two properties: `src`
+     * and `dest`, 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.
+     */
     DirectedGraph.prototype.removeEdge = function (edge) {
         var removed = null;
         var src = this.getVertex(edge.src);
@@ -177,9 +221,23 @@ var DirectedGraph = /** @class */ (function (_super) {
         }
         return removed;
     };
+    /**
+     * The function removeAllEdges removes all edges between two vertices.
+     * @param {VertexId | V} src - The `src` parameter represents the source vertex from which the edges will be removed.
+     * It can be either a `VertexId` or a `V` type, which represents the identifier or object of the vertex.
+     * @param {VertexId | V} dest - The `dest` parameter represents the destination vertex of an edge. It can be either a
+     * `VertexId` or a vertex object `V`.
+     * @returns An empty array is being returned.
+     */
     DirectedGraph.prototype.removeAllEdges = function (src, dest) {
         return [];
     };
+    /**
+     * 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`).
+     * @returns The method `incomingEdgesOf` returns an array of edges (`E[]`).
+     */
     DirectedGraph.prototype.incomingEdgesOf = function (vertexOrId) {
         var target = this.getVertex(vertexOrId);
         if (target) {
@@ -187,6 +245,12 @@ var DirectedGraph = /** @class */ (function (_super) {
         }
         return [];
     };
+    /**
+     * 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`).
+     * @returns The method `outgoingEdgesOf` returns an array of outgoing edges from a given vertex or vertex ID.
+     */
     DirectedGraph.prototype.outgoingEdgesOf = function (vertexOrId) {
         var target = this.getVertex(vertexOrId);
         if (target) {
@@ -194,24 +258,61 @@ var DirectedGraph = /** @class */ (function (_super) {
         }
         return [];
     };
+    /**
+     * 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`.
+     * @returns the sum of the out-degree and in-degree of the specified vertex or vertex ID.
+     */
     DirectedGraph.prototype.degreeOf = function (vertexOrId) {
         return this.outDegreeOf(vertexOrId) + this.inDegreeOf(vertexOrId);
     };
+    /**
+     * 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`.
+     * @returns The number of incoming edges of the specified vertex or vertex ID.
+     */
     DirectedGraph.prototype.inDegreeOf = function (vertexOrId) {
         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.
+     */
     DirectedGraph.prototype.outDegreeOf = function (vertexOrId) {
         return this.outgoingEdgesOf(vertexOrId).length;
     };
+    /**
+     * 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`.
+     * @returns The function `edgesOf` returns an array of edges.
+     */
     DirectedGraph.prototype.edgesOf = function (vertexOrId) {
         return __spreadArray(__spreadArray([], __read(this.outgoingEdgesOf(vertexOrId)), false), __read(this.incomingEdgesOf(vertexOrId)), false);
     };
+    /**
+     * The function "getEdgeSrc" returns the source vertex of an edge, or null if the edge does not exist.
+     * @param {E} e - E - an edge object
+     * @returns the source vertex of the given edge, or null if the edge does not exist.
+     */
     DirectedGraph.prototype.getEdgeSrc = function (e) {
         return this.getVertex(e.src);
     };
+    /**
+     * The function "getEdgeDest" returns the vertex associated with the destination of an edge.
+     * @param {E} e - The parameter `e` is of type `E`, which represents an edge in a graph.
+     * @returns either a vertex object (of type V) or null.
+     */
     DirectedGraph.prototype.getEdgeDest = function (e) {
         return this.getVertex(e.dest);
     };
+    /**
+     * 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` (which is a unique identifier for a vertex), or
+     * `null` if we want to find destinations from all vertices.
+     * @returns an array of vertices (V[]).
+     */
     DirectedGraph.prototype.getDestinations = function (vertex) {
         var e_1, _a;
         if (vertex === null) {
@@ -241,6 +342,10 @@ var DirectedGraph = /** @class */ (function (_super) {
     /**
      * when stored with adjacency list time: O(V+E)
      * when stored with adjacency matrix time: O(V^2)
+     * 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 vertices in topological order if there is no cycle in
+     * the graph. If there is a cycle in the graph, it returns `null`.
      */
     DirectedGraph.prototype.topologicalSort = function () {
         var e_2, _a, e_3, _b;
@@ -339,6 +444,10 @@ var DirectedGraph = /** @class */ (function (_super) {
         return sorted.reverse();
     };
     /**--- end find cycles --- */
+    /**
+     * The `edgeSet` function returns an array of all the edges in the graph.
+     * @returns The `edgeSet()` method returns an array of edges (`E[]`).
+     */
     DirectedGraph.prototype.edgeSet = function () {
         var edges = [];
         this._outEdgeMap.forEach(function (outEdges) {
@@ -346,6 +455,12 @@ var DirectedGraph = /** @class */ (function (_super) {
         });
         return edges;
     };
+    /**
+     * The function `getNeighbors` returns an array of neighboring vertices 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`).
+     * @returns an array of vertices (V[]).
+     */
     DirectedGraph.prototype.getNeighbors = function (vertexOrId) {
         var e_5, _a;
         var neighbors = [];
@@ -372,6 +487,13 @@ var DirectedGraph = /** @class */ (function (_super) {
         }
         return neighbors;
     };
+    /**
+     * The function "getEndsOfEdge" returns the source and destination vertices of an edge if it exists in the graph,
+     * otherwise it returns null.
+     * @param {E} edge - The parameter "edge" is of type E, which represents an edge in a graph.
+     * @returns an array containing two vertices [V, V] if the edge is found in the graph. If the edge is not found, it
+     * returns null.
+     */
     DirectedGraph.prototype.getEndsOfEdge = function (edge) {
         if (!this.containsEdge(edge.src, edge.dest)) {
             return null;

package/dist/data-structures/graph/undirected-graph.d.ts

@@ -12,14 +12,77 @@ export declare class UndirectedEdge extends AbstractEdge {
 export declare class UndirectedGraph<V extends UndirectedVertex, E extends UndirectedEdge> extends AbstractGraph<V, E> {
     protected _edges: Map<V, E[]>;
     constructor();
+    /**
+     * The function `getEdge` returns the first edge that connects two vertices, or null if no such edge exists.
+     * @param {V | null | VertexId} v1 - The parameter `v1` represents either a vertex object (`V`) or a vertex ID
+     * (`VertexId`). It can also be `null`.
+     * @param {V | null | VertexId} v2 - The parameter `v2` represents a vertex or vertex ID. It can be of type `V` (vertex
+     * object), `null`, or `VertexId` (vertex ID).
+     * @returns an edge (E) or null.
+     */
     getEdge(v1: V | null | VertexId, v2: V | null | VertexId): E | null;
+    /**
+     * The function adds an edge to a graph by connecting two vertices.
+     * @param {E} edge - The `edge` parameter is an object of type `E`, which represents an edge in a graph.
+     * @returns a boolean value.
+     */
     addEdge(edge: E): boolean;
+    /**
+     * The function removes an edge between two vertices in a graph and returns the removed edge, or null if either of the
+     * vertices does not exist.
+     * @param {V | VertexId} v1 - The parameter `v1` represents either a vertex object (`V`) or a vertex ID (`VertexId`).
+     * @param {V | VertexId} v2 - V | VertexId: The second vertex or vertex ID of the edge to be removed.
+     * @returns the removed edge (E) if it exists, or null if either of the vertices (v1 or v2) does not exist.
+     */
     removeEdgeBetween(v1: V | VertexId, v2: V | VertexId): E | null;
+    /**
+     * The removeEdge function removes an edge between two vertices in a graph.
+     * @param {E} edge - The parameter "edge" is of type E, which represents an edge in a graph.
+     * @returns The method is returning either the removed edge (of type E) or null if the edge was not found.
+     */
     removeEdge(edge: E): E | null;
+    /**
+     * The function `degreeOf` returns the degree of a vertex in a graph, which is the number of edges connected to that
+     * vertex.
+     * @param {VertexId | V} vertexOrId - The parameter `vertexOrId` can be either a `VertexId` or a `V`.
+     * @returns The function `degreeOf` returns the degree of a vertex in a graph. The degree of a vertex is the number of
+     * edges that are incident to that vertex.
+     */
     degreeOf(vertexOrId: VertexId | V): number;
+    /**
+     * The function "edgesOf" returns an array of edges connected to a given vertex.
+     * @param {VertexId | V} vertexOrId - The parameter `vertexOrId` can be either a `VertexId` or a `V`.
+     * @returns an array of edges connected to the specified vertex. If the vertex exists in the graph, the function
+     * returns the array of edges connected to that vertex. If the vertex does not exist in the graph, the function returns
+     * an empty array.
+     */
     edgesOf(vertexOrId: VertexId | V): E[];
+    /**
+     * The function "edgeSet" returns an array of unique edges from a set of edges.
+     * @returns The method `edgeSet()` returns an array of type `E[]`.
+     */
     edgeSet(): E[];
+    /**
+     * The function "getEdgesOf" returns an array of edges connected to 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`).
+     * @returns an array of edges (E[]) that are connected to the specified vertex or vertex ID.
+     */
     getEdgesOf(vertexOrId: V | VertexId): E[];
+    /**
+     * The function "getNeighbors" returns an array of neighboring vertices of a given vertex.
+     * @param {V | VertexId} vertexOrId - The parameter `vertexOrId` can be either a vertex object (`V`) or a vertex ID
+     * (`VertexId`).
+     * @returns an array of vertices (V[]).
+     */
     getNeighbors(vertexOrId: V | VertexId): V[];
+    /**
+     * The function "getEndsOfEdge" returns the vertices at the ends of a given edge, or null if the edge does not exist in
+     * the graph.
+     * @param {E} edge - The parameter "edge" is of type E, which represents an edge in a graph.
+     * @returns The function `getEndsOfEdge` returns an array containing two vertices `[V, V]` if the edge exists in the
+     * graph and both vertices are found. If the edge does not exist or one or both vertices are not found, it returns
+     * `null`.
+     */
     getEndsOfEdge(edge: E): [V, V] | null;
 }

package/dist/data-structures/graph/undirected-graph.js

@@ -52,6 +52,10 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UndirectedGraph = exports.UndirectedEdge = exports.UndirectedVertex = void 0;
+/**
+ * @copyright 2030 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT
+ */
 var utils_1 = require("../../utils");
 var abstract_graph_1 = require("./abstract-graph");
 var UndirectedVertex = /** @class */ (function (_super) {
@@ -89,6 +93,14 @@ var UndirectedGraph = /** @class */ (function (_super) {
         _this._edges = new Map();
         return _this;
     }
+    /**
+     * The function `getEdge` returns the first edge that connects two vertices, or null if no such edge exists.
+     * @param {V | null | VertexId} v1 - The parameter `v1` represents either a vertex object (`V`) or a vertex ID
+     * (`VertexId`). It can also be `null`.
+     * @param {V | null | VertexId} v2 - The parameter `v2` represents a vertex or vertex ID. It can be of type `V` (vertex
+     * object), `null`, or `VertexId` (vertex ID).
+     * @returns an edge (E) or null.
+     */
     UndirectedGraph.prototype.getEdge = function (v1, v2) {
         var _a;
         var edges = [];
@@ -101,6 +113,11 @@ var UndirectedGraph = /** @class */ (function (_super) {
         }
         return edges ? edges[0] || null : null;
     };
+    /**
+     * The function adds an edge to a graph by connecting two vertices.
+     * @param {E} edge - The `edge` parameter is an object of type `E`, which represents an edge in a graph.
+     * @returns a boolean value.
+     */
     UndirectedGraph.prototype.addEdge = function (edge) {
         var e_1, _a;
         try {
@@ -129,6 +146,13 @@ var UndirectedGraph = /** @class */ (function (_super) {
         }
         return true;
     };
+    /**
+     * The function removes an edge between two vertices in a graph and returns the removed edge, or null if either of the
+     * vertices does not exist.
+     * @param {V | VertexId} v1 - The parameter `v1` represents either a vertex object (`V`) or a vertex ID (`VertexId`).
+     * @param {V | VertexId} v2 - V | VertexId: The second vertex or vertex ID of the edge to be removed.
+     * @returns the removed edge (E) if it exists, or null if either of the vertices (v1 or v2) does not exist.
+     */
     UndirectedGraph.prototype.removeEdgeBetween = function (v1, v2) {
         var vertex1 = this.getVertex(v1);
         var vertex2 = this.getVertex(v2);
@@ -146,9 +170,21 @@ var UndirectedGraph = /** @class */ (function (_super) {
         }
         return removed;
     };
+    /**
+     * The removeEdge function removes an edge between two vertices in a graph.
+     * @param {E} edge - The parameter "edge" is of type E, which represents an edge in a graph.
+     * @returns The method is returning either the removed edge (of type E) or null if the edge was not found.
+     */
     UndirectedGraph.prototype.removeEdge = function (edge) {
         return this.removeEdgeBetween(edge.vertices[0], edge.vertices[1]);
     };
+    /**
+     * The function `degreeOf` returns the degree of a vertex in a graph, which is the number of edges connected to that
+     * vertex.
+     * @param {VertexId | V} vertexOrId - The parameter `vertexOrId` can be either a `VertexId` or a `V`.
+     * @returns The function `degreeOf` returns the degree of a vertex in a graph. The degree of a vertex is the number of
+     * edges that are incident to that vertex.
+     */
     UndirectedGraph.prototype.degreeOf = function (vertexOrId) {
         var _a;
         var vertex = this.getVertex(vertexOrId);
@@ -159,6 +195,13 @@ var UndirectedGraph = /** @class */ (function (_super) {
             return 0;
         }
     };
+    /**
+     * The function "edgesOf" returns an array of edges connected to a given vertex.
+     * @param {VertexId | V} vertexOrId - The parameter `vertexOrId` can be either a `VertexId` or a `V`.
+     * @returns an array of edges connected to the specified vertex. If the vertex exists in the graph, the function
+     * returns the array of edges connected to that vertex. If the vertex does not exist in the graph, the function returns
+     * an empty array.
+     */
     UndirectedGraph.prototype.edgesOf = function (vertexOrId) {
         var vertex = this.getVertex(vertexOrId);
         if (vertex) {
@@ -168,6 +211,10 @@ var UndirectedGraph = /** @class */ (function (_super) {
             return [];
         }
     };
+    /**
+     * The function "edgeSet" returns an array of unique edges from a set of edges.
+     * @returns The method `edgeSet()` returns an array of type `E[]`.
+     */
     UndirectedGraph.prototype.edgeSet = function () {
         var edgeSet = new Set();
         this._edges.forEach(function (edges) {
@@ -177,6 +224,12 @@ var UndirectedGraph = /** @class */ (function (_super) {
         });
         return __spreadArray([], __read(edgeSet), false);
     };
+    /**
+     * The function "getEdgesOf" returns an array of edges connected to 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`).
+     * @returns an array of edges (E[]) that are connected to the specified vertex or vertex ID.
+     */
     UndirectedGraph.prototype.getEdgesOf = function (vertexOrId) {
         var vertex = this.getVertex(vertexOrId);
         if (!vertex) {
@@ -184,6 +237,12 @@ var UndirectedGraph = /** @class */ (function (_super) {
         }
         return this._edges.get(vertex) || [];
     };
+    /**
+     * The function "getNeighbors" returns an array of neighboring vertices of a given vertex.
+     * @param {V | VertexId} vertexOrId - The parameter `vertexOrId` can be either a vertex object (`V`) or a vertex ID
+     * (`VertexId`).
+     * @returns an array of vertices (V[]).
+     */
     UndirectedGraph.prototype.getNeighbors = function (vertexOrId) {
         var e_2, _a;
         var neighbors = [];
@@ -209,6 +268,14 @@ var UndirectedGraph = /** @class */ (function (_super) {
         }
         return neighbors;
     };
+    /**
+     * The function "getEndsOfEdge" returns the vertices at the ends of a given edge, or null if the edge does not exist in
+     * the graph.
+     * @param {E} edge - The parameter "edge" is of type E, which represents an edge in a graph.
+     * @returns The function `getEndsOfEdge` returns an array containing two vertices `[V, V]` if the edge exists in the
+     * graph and both vertices are found. If the edge does not exist or one or both vertices are not found, it returns
+     * `null`.
+     */
     UndirectedGraph.prototype.getEndsOfEdge = function (edge) {
         if (!this.containsEdge(edge.vertices[0], edge.vertices[1])) {
             return null;

package/dist/data-structures/hash/coordinate-map.d.ts

@@ -1,8 +1,40 @@
+/**
+ * @copyright 2030 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT
+ */
 export declare class CoordinateMap<V> extends Map<any, V> {
     private readonly _joint;
     constructor(joint?: string);
+    /**
+     * The "has" function overrides the base class's "has" function and checks if a key exists in the map by joining the
+     * key array with a specified delimiter.
+     * @param {number[]} key - The parameter "key" is an array of numbers.
+     * @returns The `has` method is being overridden to return the result of calling the `has` method of the superclass
+     * (`super.has`) with the `key` array joined together using the `_joint` property.
+     */
     has(key: number[]): boolean;
+    /**
+     * The function overrides the set method of a Map object to convert the key from an array to a string using a specified
+     * delimiter before calling the original set method.
+     * @param {number[]} key - The key parameter is an array of numbers.
+     * @param {V} value - The value parameter is the value that you want to associate with the specified key.
+     * @returns The `set` method is returning the result of calling the `set` method of the superclass
+     * (`super.set(key.join(this._joint), value)`).
+     */
     set(key: number[], value: V): this;
+    /**
+     * The function overrides the get method to join the key array with a specified joint and then calls the super get
+     * method.
+     * @param {number[]} key - An array of numbers
+     * @returns The code is returning the value associated with the specified key in the map.
+     */
     get(key: number[]): V | undefined;
+    /**
+     * The function overrides the delete method and joins the key array using a specified joint character before calling
+     * the super delete method.
+     * @param {number[]} key - An array of numbers that represents the key to be deleted.
+     * @returns The `delete` method is returning the result of calling the `delete` method on the superclass, with the
+     * `key` array joined together using the `_joint` property.
+     */
     delete(key: number[]): boolean;
 }