data-structure-typed 0.8.18 → 1.12.9

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

@@ -1,24 +1,88 @@
-import { AbstractEdge, AbstractGraph, AbstractVertex, VertexId } from './abstract-graph';
+import { AbstractEdge, AbstractGraph, AbstractVertex } from './abstract-graph';
+import type { VertexId } from '../types';
 export declare class UndirectedVertex extends AbstractVertex {
     constructor(id: VertexId);
 }
 export declare class UndirectedEdge extends AbstractEdge {
+    constructor(v1: VertexId, v2: VertexId, weight?: number);
     private _vertices;
     get vertices(): [VertexId, VertexId];
     set vertices(v: [VertexId, VertexId]);
-    constructor(v1: VertexId, v2: VertexId, weight?: number);
 }
 export declare class UndirectedGraph<V extends UndirectedVertex, E extends UndirectedEdge> extends AbstractGraph<V, E> {
-    constructor();
     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

@@ -1,142 +1,294 @@
 "use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __values = (this && this.__values) || function(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+};
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UndirectedGraph = exports.UndirectedEdge = exports.UndirectedVertex = void 0;
-const utils_1 = require("../../utils");
-const abstract_graph_1 = require("./abstract-graph");
-class UndirectedVertex extends abstract_graph_1.AbstractVertex {
-    constructor(id) {
-        super(id);
+/**
+ * @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) {
+    __extends(UndirectedVertex, _super);
+    function UndirectedVertex(id) {
+        return _super.call(this, id) || this;
     }
-}
+    return UndirectedVertex;
+}(abstract_graph_1.AbstractVertex));
 exports.UndirectedVertex = UndirectedVertex;
-class UndirectedEdge extends abstract_graph_1.AbstractEdge {
-    get vertices() {
-        return this._vertices;
+var UndirectedEdge = /** @class */ (function (_super) {
+    __extends(UndirectedEdge, _super);
+    function UndirectedEdge(v1, v2, weight) {
+        var _this = _super.call(this, weight) || this;
+        _this._vertices = [v1, v2];
+        return _this;
     }
-    set vertices(v) {
-        this._vertices = v;
-    }
-    constructor(v1, v2, weight) {
-        super(weight);
-        this._vertices = [v1, v2];
-    }
-}
+    Object.defineProperty(UndirectedEdge.prototype, "vertices", {
+        get: function () {
+            return this._vertices;
+        },
+        set: function (v) {
+            this._vertices = v;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    return UndirectedEdge;
+}(abstract_graph_1.AbstractEdge));
 exports.UndirectedEdge = UndirectedEdge;
-class UndirectedGraph extends abstract_graph_1.AbstractGraph {
-    constructor() {
-        super();
-        this._edges = new Map();
+var UndirectedGraph = /** @class */ (function (_super) {
+    __extends(UndirectedGraph, _super);
+    function UndirectedGraph() {
+        var _this = _super.call(this) || this;
+        _this._edges = new Map();
+        return _this;
     }
-    getEdge(v1, v2) {
+    /**
+     * 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;
-        let edges = [];
+        var edges = [];
         if (v1 !== null && v2 !== null) {
-            const vertex1 = this.getVertex(v1);
-            const vertex2 = this.getVertex(v2);
-            if (vertex1 && vertex2) {
-                edges = (_a = this._edges.get(vertex1)) === null || _a === void 0 ? void 0 : _a.filter(e => e.vertices.includes(vertex2.id));
+            var vertex1 = this.getVertex(v1);
+            var vertex2_1 = this.getVertex(v2);
+            if (vertex1 && vertex2_1) {
+                edges = (_a = this._edges.get(vertex1)) === null || _a === void 0 ? void 0 : _a.filter(function (e) { return e.vertices.includes(vertex2_1.id); });
             }
         }
         return edges ? edges[0] || null : null;
-    }
-    addEdge(edge) {
-        for (const end of edge.vertices) {
-            const endVertex = this.getVertex(end);
-            if (endVertex === null)
-                return false;
-            if (endVertex) {
-                const edges = this._edges.get(endVertex);
-                if (edges) {
-                    edges.push(edge);
-                }
-                else {
-                    this._edges.set(endVertex, [edge]);
+    };
+    /**
+     * 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 {
+            for (var _b = __values(edge.vertices), _c = _b.next(); !_c.done; _c = _b.next()) {
+                var end = _c.value;
+                var endVertex = this.getVertex(end);
+                if (endVertex === null)
+                    return false;
+                if (endVertex) {
+                    var edges = this._edges.get(endVertex);
+                    if (edges) {
+                        edges.push(edge);
+                    }
+                    else {
+                        this._edges.set(endVertex, [edge]);
+                    }
                 }
             }
         }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
         return true;
-    }
-    removeEdgeBetween(v1, v2) {
-        const vertex1 = this.getVertex(v1);
-        const vertex2 = this.getVertex(v2);
+    };
+    /**
+     * 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);
         if (!vertex1 || !vertex2) {
             return null;
         }
-        const v1Edges = this._edges.get(vertex1);
-        let removed = null;
+        var v1Edges = this._edges.get(vertex1);
+        var removed = null;
         if (v1Edges) {
-            removed = (0, utils_1.arrayRemove)(v1Edges, e => e.vertices.includes(vertex2.id))[0] || null;
+            removed = (0, utils_1.arrayRemove)(v1Edges, function (e) { return e.vertices.includes(vertex2.id); })[0] || null;
         }
-        const v2Edges = this._edges.get(vertex2);
+        var v2Edges = this._edges.get(vertex2);
         if (v2Edges) {
-            (0, utils_1.arrayRemove)(v2Edges, e => e.vertices.includes(vertex1.id));
+            (0, utils_1.arrayRemove)(v2Edges, function (e) { return e.vertices.includes(vertex1.id); });
         }
         return removed;
-    }
-    removeEdge(edge) {
+    };
+    /**
+     * 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]);
-    }
-    degreeOf(vertexOrId) {
+    };
+    /**
+     * 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;
-        const vertex = this.getVertex(vertexOrId);
+        var vertex = this.getVertex(vertexOrId);
         if (vertex) {
             return ((_a = this._edges.get(vertex)) === null || _a === void 0 ? void 0 : _a.length) || 0;
         }
         else {
             return 0;
         }
-    }
-    edgesOf(vertexOrId) {
-        const vertex = this.getVertex(vertexOrId);
+    };
+    /**
+     * 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) {
             return this._edges.get(vertex) || [];
         }
         else {
             return [];
         }
-    }
-    edgeSet() {
-        const edgeSet = new Set();
-        this._edges.forEach(edges => {
-            edges.forEach(edge => {
+    };
+    /**
+     * 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) {
+            edges.forEach(function (edge) {
                 edgeSet.add(edge);
             });
         });
-        return [...edgeSet];
-    }
-    getEdgesOf(vertexOrId) {
-        const vertex = this.getVertex(vertexOrId);
+        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) {
             return [];
         }
         return this._edges.get(vertex) || [];
-    }
-    getNeighbors(vertexOrId) {
-        const neighbors = [];
-        const vertex = this.getVertex(vertexOrId);
+    };
+    /**
+     * 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 = [];
+        var vertex = this.getVertex(vertexOrId);
         if (vertex) {
-            const neighborEdges = this.getEdgesOf(vertex);
-            for (const edge of neighborEdges) {
-                const neighbor = this.getVertex(edge.vertices.filter(e => e !== vertex.id)[0]);
-                if (neighbor) {
-                    neighbors.push(neighbor);
+            var neighborEdges = this.getEdgesOf(vertex);
+            try {
+                for (var neighborEdges_1 = __values(neighborEdges), neighborEdges_1_1 = neighborEdges_1.next(); !neighborEdges_1_1.done; neighborEdges_1_1 = neighborEdges_1.next()) {
+                    var edge = neighborEdges_1_1.value;
+                    var neighbor = this.getVertex(edge.vertices.filter(function (e) { return e !== vertex.id; })[0]);
+                    if (neighbor) {
+                        neighbors.push(neighbor);
+                    }
+                }
+            }
+            catch (e_2_1) { e_2 = { error: e_2_1 }; }
+            finally {
+                try {
+                    if (neighborEdges_1_1 && !neighborEdges_1_1.done && (_a = neighborEdges_1.return)) _a.call(neighborEdges_1);
                 }
+                finally { if (e_2) throw e_2.error; }
             }
         }
         return neighbors;
-    }
-    getEndsOfEdge(edge) {
+    };
+    /**
+     * 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;
         }
-        const v1 = this.getVertex(edge.vertices[0]);
-        const v2 = this.getVertex(edge.vertices[1]);
+        var v1 = this.getVertex(edge.vertices[0]);
+        var v2 = this.getVertex(edge.vertices[1]);
         if (v1 && v2) {
             return [v1, v2];
         }
         else {
             return null;
         }
-    }
-}
+    };
+    return UndirectedGraph;
+}(abstract_graph_1.AbstractGraph));
 exports.UndirectedGraph = UndirectedGraph;

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

@@ -1,8 +1,40 @@
-export declare class CoordinateSet<V> extends Map<any, V> {
+/**
+ * @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;
 }

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

@@ -1,24 +1,74 @@
 "use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CoordinateSet = void 0;
-class CoordinateSet extends Map {
-    constructor(joint) {
-        super();
-        this._joint = '_';
+exports.CoordinateMap = void 0;
+/**
+ * @copyright 2030 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT
+ */
+var CoordinateMap = /** @class */ (function (_super) {
+    __extends(CoordinateMap, _super);
+    function CoordinateMap(joint) {
+        var _this = _super.call(this) || this;
+        _this._joint = '_';
         if (joint !== undefined)
-            this._joint = joint;
+            _this._joint = joint;
+        return _this;
     }
-    has(key) {
-        return super.has(key.join(this._joint));
-    }
-    set(key, value) {
-        return super.set(key.join(this._joint), value);
-    }
-    get(key) {
-        return super.get(key.join(this._joint));
-    }
-    delete(key) {
-        return super.delete(key.join(this._joint));
-    }
-}
-exports.CoordinateSet = CoordinateSet;
+    /**
+     * 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.
+     */
+    CoordinateMap.prototype.has = function (key) {
+        return _super.prototype.has.call(this, 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)`).
+     */
+    CoordinateMap.prototype.set = function (key, value) {
+        return _super.prototype.set.call(this, 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.
+     */
+    CoordinateMap.prototype.get = function (key) {
+        return _super.prototype.get.call(this, 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.
+     */
+    CoordinateMap.prototype.delete = function (key) {
+        return _super.prototype.delete.call(this, key.join(this._joint));
+    };
+    return CoordinateMap;
+}(Map));
+exports.CoordinateMap = CoordinateMap;

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

@@ -1,7 +1,32 @@
+/**
+ * @copyright 2030 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT
+ */
 export declare class CoordinateSet extends Set {
     private readonly _joint;
     constructor(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;
 }