data-structure-typed 1.35.0 → 1.40.0-rc

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

@@ -3,6 +3,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MapGraph = exports.MapEdge = exports.MapVertex = void 0;
 const directed_graph_1 = require("./directed-graph");
 class MapVertex extends directed_graph_1.DirectedVertex {
+    /**
+     * The constructor function initializes an object with an key, latitude, longitude, and an optional value.
+     * @param {VertexKey} key - The `key` parameter is of type `VertexKey` and represents the identifier of the vertex.
+     * @param {number} lat - The "lat" parameter represents the latitude of a vertex. Latitude is a geographic coordinate
+     * that specifies the north-south position of a point on the Earth's surface. It is measured in degrees, with positive
+     * values representing points north of the equator and negative values representing points south of the equator.
+     * @param {number} long - The "long" parameter represents the longitude of a location. Longitude is a geographic
+     * coordinate that specifies the east-west position of a point on the Earth's surface. It is measured in degrees, with
+     * values ranging from -180 to 180.
+     * @param {V} [val] - The "val" parameter is an optional value of type V. It is not required to be provided when
+     * creating an instance of the class.
+     */
     constructor(key, lat, long, val) {
         super(key, val);
         this._lat = lat;
@@ -23,12 +35,31 @@ class MapVertex extends directed_graph_1.DirectedVertex {
 }
 exports.MapVertex = MapVertex;
 class MapEdge extends directed_graph_1.DirectedEdge {
+    /**
+     * The constructor function initializes a new instance of a class with the given source, destination, weight, and
+     * value.
+     * @param {VertexKey} src - The `src` parameter is the source vertex ID. It represents the starting point of an edge in
+     * a graph.
+     * @param {VertexKey} 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.
+     * @param {V} [val] - The "val" parameter is an optional parameter of type V. It is used to store additional
+     * information or data associated with the edge.
+     */
     constructor(src, dest, weight, val) {
         super(src, dest, weight, val);
     }
 }
 exports.MapEdge = MapEdge;
 class MapGraph extends directed_graph_1.DirectedGraph {
+    /**
+     * The constructor function initializes the origin and bottomRight properties of a MapGraphCoordinate object.
+     * @param {MapGraphCoordinate} origin - The `origin` parameter is a `MapGraphCoordinate` object that represents the
+     * starting point or reference point of the map graph. It defines the coordinates of the top-left corner of the map
+     * graph.
+     * @param {MapGraphCoordinate} [bottomRight] - The `bottomRight` parameter is an optional parameter of type
+     * `MapGraphCoordinate`. It represents the bottom right coordinate of a map graph. If this parameter is not provided,
+     * it will default to `undefined`.
+     */
     constructor(origin, bottomRight) {
         super();
         this._origin = [0, 0];
@@ -47,9 +78,32 @@ class MapGraph extends directed_graph_1.DirectedGraph {
     set bottomRight(value) {
         this._bottomRight = value;
     }
+    /**
+     * The function creates a new vertex with the given key, value, latitude, and longitude.
+     * @param {VertexKey} key - The key parameter is the unique identifier for the vertex. It is of type VertexKey, which could
+     * be a string or a number depending on how you define it in your code.
+     * @param [val] - The `val` parameter is an optional value that can be assigned to the `val` property of the vertex. It
+     * is of type `V['val']`, which means it should be of the same type as the `val` property of the vertex class `V`.
+     * @param {number} lat - The `lat` parameter represents the latitude of the vertex. It is a number that specifies the
+     * position of the vertex on the Earth's surface in the north-south direction.
+     * @param {number} long - The `long` parameter represents the longitude coordinate of the vertex.
+     * @returns The method is returning a new instance of the `MapVertex` class, casted as type `V`.
+     */
     createVertex(key, val, lat = this.origin[0], long = this.origin[1]) {
         return new MapVertex(key, lat, long, val);
     }
+    /**
+     * The function creates a new instance of a MapEdge with the given source, destination, weight, and value.
+     * @param {VertexKey} src - The source vertex ID of the edge. It represents the starting point of the edge.
+     * @param {VertexKey} dest - The `dest` parameter is the identifier of the destination vertex for the edge being
+     * created.
+     * @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 can be set to a default value or left undefined.
+     * @param [val] - The `val` parameter is an optional value that can be assigned to the edge. It can be of any type,
+     * depending on the specific implementation of the `MapEdge` class.
+     * @returns a new instance of the `MapEdge` class, casted as type `E`.
+     */
     createEdge(src, dest, weight, val) {
         return new MapEdge(src, dest, weight, val);
     }

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

@@ -1 +1 @@
-{"version":3,"file":"map-graph.js","sourceRoot":"","sources":["../../../src/data-structures/graph/map-graph.ts"],"names":[],"mappings":";;;AACA,qDAA6E;AAE7E,MAAa,SAAmB,SAAQ,+BAAiB;IAavD,YAAY,GAAc,EAAE,GAAW,EAAE,IAAY,EAAE,GAAO;QAC5D,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QAChB,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAID,IAAI,GAAG;QACL,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED,IAAI,GAAG,CAAC,KAAa;QACnB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC;IACpB,CAAC;IAID,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,IAAI,IAAI,CAAC,KAAa;QACpB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF;AAtCD,8BAsCC;AAED,MAAa,OAAiB,SAAQ,6BAAe;IAWnD,YAAY,GAAc,EAAE,IAAe,EAAE,MAAe,EAAE,GAAO;QACnE,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC;IAChC,CAAC;CACF;AAdD,0BAcC;AAED,MAAa,QAAiF,SAAQ,8BAGrG;IAUC,YAAY,MAA0B,EAAE,WAAgC;QACtE,KAAK,EAAE,CAAC;QAKF,YAAO,GAAuB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAJ3C,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IAClC,CAAC;IAID,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,IAAI,MAAM,CAAC,KAAyB;QAClC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;IACvB,CAAC;IAID,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED,IAAI,WAAW,CAAC,KAAqC;QACnD,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;IAC5B,CAAC;IAaQ,YAAY,CACnB,GAAc,EACd,GAAc,EACd,MAAc,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAC5B,OAAe,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QAE7B,OAAO,IAAI,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,CAAM,CAAC;IACjD,CAAC;IAcQ,UAAU,CAAC,GAAc,EAAE,IAAe,EAAE,MAAe,EAAE,GAAc;QAClF,OAAO,IAAI,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,CAAM,CAAC;IAClD,CAAC;CACF;AA1ED,4BA0EC"}
+{"version":3,"file":"map-graph.js","sourceRoot":"","sources":["../../../src/data-structures/graph/map-graph.ts"],"names":[],"mappings":";;;AACA,qDAA6E;AAE7E,MAAa,SAAmB,SAAQ,+BAAiB;IACvD;;;;;;;;;;;OAWG;IACH,YAAY,GAAc,EAAE,GAAW,EAAE,IAAY,EAAE,GAAO;QAC5D,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QAChB,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAID,IAAI,GAAG;QACL,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED,IAAI,GAAG,CAAC,KAAa;QACnB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC;IACpB,CAAC;IAID,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,IAAI,IAAI,CAAC,KAAa;QACpB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF;AAtCD,8BAsCC;AAED,MAAa,OAAiB,SAAQ,6BAAe;IACnD;;;;;;;;;OASG;IACH,YAAY,GAAc,EAAE,IAAe,EAAE,MAAe,EAAE,GAAO;QACnE,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC;IAChC,CAAC;CACF;AAdD,0BAcC;AAED,MAAa,QAAiF,SAAQ,8BAGrG;IACC;;;;;;;;OAQG;IACH,YAAY,MAA0B,EAAE,WAAgC;QACtE,KAAK,EAAE,CAAC;QAKF,YAAO,GAAuB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAJ3C,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IAClC,CAAC;IAID,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,IAAI,MAAM,CAAC,KAAyB;QAClC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;IACvB,CAAC;IAID,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED,IAAI,WAAW,CAAC,KAAqC;QACnD,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;IAC5B,CAAC;IAED;;;;;;;;;;OAUG;IACM,YAAY,CACnB,GAAc,EACd,GAAc,EACd,MAAc,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAC5B,OAAe,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QAE7B,OAAO,IAAI,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,CAAM,CAAC;IACjD,CAAC;IAED;;;;;;;;;;;OAWG;IACM,UAAU,CAAC,GAAc,EAAE,IAAe,EAAE,MAAe,EAAE,GAAc;QAClF,OAAO,IAAI,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,CAAM,CAAC;IAClD,CAAC;CACF;AA1ED,4BA0EC"}

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

@@ -0,0 +1,127 @@
+import { AbstractEdge, AbstractGraph, AbstractVertex } from './abstract-graph';
+import type { VertexKey } from '../../types';
+import { IUNDirectedGraph } from '../../interfaces';
+export declare class UndirectedVertex<V = any> extends AbstractVertex<V> {
+    /**
+     * The constructor function initializes a vertex with an optional value.
+     * @param {VertexKey} key - The `key` parameter is of type `VertexKey` and represents the identifier of the vertex. It is
+     * used to uniquely identify the vertex within a graph or network.
+     * @param {V} [val] - The "val" parameter is an optional parameter of type V. It is used to initialize the value of the
+     * vertex. If no value is provided, the vertex will be initialized with a default value.
+     */
+    constructor(key: VertexKey, val?: V);
+}
+export declare class UndirectedEdge<V = number> extends AbstractEdge<V> {
+    /**
+     * The constructor function creates an instance of a class with two vertex IDs, an optional weight, and an optional
+     * value.
+     * @param {VertexKey} v1 - The first vertex ID of the edge.
+     * @param {VertexKey} v2 - The parameter `v2` is a `VertexKey`, which represents the identifier of the second vertex in a
+     * graph edge.
+     * @param {number} [weight] - The weight parameter is an optional number that represents the weight of the edge.
+     * @param {V} [val] - The "val" parameter is an optional parameter of type V. It is used to store a value associated
+     * with the edge.
+     */
+    constructor(v1: VertexKey, v2: VertexKey, weight?: number, val?: V);
+    private _vertices;
+    get vertices(): [VertexKey, VertexKey];
+    set vertices(v: [VertexKey, VertexKey]);
+}
+export declare class UndirectedGraph<V extends UndirectedVertex<any> = UndirectedVertex, E extends UndirectedEdge<any> = UndirectedEdge> extends AbstractGraph<V, E> implements IUNDirectedGraph<V, E> {
+    /**
+     * The constructor initializes a new Map object to store edges.
+     */
+    constructor();
+    protected _edges: Map<V, E[]>;
+    get edges(): Map<V, E[]>;
+    /**
+     * The function creates a new vertex with an optional value and returns it.
+     * @param {VertexKey} key - The `key` parameter is the unique identifier for the vertex. It is used to distinguish one
+     * vertex from another in the graph.
+     * @param [val] - The `val` parameter is an optional value that can be assigned to the vertex. If a value is provided,
+     * it will be used as the value of the vertex. If no value is provided, the `key` parameter will be used as the value of
+     * the vertex.
+     * @returns The method is returning a new instance of the `UndirectedVertex` class, casted as type `V`.
+     */
+    createVertex(key: VertexKey, val?: V['val']): V;
+    /**
+     * The function creates an undirected edge between two vertices with an optional weight and value.
+     * @param {VertexKey} v1 - The parameter `v1` represents the first vertex of the edge.
+     * @param {VertexKey} v2 - The parameter `v2` represents the second vertex of the edge.
+     * @param {number} [weight] - The `weight` parameter is an optional number that represents the weight of the edge. If
+     * no weight is provided, it defaults to 1.
+     * @param [val] - The `val` parameter is an optional value that can be assigned to the edge. It can be of any type and
+     * is used to store additional information or data associated with the edge.
+     * @returns a new instance of the `UndirectedEdge` class, which is casted as type `E`.
+     */
+    createEdge(v1: VertexKey, v2: VertexKey, weight?: number, val?: E['val']): E;
+    /**
+     * The function `getEdge` returns the first edge that connects two vertices, or null if no such edge exists.
+     * @param {V | null | VertexKey} v1 - The parameter `v1` represents a vertex or vertex ID. It can be of type `V` (vertex
+     * object), `null`, or `VertexKey` (a string or number representing the ID of a vertex).
+     * @param {V | null | VertexKey} v2 - The parameter `v2` represents a vertex or vertex ID. It can be of type `V` (vertex
+     * object), `null`, or `VertexKey` (vertex ID).
+     * @returns an edge (E) or null.
+     */
+    getEdge(v1: V | null | VertexKey, v2: V | null | VertexKey): E | null;
+    /**
+     * The function removes an edge between two vertices in a graph and returns the removed edge.
+     * @param {V | VertexKey} v1 - The parameter `v1` represents either a vertex object (`V`) or a vertex ID (`VertexKey`).
+     * @param {V | VertexKey} v2 - V | VertexKey - This parameter can be either a vertex object (V) or a vertex ID
+     * (VertexKey). It represents the second vertex of the edge that needs to be removed.
+     * @returns the removed edge (E) if it exists, or null if either of the vertices (V) does not exist.
+     */
+    removeEdgeBetween(v1: V | VertexKey, v2: V | VertexKey): 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 {VertexKey | V} vertexOrKey - The parameter `vertexOrKey` can be either a `VertexKey` 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 connected to that vertex.
+     */
+    degreeOf(vertexOrKey: VertexKey | V): number;
+    /**
+     * The function returns the edges of a given vertex or vertex ID.
+     * @param {VertexKey | V} vertexOrKey - The parameter `vertexOrKey` can be either a `VertexKey` or a `V`. A `VertexKey` is a
+     * unique identifier for a vertex in a graph, while `V` represents the type of the vertex.
+     * @returns an array of edges.
+     */
+    edgesOf(vertexOrKey: VertexKey | 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 "getNeighbors" returns an array of neighboring vertices for a given vertex or vertex ID.
+     * @param {V | VertexKey} vertexOrKey - The parameter `vertexOrKey` can be either a vertex object (`V`) or a vertex ID
+     * (`VertexKey`).
+     * @returns an array of vertices (V[]).
+     */
+    getNeighbors(vertexOrKey: V | VertexKey): V[];
+    /**
+     * The function "getEndsOfEdge" returns the vertices at the ends of an edge if the edge 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 The function `getEndsOfEdge` returns an array containing two vertices `[V, V]` if the edge exists in the
+     * graph. If the edge does not exist, it returns `null`.
+     */
+    getEndsOfEdge(edge: E): [V, V] | null;
+    /**
+     * The function adds an edge to the graph by updating the adjacency list with the vertices of the edge.
+     * @param {E} edge - The parameter "edge" is of type E, which represents an edge in a graph.
+     * @returns a boolean value.
+     */
+    protected _addEdgeOnly(edge: E): boolean;
+    /**
+     * The function sets the edges of a graph.
+     * @param v - A map where the keys are of type V and the values are arrays of type E.
+     */
+    protected _setEdges(v: Map<V, E[]>): void;
+}

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

@@ -1,15 +1,39 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UndirectedGraph = exports.UndirectedEdge = exports.UndirectedVertex = void 0;
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
 const utils_1 = require("../../utils");
 const abstract_graph_1 = require("./abstract-graph");
 class UndirectedVertex extends abstract_graph_1.AbstractVertex {
+    /**
+     * The constructor function initializes a vertex with an optional value.
+     * @param {VertexKey} key - The `key` parameter is of type `VertexKey` and represents the identifier of the vertex. It is
+     * used to uniquely identify the vertex within a graph or network.
+     * @param {V} [val] - The "val" parameter is an optional parameter of type V. It is used to initialize the value of the
+     * vertex. If no value is provided, the vertex will be initialized with a default value.
+     */
     constructor(key, val) {
         super(key, val);
     }
 }
 exports.UndirectedVertex = UndirectedVertex;
 class UndirectedEdge extends abstract_graph_1.AbstractEdge {
+    /**
+     * The constructor function creates an instance of a class with two vertex IDs, an optional weight, and an optional
+     * value.
+     * @param {VertexKey} v1 - The first vertex ID of the edge.
+     * @param {VertexKey} v2 - The parameter `v2` is a `VertexKey`, which represents the identifier of the second vertex in a
+     * graph edge.
+     * @param {number} [weight] - The weight parameter is an optional number that represents the weight of the edge.
+     * @param {V} [val] - The "val" parameter is an optional parameter of type V. It is used to store a value associated
+     * with the edge.
+     */
     constructor(v1, v2, weight, val) {
         super(weight, val);
         this._vertices = [v1, v2];
@@ -23,6 +47,9 @@ class UndirectedEdge extends abstract_graph_1.AbstractEdge {
 }
 exports.UndirectedEdge = UndirectedEdge;
 class UndirectedGraph extends abstract_graph_1.AbstractGraph {
+    /**
+     * The constructor initializes a new Map object to store edges.
+     */
     constructor() {
         super();
         this._edges = new Map();
@@ -30,12 +57,39 @@ class UndirectedGraph extends abstract_graph_1.AbstractGraph {
     get edges() {
         return this._edges;
     }
+    /**
+     * The function creates a new vertex with an optional value and returns it.
+     * @param {VertexKey} key - The `key` parameter is the unique identifier for the vertex. It is used to distinguish one
+     * vertex from another in the graph.
+     * @param [val] - The `val` parameter is an optional value that can be assigned to the vertex. If a value is provided,
+     * it will be used as the value of the vertex. If no value is provided, the `key` parameter will be used as the value of
+     * the vertex.
+     * @returns The method is returning a new instance of the `UndirectedVertex` class, casted as type `V`.
+     */
     createVertex(key, val) {
         return new UndirectedVertex(key, val !== null && val !== void 0 ? val : key);
     }
+    /**
+     * The function creates an undirected edge between two vertices with an optional weight and value.
+     * @param {VertexKey} v1 - The parameter `v1` represents the first vertex of the edge.
+     * @param {VertexKey} v2 - The parameter `v2` represents the second vertex of the edge.
+     * @param {number} [weight] - The `weight` parameter is an optional number that represents the weight of the edge. If
+     * no weight is provided, it defaults to 1.
+     * @param [val] - The `val` parameter is an optional value that can be assigned to the edge. It can be of any type and
+     * is used to store additional information or data associated with the edge.
+     * @returns a new instance of the `UndirectedEdge` class, which is casted as type `E`.
+     */
     createEdge(v1, v2, weight, val) {
         return new UndirectedEdge(v1, v2, weight !== null && weight !== void 0 ? weight : 1, val);
     }
+    /**
+     * The function `getEdge` returns the first edge that connects two vertices, or null if no such edge exists.
+     * @param {V | null | VertexKey} v1 - The parameter `v1` represents a vertex or vertex ID. It can be of type `V` (vertex
+     * object), `null`, or `VertexKey` (a string or number representing the ID of a vertex).
+     * @param {V | null | VertexKey} v2 - The parameter `v2` represents a vertex or vertex ID. It can be of type `V` (vertex
+     * object), `null`, or `VertexKey` (vertex ID).
+     * @returns an edge (E) or null.
+     */
     getEdge(v1, v2) {
         var _a;
         let edges = [];
@@ -48,6 +102,13 @@ class UndirectedGraph extends abstract_graph_1.AbstractGraph {
         }
         return edges ? edges[0] || null : null;
     }
+    /**
+     * The function removes an edge between two vertices in a graph and returns the removed edge.
+     * @param {V | VertexKey} v1 - The parameter `v1` represents either a vertex object (`V`) or a vertex ID (`VertexKey`).
+     * @param {V | VertexKey} v2 - V | VertexKey - This parameter can be either a vertex object (V) or a vertex ID
+     * (VertexKey). It represents the second vertex of the edge that needs to be removed.
+     * @returns the removed edge (E) if it exists, or null if either of the vertices (V) does not exist.
+     */
     removeEdgeBetween(v1, v2) {
         const vertex1 = this._getVertex(v1);
         const vertex2 = this._getVertex(v2);
@@ -65,9 +126,21 @@ class UndirectedGraph extends abstract_graph_1.AbstractGraph {
         }
         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.
+     */
     removeEdge(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 {VertexKey | V} vertexOrKey - The parameter `vertexOrKey` can be either a `VertexKey` 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 connected to that vertex.
+     */
     degreeOf(vertexOrKey) {
         var _a;
         const vertex = this._getVertex(vertexOrKey);
@@ -78,6 +151,12 @@ class UndirectedGraph extends abstract_graph_1.AbstractGraph {
             return 0;
         }
     }
+    /**
+     * The function returns the edges of a given vertex or vertex ID.
+     * @param {VertexKey | V} vertexOrKey - The parameter `vertexOrKey` can be either a `VertexKey` or a `V`. A `VertexKey` is a
+     * unique identifier for a vertex in a graph, while `V` represents the type of the vertex.
+     * @returns an array of edges.
+     */
     edgesOf(vertexOrKey) {
         const vertex = this._getVertex(vertexOrKey);
         if (vertex) {
@@ -87,6 +166,10 @@ class UndirectedGraph extends abstract_graph_1.AbstractGraph {
             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[]`.
+     */
     edgeSet() {
         const edgeSet = new Set();
         this._edges.forEach(edges => {
@@ -96,6 +179,12 @@ class UndirectedGraph extends abstract_graph_1.AbstractGraph {
         });
         return [...edgeSet];
     }
+    /**
+     * The function "getNeighbors" returns an array of neighboring vertices for a given vertex or vertex ID.
+     * @param {V | VertexKey} vertexOrKey - The parameter `vertexOrKey` can be either a vertex object (`V`) or a vertex ID
+     * (`VertexKey`).
+     * @returns an array of vertices (V[]).
+     */
     getNeighbors(vertexOrKey) {
         const neighbors = [];
         const vertex = this._getVertex(vertexOrKey);
@@ -110,6 +199,13 @@ class UndirectedGraph extends abstract_graph_1.AbstractGraph {
         }
         return neighbors;
     }
+    /**
+     * The function "getEndsOfEdge" returns the vertices at the ends of an edge if the edge 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 The function `getEndsOfEdge` returns an array containing two vertices `[V, V]` if the edge exists in the
+     * graph. If the edge does not exist, it returns `null`.
+     */
     getEndsOfEdge(edge) {
         if (!this.hasEdge(edge.vertices[0], edge.vertices[1])) {
             return null;
@@ -123,6 +219,11 @@ class UndirectedGraph extends abstract_graph_1.AbstractGraph {
             return null;
         }
     }
+    /**
+     * The function adds an edge to the graph by updating the adjacency list with the vertices of the edge.
+     * @param {E} edge - The parameter "edge" is of type E, which represents an edge in a graph.
+     * @returns a boolean value.
+     */
     _addEdgeOnly(edge) {
         for (const end of edge.vertices) {
             const endVertex = this._getVertex(end);
@@ -140,6 +241,10 @@ class UndirectedGraph extends abstract_graph_1.AbstractGraph {
         }
         return true;
     }
+    /**
+     * The function sets the edges of a graph.
+     * @param v - A map where the keys are of type V and the values are arrays of type E.
+     */
     _setEdges(v) {
         this._edges = v;
     }

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

@@ -1 +1 @@
-{"version":3,"file":"undirected-graph.js","sourceRoot":"","sources":["../../../src/data-structures/graph/undirected-graph.ts"],"names":[],"mappings":";;;AAOA,uCAAwC;AACxC,qDAA6E;AAI7E,MAAa,gBAA0B,SAAQ,+BAAiB;IAQ9D,YAAY,GAAc,EAAE,GAAO;QACjC,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAClB,CAAC;CACF;AAXD,4CAWC;AAED,MAAa,cAA2B,SAAQ,6BAAe;IAW7D,YAAY,EAAa,EAAE,EAAa,EAAE,MAAe,EAAE,GAAO;QAChE,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACnB,IAAI,CAAC,SAAS,GAAG,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAC5B,CAAC;IAID,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,IAAI,QAAQ,CAAC,CAAyB;QACpC,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;IACrB,CAAC;CACF;AAzBD,wCAyBC;AAED,MAAa,eAIX,SAAQ,8BAAmB;IAM3B;QACE,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,MAAM,GAAG,IAAI,GAAG,EAAU,CAAC;IAClC,CAAC;IAID,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAWQ,YAAY,CAAC,GAAc,EAAE,GAAc;QAClD,OAAO,IAAI,gBAAgB,CAAC,GAAG,EAAE,GAAG,aAAH,GAAG,cAAH,GAAG,GAAI,GAAG,CAAM,CAAC;IACpD,CAAC;IAYQ,UAAU,CAAC,EAAa,EAAE,EAAa,EAAE,MAAe,EAAE,GAAc;QAC/E,OAAO,IAAI,cAAc,CAAC,EAAE,EAAE,EAAE,EAAE,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,CAAC,EAAE,GAAG,CAAM,CAAC;IAC3D,CAAC;IAUD,OAAO,CAAC,EAAwB,EAAE,EAAwB;;QACxD,IAAI,KAAK,GAAoB,EAAE,CAAC;QAEhC,IAAI,EAAE,KAAK,IAAI,IAAI,EAAE,KAAK,IAAI,EAAE;YAC9B,MAAM,OAAO,GAAa,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;YAC9C,MAAM,OAAO,GAAa,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;YAE9C,IAAI,OAAO,IAAI,OAAO,EAAE;gBACtB,KAAK,GAAG,MAAA,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,0CAAE,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;aACjF;SACF;QAED,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;IACzC,CAAC;IASD,iBAAiB,CAAC,EAAiB,EAAE,EAAiB;QACpD,MAAM,OAAO,GAAa,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QAC9C,MAAM,OAAO,GAAa,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QAE9C,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,EAAE;YACxB,OAAO,IAAI,CAAC;SACb;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACzC,IAAI,OAAO,GAAa,IAAI,CAAC;QAC7B,IAAI,OAAO,EAAE;YACX,OAAO,GAAG,IAAA,mBAAW,EAAI,OAAO,EAAE,CAAC,CAAI,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;SAC1F;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACzC,IAAI,OAAO,EAAE;YACX,IAAA,mBAAW,EAAI,OAAO,EAAE,CAAC,CAAI,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;SACrE;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAOD,UAAU,CAAC,IAAO;QAChB,OAAO,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IACpE,CAAC;IASD,QAAQ,CAAC,WAA0B;;QACjC,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC5C,IAAI,MAAM,EAAE;YACV,OAAO,CAAA,MAAA,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,0CAAE,MAAM,KAAI,CAAC,CAAC;SAC7C;aAAM;YACL,OAAO,CAAC,CAAC;SACV;IACH,CAAC;IAQD,OAAO,CAAC,WAA0B;QAChC,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC5C,IAAI,MAAM,EAAE;YACV,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;SACtC;aAAM;YACL,OAAO,EAAE,CAAC;SACX;IACH,CAAC;IAMD,OAAO;QACL,MAAM,OAAO,GAAW,IAAI,GAAG,EAAE,CAAC;QAClC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YAC1B,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;gBACnB,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACpB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,GAAG,OAAO,CAAC,CAAC;IACtB,CAAC;IAQD,YAAY,CAAC,WAA0B;QACrC,MAAM,SAAS,GAAQ,EAAE,CAAC;QAC1B,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC5C,IAAI,MAAM,EAAE;YACV,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAC3C,KAAK,MAAM,IAAI,IAAI,aAAa,EAAE;gBAChC,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACjF,IAAI,QAAQ,EAAE;oBACZ,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;iBAC1B;aACF;SACF;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IASD,aAAa,CAAC,IAAO;QACnB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE;YACrD,OAAO,IAAI,CAAC;SACb;QACD,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7C,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7C,IAAI,EAAE,IAAI,EAAE,EAAE;YACZ,OAAO,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;SACjB;aAAM;YACL,OAAO,IAAI,CAAC;SACb;IACH,CAAC;IAOS,YAAY,CAAC,IAAO;QAC5B,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,QAAQ,EAAE;YAC/B,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;YACvC,IAAI,SAAS,KAAK,IAAI;gBAAE,OAAO,KAAK,CAAC;YACrC,IAAI,SAAS,EAAE;gBACb,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;gBACzC,IAAI,KAAK,EAAE;oBACT,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBAClB;qBAAM;oBACL,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;iBACpC;aACF;SACF;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAMS,SAAS,CAAC,CAAc;QAChC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;IAClB,CAAC;CACF;AA7ND,0CA6NC"}
+{"version":3,"file":"undirected-graph.js","sourceRoot":"","sources":["../../../src/data-structures/graph/undirected-graph.ts"],"names":[],"mappings":";;;AAAA;;;;;;GAMG;AACH,uCAAwC;AACxC,qDAA6E;AAI7E,MAAa,gBAA0B,SAAQ,+BAAiB;IAC9D;;;;;;OAMG;IACH,YAAY,GAAc,EAAE,GAAO;QACjC,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAClB,CAAC;CACF;AAXD,4CAWC;AAED,MAAa,cAA2B,SAAQ,6BAAe;IAC7D;;;;;;;;;OASG;IACH,YAAY,EAAa,EAAE,EAAa,EAAE,MAAe,EAAE,GAAO;QAChE,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACnB,IAAI,CAAC,SAAS,GAAG,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAC5B,CAAC;IAID,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,IAAI,QAAQ,CAAC,CAAyB;QACpC,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;IACrB,CAAC;CACF;AAzBD,wCAyBC;AAED,MAAa,eAIX,SAAQ,8BAAmB;IAG3B;;OAEG;IACH;QACE,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,MAAM,GAAG,IAAI,GAAG,EAAU,CAAC;IAClC,CAAC;IAID,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;;;;;;OAQG;IACM,YAAY,CAAC,GAAc,EAAE,GAAc;QAClD,OAAO,IAAI,gBAAgB,CAAC,GAAG,EAAE,GAAG,aAAH,GAAG,cAAH,GAAG,GAAI,GAAG,CAAM,CAAC;IACpD,CAAC;IAED;;;;;;;;;OASG;IACM,UAAU,CAAC,EAAa,EAAE,EAAa,EAAE,MAAe,EAAE,GAAc;QAC/E,OAAO,IAAI,cAAc,CAAC,EAAE,EAAE,EAAE,EAAE,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,CAAC,EAAE,GAAG,CAAM,CAAC;IAC3D,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,EAAwB,EAAE,EAAwB;;QACxD,IAAI,KAAK,GAAoB,EAAE,CAAC;QAEhC,IAAI,EAAE,KAAK,IAAI,IAAI,EAAE,KAAK,IAAI,EAAE;YAC9B,MAAM,OAAO,GAAa,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;YAC9C,MAAM,OAAO,GAAa,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;YAE9C,IAAI,OAAO,IAAI,OAAO,EAAE;gBACtB,KAAK,GAAG,MAAA,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,0CAAE,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;aACjF;SACF;QAED,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;IACzC,CAAC;IAED;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAiB,EAAE,EAAiB;QACpD,MAAM,OAAO,GAAa,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QAC9C,MAAM,OAAO,GAAa,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QAE9C,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,EAAE;YACxB,OAAO,IAAI,CAAC;SACb;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACzC,IAAI,OAAO,GAAa,IAAI,CAAC;QAC7B,IAAI,OAAO,EAAE;YACX,OAAO,GAAG,IAAA,mBAAW,EAAI,OAAO,EAAE,CAAC,CAAI,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;SAC1F;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACzC,IAAI,OAAO,EAAE;YACX,IAAA,mBAAW,EAAI,OAAO,EAAE,CAAC,CAAI,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;SACrE;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,IAAO;QAChB,OAAO,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,WAA0B;;QACjC,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC5C,IAAI,MAAM,EAAE;YACV,OAAO,CAAA,MAAA,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,0CAAE,MAAM,KAAI,CAAC,CAAC;SAC7C;aAAM;YACL,OAAO,CAAC,CAAC;SACV;IACH,CAAC;IAED;;;;;OAKG;IACH,OAAO,CAAC,WAA0B;QAChC,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC5C,IAAI,MAAM,EAAE;YACV,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;SACtC;aAAM;YACL,OAAO,EAAE,CAAC;SACX;IACH,CAAC;IAED;;;OAGG;IACH,OAAO;QACL,MAAM,OAAO,GAAW,IAAI,GAAG,EAAE,CAAC;QAClC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YAC1B,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;gBACnB,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACpB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,GAAG,OAAO,CAAC,CAAC;IACtB,CAAC;IAED;;;;;OAKG;IACH,YAAY,CAAC,WAA0B;QACrC,MAAM,SAAS,GAAQ,EAAE,CAAC;QAC1B,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC5C,IAAI,MAAM,EAAE;YACV,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAC3C,KAAK,MAAM,IAAI,IAAI,aAAa,EAAE;gBAChC,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACjF,IAAI,QAAQ,EAAE;oBACZ,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;iBAC1B;aACF;SACF;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;;OAMG;IACH,aAAa,CAAC,IAAO;QACnB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE;YACrD,OAAO,IAAI,CAAC;SACb;QACD,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7C,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7C,IAAI,EAAE,IAAI,EAAE,EAAE;YACZ,OAAO,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;SACjB;aAAM;YACL,OAAO,IAAI,CAAC;SACb;IACH,CAAC;IAED;;;;OAIG;IACO,YAAY,CAAC,IAAO;QAC5B,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,QAAQ,EAAE;YAC/B,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;YACvC,IAAI,SAAS,KAAK,IAAI;gBAAE,OAAO,KAAK,CAAC;YACrC,IAAI,SAAS,EAAE;gBACb,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;gBACzC,IAAI,KAAK,EAAE;oBACT,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBAClB;qBAAM;oBACL,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;iBACpC;aACF;SACF;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACO,SAAS,CAAC,CAAc;QAChC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;IAClB,CAAC;CACF;AA7ND,0CA6NC"}

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

@@ -0,0 +1,45 @@
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+export declare class CoordinateMap<V> extends Map<any, V> {
+    constructor(joint?: string);
+    protected _joint: string;
+    get 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;
+    protected _setJoint(v: string): void;
+}

package/dist/data-structures/hash/coordinate-map.js

@@ -1,6 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CoordinateMap = void 0;
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
 class CoordinateMap extends Map {
     constructor(joint) {
         super();
@@ -11,15 +18,43 @@ class CoordinateMap extends Map {
     get joint() {
         return this._joint;
     }
+    /**
+     * 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) {
         return super.has(key.join(this._joint));
     }
+    /**
+     * 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, value) {
         return super.set(key.join(this._joint), value);
     }
+    /**
+     * 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) {
         return super.get(key.join(this._joint));
     }
+    /**
+     * 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) {
         return super.delete(key.join(this._joint));
     }

package/dist/data-structures/hash/coordinate-map.js.map

@@ -1 +1 @@
-{"version":3,"file":"coordinate-map.js","sourceRoot":"","sources":["../../../src/data-structures/hash/coordinate-map.ts"],"names":[],"mappings":";;;AAOA,MAAa,aAAiB,SAAQ,GAAW;IAC/C,YAAY,KAAc;QACxB,KAAK,EAAE,CAAC;QAIA,WAAM,GAAG,GAAG,CAAC;QAHrB,IAAI,KAAK,KAAK,SAAS;YAAE,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IAC/C,CAAC;IAID,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IASQ,GAAG,CAAC,GAAa;QACxB,OAAO,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAC1C,CAAC;IAUQ,GAAG,CAAC,GAAa,EAAE,KAAQ;QAClC,OAAO,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,CAAC;IACjD,CAAC;IAQQ,GAAG,CAAC,GAAa;QACxB,OAAO,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAC1C,CAAC;IASQ,MAAM,CAAC,GAAa;QAC3B,OAAO,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAC7C,CAAC;IAES,SAAS,CAAC,CAAS;QAC3B,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;IAClB,CAAC;CACF;AA3DD,sCA2DC"}
+{"version":3,"file":"coordinate-map.js","sourceRoot":"","sources":["../../../src/data-structures/hash/coordinate-map.ts"],"names":[],"mappings":";;;AAAA;;;;;;GAMG;AACH,MAAa,aAAiB,SAAQ,GAAW;IAC/C,YAAY,KAAc;QACxB,KAAK,EAAE,CAAC;QAIA,WAAM,GAAG,GAAG,CAAC;QAHrB,IAAI,KAAK,KAAK,SAAS;YAAE,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IAC/C,CAAC;IAID,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;;;;OAMG;IACM,GAAG,CAAC,GAAa;QACxB,OAAO,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;;;OAOG;IACM,GAAG,CAAC,GAAa,EAAE,KAAQ;QAClC,OAAO,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,CAAC;IACjD,CAAC;IAED;;;;;OAKG;IACM,GAAG,CAAC,GAAa;QACxB,OAAO,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;;OAMG;IACM,MAAM,CAAC,GAAa;QAC3B,OAAO,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAC7C,CAAC;IAES,SAAS,CAAC,CAAS;QAC3B,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;IAClB,CAAC;CACF;AA3DD,sCA2DC"}

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

@@ -0,0 +1,37 @@
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+export declare class CoordinateSet extends Set<any> {
+    constructor(joint?: string);
+    protected _joint: string;
+    get joint(): string;
+    /**
+     * The "has" function overrides the "has" method of the superclass and checks if a value exists in an array after
+     * joining its elements with a specified separator.
+     * @param {number[]} value - The parameter "value" is an array of numbers.
+     * @returns The overridden `has` method is returning the result of calling the `has` method of the superclass, passing
+     * in the joined value as an argument.
+     */
+    has(value: number[]): boolean;
+    /**
+     * The "add" function overrides the parent class's "add" function by joining the elements of the input array with a
+     * specified delimiter before calling the parent class's "add" function.
+     * @param {number[]} value - An array of numbers
+     * @returns The overridden `add` method is returning the result of calling the `add` method of the superclass
+     * (`super.add`) with the joined string representation of the `value` array (`value.join(this._joint)`).
+     */
+    add(value: number[]): this;
+    /**
+     * The function overrides the delete method and deletes an element from a Set by joining the elements of the input
+     * array with a specified joint and then calling the delete method of the parent class.
+     * @param {number[]} value - An array of numbers
+     * @returns The `delete` method is returning the result of calling the `delete` method of the superclass, with the
+     * `value` array joined together using the `_joint` property.
+     */
+    delete(value: number[]): boolean;
+    protected _setJoint(v: string): void;
+}

package/dist/data-structures/hash/coordinate-set.js

@@ -1,6 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CoordinateSet = void 0;
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
 class CoordinateSet extends Set {
     constructor(joint) {
         super();
@@ -11,12 +18,33 @@ class CoordinateSet extends Set {
     get joint() {
         return this._joint;
     }
+    /**
+     * The "has" function overrides the "has" method of the superclass and checks if a value exists in an array after
+     * joining its elements with a specified separator.
+     * @param {number[]} value - The parameter "value" is an array of numbers.
+     * @returns The overridden `has` method is returning the result of calling the `has` method of the superclass, passing
+     * in the joined value as an argument.
+     */
     has(value) {
         return super.has(value.join(this._joint));
     }
+    /**
+     * The "add" function overrides the parent class's "add" function by joining the elements of the input array with a
+     * specified delimiter before calling the parent class's "add" function.
+     * @param {number[]} value - An array of numbers
+     * @returns The overridden `add` method is returning the result of calling the `add` method of the superclass
+     * (`super.add`) with the joined string representation of the `value` array (`value.join(this._joint)`).
+     */
     add(value) {
         return super.add(value.join(this._joint));
     }
+    /**
+     * The function overrides the delete method and deletes an element from a Set by joining the elements of the input
+     * array with a specified joint and then calling the delete method of the parent class.
+     * @param {number[]} value - An array of numbers
+     * @returns The `delete` method is returning the result of calling the `delete` method of the superclass, with the
+     * `value` array joined together using the `_joint` property.
+     */
     delete(value) {
         return super.delete(value.join(this._joint));
     }

package/dist/data-structures/hash/coordinate-set.js.map

@@ -1 +1 @@
-{"version":3,"file":"coordinate-set.js","sourceRoot":"","sources":["../../../src/data-structures/hash/coordinate-set.ts"],"names":[],"mappings":";;;AAOA,MAAa,aAAc,SAAQ,GAAQ;IACzC,YAAY,KAAc;QACxB,KAAK,EAAE,CAAC;QAIA,WAAM,GAAG,GAAG,CAAC;QAHrB,IAAI,KAAK,KAAK,SAAS;YAAE,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IAC/C,CAAC;IAID,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IASQ,GAAG,CAAC,KAAe;QAC1B,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAC5C,CAAC;IASQ,GAAG,CAAC,KAAe;QAC1B,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAC5C,CAAC;IASQ,MAAM,CAAC,KAAe;QAC7B,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAC/C,CAAC;IAES,SAAS,CAAC,CAAS;QAC3B,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;IAClB,CAAC;CACF;AAhDD,sCAgDC"}
+{"version":3,"file":"coordinate-set.js","sourceRoot":"","sources":["../../../src/data-structures/hash/coordinate-set.ts"],"names":[],"mappings":";;;AAAA;;;;;;GAMG;AACH,MAAa,aAAc,SAAQ,GAAQ;IACzC,YAAY,KAAc;QACxB,KAAK,EAAE,CAAC;QAIA,WAAM,GAAG,GAAG,CAAC;QAHrB,IAAI,KAAK,KAAK,SAAS;YAAE,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IAC/C,CAAC;IAID,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;;;;OAMG;IACM,GAAG,CAAC,KAAe;QAC1B,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;OAMG;IACM,GAAG,CAAC,KAAe;QAC1B,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;OAMG;IACM,MAAM,CAAC,KAAe;QAC7B,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAC/C,CAAC;IAES,SAAS,CAAC,CAAS;QAC3B,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;IAClB,CAAC;CACF;AAhDD,sCAgDC"}