data-structure-typed 2.0.5 → 2.1.0

package/dist/cjs/data-structures/graph/map-graph.d.ts

@@ -1,47 +1,35 @@
+/**
+ * data-structure-typed
+ *
+ * @author Pablo Zeng
+ * @copyright Copyright (c) 2022 Pablo Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
 import type { MapGraphCoordinate, VertexKey } from '../../types';
 import { DirectedEdge, DirectedGraph, DirectedVertex } from './directed-graph';
 export declare class MapVertex<V = any> extends DirectedVertex<V> {
     lat: number;
     long: number;
-    /**
-     * 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} [value] - The "value" parameter is an optional value of type V. It is not required to be provided when
-     * creating an instance of the class.
-     */
     constructor(key: VertexKey, value: V, lat: number, long: number);
 }
 export declare class MapEdge<E = any> extends DirectedEdge<E> {
-    /**
-     * 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 {E} [value] - The "value" parameter is an optional parameter of type E. It is used to store additional
-     * information or data associated with the edge.
-     */
     constructor(src: VertexKey, dest: VertexKey, weight?: number, value?: E);
 }
 /**
- *
+ * Directed graph variant carrying geospatial coordinates.
+ * @template V - Vertex value type.
+ * @template E - Edge value type.
+ * @template VO - Concrete vertex class (MapVertex<V>).
+ * @template EO - Concrete edge class (MapEdge<E>).
+ * @remarks Time O(1), Space O(1)
+ * @example examples will be generated by unit test
  */
 export declare class MapGraph<V = any, E = any, VO extends MapVertex<V> = MapVertex<V>, EO extends MapEdge<E> = MapEdge<E>> extends DirectedGraph<V, E, VO, EO> {
     /**
-     * The constructor function initializes the originCoord and bottomRight properties of a MapGraphCoordinate object.
-     * @param {MapGraphCoordinate} originCoord - The `originCoord` 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`.
+     * Construct a MapGraph.
+     * @param originCoord - Origin coordinate `[lat, long]` used as default.
+     * @param bottomRight - Optional bottom-right coordinate for bounding boxes.
+     * @remarks Time O(1), Space O(1)
      */
     constructor(originCoord: MapGraphCoordinate, bottomRight?: MapGraphCoordinate);
     protected _originCoord: MapGraphCoordinate;
@@ -49,36 +37,42 @@ export declare class MapGraph<V = any, E = any, VO extends MapVertex<V> = MapVer
     protected _bottomRight: MapGraphCoordinate | undefined;
     get bottomRight(): MapGraphCoordinate | undefined;
     /**
-     * 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 [value] - The `value` parameter is an optional value that can be assigned to the `value` property of the vertex. It
-     * is of type `V`, which means it should be of the same type as the `value` property of the vertex class `VO`.
-     * @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 `VO`.
+     * Create a map vertex with optional coordinates.
+     * @param key - Vertex identifier.
+     * @param value - Optional payload.
+     * @param lat - Latitude (defaults to `originCoord[0]`).
+     * @param long - Longitude (defaults to `originCoord[1]`).
+     * @returns MapVertex instance.
+     * @remarks Time O(1), Space O(1)
      */
     createVertex(key: VertexKey, value?: V, lat?: number, long?: number): VO;
     /**
-     * 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 [value] - The `value` 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, cast as type `EO`.
+     * Create a map edge (directed) with optional weight/value.
+     * @param src - Source key.
+     * @param dest - Destination key.
+     * @param weight - Edge weight.
+     * @param value - Edge payload.
+     * @returns MapEdge instance.
+     * @remarks Time O(1), Space O(1)
      */
     createEdge(src: VertexKey, dest: VertexKey, weight?: number, value?: E): EO;
     /**
-     * The override function is used to override the default behavior of a function.
-     * In this case, we are overriding the clone() function from Graph&lt;V, E&gt;.
-     * The clone() function returns a new graph that is an exact copy of the original graph.
-     *
-     * @return A mapgraph&lt;v, e, vo, eo&gt;
+     * Deep clone as the same concrete class.
+     * @returns A new graph of the same concrete class (`this` type).
+     * @remarks Time O(V + E), Space O(V + E)
+     */
+    clone(): this;
+    /**
+     * Include `originCoord` and `bottomRight` so `clone()/filter()` preserve geospatial settings.
+     * @returns Options bag extending super snapshot.
+     * @remarks Time O(1), Space O(1)
+     */
+    protected _snapshotOptions(): Record<string, unknown>;
+    /**
+     * Re-create a same-species MapGraph instance from snapshot options.
+     * @param options - Snapshot options providing `originCoord`/`bottomRight`.
+     * @returns Empty MapGraph instance of `this` type.
+     * @remarks Time O(1), Space O(1)
      */
-    clone(): MapGraph<V, E, VO, EO>;
+    protected _createInstance(options?: Partial<Record<string, unknown>>): this;
 }

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

