tree-multimap-typed 2.1.1 → 2.2.0

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

@@ -1,107 +0,0 @@
-"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 {
-    constructor(key, value, lat, long) {
-        super(key, value);
-        this.lat = lat;
-        this.long = long;
-    }
-}
-exports.MapVertex = MapVertex;
-class MapEdge extends directed_graph_1.DirectedEdge {
-    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 {
-    /**
-     * 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();
-        this._originCoord = [0, 0];
-        this._originCoord = originCoord;
-        this._bottomRight = bottomRight;
-    }
-    get originCoord() {
-        return this._originCoord;
-    }
-    get bottomRight() {
-        return this._bottomRight;
-    }
-    /**
-     * 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);
-    }
-    /**
-     * 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);
-    }
-    /**
-     * 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() {
-        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/data-structures/graph/undirected-graph.d.ts

@@ -1,188 +0,0 @@
-/**
- * data-structure-typed
- *
- * @author Pablo Zeng
- * @copyright Copyright (c) 2022 Pablo Zeng <zrwusa@gmail.com>
- * @license MIT License
- */
-import type { GraphOptions, VertexKey } from '../../types';
-import { IGraph } from '../../interfaces';
-import { AbstractEdge, AbstractGraph, AbstractVertex } from './abstract-graph';
-export declare class UndirectedVertex<V = any> extends AbstractVertex<V> {
-    constructor(key: VertexKey, value?: V);
-}
-export declare class UndirectedEdge<E = number> extends AbstractEdge<E> {
-    endpoints: [VertexKey, VertexKey];
-    constructor(v1: VertexKey, v2: VertexKey, weight?: number, value?: E);
-}
-/**
- * Undirected graph implementation.
- * @template V - Vertex value type.
- * @template E - Edge value type.
- * @template VO - Concrete vertex class (extends AbstractVertex<V>).
- * @template EO - Concrete edge class (extends AbstractEdge<E>).
- * @remarks Time O(1), Space O(1)
- * @example examples will be generated by unit test
- */
-export declare class UndirectedGraph<V = any, E = any, VO extends UndirectedVertex<V> = UndirectedVertex<V>, EO extends UndirectedEdge<E> = UndirectedEdge<E>> extends AbstractGraph<V, E, VO, EO> implements IGraph<V, E, VO, EO> {
-    /**
-     * Construct an undirected graph with runtime defaults.
-     * @param options - `GraphOptions<V>` (e.g. `vertexValueInitializer`, `defaultEdgeWeight`).
-     * @remarks Time O(1), Space O(1)
-     */
-    constructor(options?: Partial<GraphOptions<V>>);
-    protected _edgeMap: Map<VO, EO[]>;
-    get edgeMap(): Map<VO, EO[]>;
-    set edgeMap(v: Map<VO, EO[]>);
-    /**
-     * Construct an undirected graph from keys with value initializer `v => v`.
-     * @template K - Vertex key type.
-     * @param keys - Iterable of vertex keys.
-     * @returns UndirectedGraph with all keys added.
-     * @remarks Time O(V), Space O(V)
-     */
-    static fromKeys<K extends VertexKey>(keys: Iterable<K>): UndirectedGraph<K, any, UndirectedVertex<K>, UndirectedEdge<any>>;
-    /**
-     * Construct an undirected graph from `[key, value]` entries.
-     * @template V - Vertex value type.
-     * @param entries - Iterable of `[key, value]` pairs.
-     * @returns UndirectedGraph with all vertices added.
-     * @remarks Time O(V), Space O(V)
-     */
-    static fromEntries<V>(entries: Iterable<[VertexKey, V]>): UndirectedGraph<V, any, UndirectedVertex<V>, UndirectedEdge<any>>;
-    /**
-     * Create an undirected vertex instance. Does not insert into the graph.
-     * @param key - Vertex identifier.
-     * @param value - Optional payload.
-     * @returns Concrete vertex instance.
-     * @remarks Time O(1), Space O(1)
-     */
-    createVertex(key: VertexKey, value?: VO['value']): VO;
-    /**
-     * Create an undirected edge instance. Does not insert into the graph.
-     * @param v1 - One endpoint key.
-     * @param v2 - The other endpoint key.
-     * @param weight - Edge weight; defaults to `defaultEdgeWeight`.
-     * @param value - Edge payload.
-     * @returns Concrete edge instance.
-     * @remarks Time O(1), Space O(1)
-     */
-    createEdge(v1: VertexKey, v2: VertexKey, weight?: number, value?: EO['value']): EO;
-    /**
-     * Get an undirected edge between two vertices, if present.
-     * @param v1 - One vertex or key.
-     * @param v2 - The other vertex or key.
-     * @returns Edge instance or `undefined`.
-     * @remarks Time O(1) avg, Space O(1)
-     */
-    getEdge(v1: VO | VertexKey | undefined, v2: VO | VertexKey | undefined): EO | undefined;
-    /**
-     * Delete a single undirected edge between two vertices.
-     * @param v1 - One vertex or key.
-     * @param v2 - The other vertex or key.
-     * @returns Removed edge or `undefined`.
-     * @remarks Time O(1) avg, Space O(1)
-     */
-    deleteEdgeBetween(v1: VO | VertexKey, v2: VO | VertexKey): EO | undefined;
-    /**
-     * Delete an edge by instance or by a pair of keys.
-     * @param edgeOrOneSideVertexKey - Edge instance or one endpoint vertex/key.
-     * @param otherSideVertexKey - Required second endpoint when deleting by pair.
-     * @returns Removed edge or `undefined`.
-     * @remarks Time O(1) avg, Space O(1)
-     */
-    deleteEdge(edgeOrOneSideVertexKey: EO | VertexKey, otherSideVertexKey?: VertexKey): EO | undefined;
-    /**
-     * Delete a vertex and remove it from all neighbor lists.
-     * @param vertexOrKey - Vertex or key.
-     * @returns `true` if removed; otherwise `false`.
-     * @remarks Time O(deg), Space O(1)
-     */
-    deleteVertex(vertexOrKey: VO | VertexKey): boolean;
-    /**
-     * Degree of a vertex (# of incident undirected edges).
-     * @param vertexOrKey - Vertex or key.
-     * @returns Non-negative integer.
-     * @remarks Time O(1) avg, Space O(1)
-     */
-    degreeOf(vertexOrKey: VertexKey | VO): number;
-    /**
-     * Incident undirected edges of a vertex.
-     * @param vertexOrKey - Vertex or key.
-     * @returns Array of incident edges.
-     * @remarks Time O(deg), Space O(deg)
-     */
-    edgesOf(vertexOrKey: VertexKey | VO): EO[];
-    /**
-     * Unique set of undirected edges across endpoints.
-     * @returns Array of edges.
-     * @remarks Time O(E), Space O(E)
-     */
-    edgeSet(): EO[];
-    getNeighbors(vertexOrKey: VO | VertexKey): VO[];
-    /**
-     * Resolve an edge's two endpoints to vertex instances.
-     * @param edge - Edge instance.
-     * @returns `[v1, v2]` or `undefined` if either endpoint is missing.
-     * @remarks Time O(1), Space O(1)
-     */
-    getEndsOfEdge(edge: EO): [VO, VO] | undefined;
-    /**
-     * Whether the graph has no vertices and no edges.
-     * @remarks Time O(1), Space O(1)
-     */
-    isEmpty(): boolean;
-    /**
-     * Remove all vertices and edges.
-     * @remarks Time O(V + E), Space O(1)
-     */
-    clear(): void;
-    /**
-     * 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;
-    /**
-     * Tarjan-based bridge and articulation point detection.
-     * @returns `{ dfnMap, lowMap, bridges, cutVertices }`.
-     * @remarks Time O(V + E), Space O(V + E)
-     */
-    tarjan(): {
-        dfnMap: Map<VO, number>;
-        lowMap: Map<VO, number>;
-        bridges: EO[];
-        cutVertices: VO[];
-    };
-    /**
-     * Get bridges discovered by `tarjan()`.
-     * @returns Array of edges that are bridges.
-     * @remarks Time O(B), Space O(1)
-     */
-    getBridges(): EO[];
-    /**
-     * Get articulation points discovered by `tarjan()`.
-     * @returns Array of cut vertices.
-     * @remarks Time O(C), Space O(1)
-     */
-    getCutVertices(): VO[];
-    /**
-     * DFN index map computed by `tarjan()`.
-     * @returns Map from vertex to DFN index.
-     * @remarks Time O(V), Space O(V)
-     */
-    getDFNMap(): Map<VO, number>;
-    /**
-     * LOW link map computed by `tarjan()`.
-     * @returns Map from vertex to LOW value.
-     * @remarks Time O(V), Space O(V)
-     */
-    getLowMap(): Map<VO, number>;
-    /**
-     * Internal hook to attach an undirected edge into adjacency maps.
-     * @param edge - Edge instance.
-     * @returns `true` if both endpoints exist; otherwise `false`.
-     * @remarks Time O(1) avg, Space O(1)
-     */
-    protected _addEdge(edge: EO): boolean;
-}