@@ -1,20 +1,15 @@
 "use strict";
+/**
+ * data-structure-typed
+ *
+ * @author Pablo Zeng
+ * @copyright Copyright (c) 2022 Pablo Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
 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} [value] - The "value" parameter is an optional value of type V. It is not required to be provided when
-     * creating an instance of the class.
-     */
     constructor(key, value, lat, long) {
         super(key, value);
         this.lat = lat;
@@ -23,33 +18,26 @@ 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 {E} [value] - The "value" parameter is an optional parameter of type E. It is used to store additional
-     * information or data associated with the edge.
-     */
     constructor(src, dest, weight, value) {
         super(src, dest, weight, value);
     }
 }
 exports.MapEdge = MapEdge;
 /**
- *
+ * Directed graph variant carrying geospatial coordinates.
+ * @template V - Vertex value type.
+ * @template E - Edge value type.
+ * @template VO - Concrete vertex class (MapVertex<V>).
+ * @template EO - Concrete edge class (MapEdge<E>).
+ * @remarks Time O(1), Space O(1)
+ * @example examples will be generated by unit test
  */
 class MapGraph extends directed_graph_1.DirectedGraph {
     /**
-     * The constructor function initializes the originCoord and bottomRight properties of a MapGraphCoordinate object.
-     * @param {MapGraphCoordinate} originCoord - The `originCoord` 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`.
+     * Construct a MapGraph.
+     * @param originCoord - Origin coordinate `[lat, long]` used as default.
+     * @param bottomRight - Optional bottom-right coordinate for bounding boxes.
+     * @remarks Time O(1), Space O(1)
      */
     constructor(originCoord, bottomRight) {
         super();
@@ -64,47 +52,56 @@ class MapGraph extends directed_graph_1.DirectedGraph {
         return this._bottomRight;
     }
     /**
-     * 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 [value] - The `value` parameter is an optional value that can be assigned to the `value` property of the vertex. It
-     * is of type `V`, which means it should be of the same type as the `value` property of the vertex class `VO`.
-     * @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 `VO`.
+     * Create a map vertex with optional coordinates.
+     * @param key - Vertex identifier.
+     * @param value - Optional payload.
+     * @param lat - Latitude (defaults to `originCoord[0]`).
+     * @param long - Longitude (defaults to `originCoord[1]`).
+     * @returns MapVertex instance.
+     * @remarks Time O(1), Space O(1)
      */
     createVertex(key, value, lat = this.originCoord[0], long = this.originCoord[1]) {
         return new MapVertex(key, value, lat, long);
     }
     /**
-     * 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 [value] - The `value` 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, cast as type `EO`.
+     * Create a map edge (directed) with optional weight/value.
+     * @param src - Source key.
+     * @param dest - Destination key.
+     * @param weight - Edge weight.
+     * @param value - Edge payload.
+     * @returns MapEdge instance.
+     * @remarks Time O(1), Space O(1)
      */
     createEdge(src, dest, weight, value) {
         return new MapEdge(src, dest, weight, value);
     }
     /**
-     * The override function is used to override the default behavior of a function.
-     * In this case, we are overriding the clone() function from Graph&lt;V, E&gt;.
-     * The clone() function returns a new graph that is an exact copy of the original graph.
-     *
-     * @return A mapgraph&lt;v, e, vo, eo&gt;
+     * Deep clone as the same concrete class.
+     * @returns A new graph of the same concrete class (`this` type).
+     * @remarks Time O(V + E), Space O(V + E)
      */
     clone() {
-        const cloned = new MapGraph(this.originCoord, this.bottomRight);
-        cloned.vertexMap = new Map(this.vertexMap);
-        cloned.inEdgeMap = new Map(this.inEdgeMap);
-        cloned.outEdgeMap = new Map(this.outEdgeMap);
-        return cloned;
+        return super.clone();
+    }
+    /**
+     * Include `originCoord` and `bottomRight` so `clone()/filter()` preserve geospatial settings.
+     * @returns Options bag extending super snapshot.
+     * @remarks Time O(1), Space O(1)
+     */
+    _snapshotOptions() {
+        return Object.assign(Object.assign({}, super._snapshotOptions()), { originCoord: this.originCoord, bottomRight: this.bottomRight });
+    }
+    /**
+     * Re-create a same-species MapGraph instance from snapshot options.
+     * @param options - Snapshot options providing `originCoord`/`bottomRight`.
+     * @returns Empty MapGraph instance of `this` type.
+     * @remarks Time O(1), Space O(1)
+     */
+    _createInstance(options) {
+        const { originCoord, bottomRight } = (options || {});
+        const oc = (originCoord !== null && originCoord !== void 0 ? originCoord : this.originCoord);
+        const br = (bottomRight !== null && bottomRight !== void 0 ? bottomRight : this.bottomRight);
+        return new MapGraph(oc, br);
     }
 }
 exports.MapGraph = MapGraph;

package/dist/cjs/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,qDAA+E;AAE/E,MAAa,SAAmB,SAAQ,+BAAiB;IAIvD;;;;;;;;;;;OAWG;IACH,YAAY,GAAc,EAAE,KAAQ,EAAE,GAAW,EAAE,IAAY;QAC7D,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAClB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AArBD,8BAqBC;AAED,MAAa,OAAiB,SAAQ,6BAAe;IACnD;;;;;;;;;OASG;IACH,YAAY,GAAc,EAAE,IAAe,EAAE,MAAe,EAAE,KAAS;QACrE,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IAClC,CAAC;CACF;AAdD,0BAcC;AAED;;GAEG;AACH,MAAa,QAKX,SAAQ,8BAA2B;IACnC;;;;;;;;OAQG;IACH,YAAY,WAA+B,EAAE,WAAgC;QAC3E,KAAK,EAAE,CAAC;QAKA,iBAAY,GAAuB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAJlD,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAChC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IAClC,CAAC;IAID,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAID,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED;;;;;;;;;;OAUG;IACM,YAAY,CACnB,GAAc,EACd,KAAS,EACT,MAAc,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,EACjC,OAAe,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;QAElC,OAAO,IAAI,SAAS,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,CAAO,CAAC;IACpD,CAAC;IAED;;;;;;;;;;;OAWG;IACM,UAAU,CAAC,GAAc,EAAE,IAAe,EAAE,MAAe,EAAE,KAAS;QAC7E,OAAO,IAAI,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAO,CAAC;IACrD,CAAC;IAED;;;;;;OAMG;IACM,KAAK;QACZ,MAAM,MAAM,GAAG,IAAI,QAAQ,CAAe,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAC9E,MAAM,CAAC,SAAS,GAAG,IAAI,GAAG,CAAgB,IAAI,CAAC,SAAS,CAAC,CAAC;QAC1D,MAAM,CAAC,SAAS,GAAG,IAAI,GAAG,CAAW,IAAI,CAAC,SAAS,CAAC,CAAC;QACrD,MAAM,CAAC,UAAU,GAAG,IAAI,GAAG,CAAW,IAAI,CAAC,UAAU,CAAC,CAAC;QACvD,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAnFD,4BAmFC"}
+{"version":3,"file":"map-graph.js","sourceRoot":"","sources":["../../../../src/data-structures/graph/map-graph.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;AAGH,qDAA+E;AAE/E,MAAa,SAAmB,SAAQ,+BAAiB;IAIvD,YAAY,GAAc,EAAE,KAAQ,EAAE,GAAW,EAAE,IAAY;QAC7D,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAClB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AATD,8BASC;AAED,MAAa,OAAiB,SAAQ,6BAAe;IACnD,YAAY,GAAc,EAAE,IAAe,EAAE,MAAe,EAAE,KAAS;QACrE,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IAClC,CAAC;CACF;AAJD,0BAIC;AAED;;;;;;;;GAQG;AACH,MAAa,QAKX,SAAQ,8BAA2B;IACnC;;;;;OAKG;IACH,YAAY,WAA+B,EAAE,WAAgC;QAC3E,KAAK,EAAE,CAAC;QAKA,iBAAY,GAAuB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAJlD,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAChC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IAClC,CAAC;IAID,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAID,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED;;;;;;;;OAQG;IACM,YAAY,CACnB,GAAc,EACd,KAAS,EACT,MAAc,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,EACjC,OAAe,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;QAElC,OAAO,IAAI,SAAS,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,CAAO,CAAC;IACpD,CAAC;IAED;;;;;;;;OAQG;IACM,UAAU,CAAC,GAAc,EAAE,IAAe,EAAE,MAAe,EAAE,KAAS;QAC7E,OAAO,IAAI,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAO,CAAC;IACrD,CAAC;IAED;;;;OAIG;IACM,KAAK;QACZ,OAAO,KAAK,CAAC,KAAK,EAAE,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACgB,gBAAgB;QACjC,uCAAa,KAAK,CAAC,gBAAgB,EAAU,KAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,IAAG;IAChH,CAAC;IAED;;;;;OAKG;IACgB,eAAe,CAAC,OAA0C;QAC3E,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,GAAG,CAAC,OAAO,IAAI,EAAE,CAGlD,CAAC;QACF,MAAM,EAAE,GAAG,CAAC,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,IAAI,CAAC,WAAW,CAAqB,CAAC;QACjE,MAAM,EAAE,GAAG,CAAC,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,IAAI,CAAC,WAAW,CAAiC,CAAC;QAC7E,OAAO,IAAI,QAAQ,CAAe,EAAE,EAAE,EAAE,CAAS,CAAC;IACpD,CAAC;CACF;AA9FD,4BA8FC"}