data-structure-typed 1.18.0 → 1.18.6

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

@@ -1,24 +1,30 @@
 import { AbstractEdge, AbstractGraph, AbstractVertex } from './abstract-graph';
-import type { IDirectedGraph, VertexId } from '../types';
-export declare class DirectedVertex extends AbstractVertex {
+import type { VertexId } from '../types';
+import { IDirectedGraph } from '../interfaces';
+export declare class DirectedVertex<T = number> extends AbstractVertex<T> {
     /**
-     * The constructor function initializes an object with a given id.
-     * @param {VertexId} id - The `id` parameter is the identifier for the vertex. It is used to uniquely identify the
-     * vertex within a graph or network.
+     * The constructor function initializes a vertex with an optional value.
+     * @param {VertexId} id - The `id` parameter is the identifier for the vertex. It is of type `VertexId`, which is
+     * typically a unique identifier for each vertex in a graph.
+     * @param {T} [val] - The "val" parameter is an optional parameter of type T. It is used to specify the value
+     * associated with the vertex.
      */
-    constructor(id: VertexId);
+    constructor(id: VertexId, val?: T);
 }
-export declare class DirectedEdge extends AbstractEdge {
+export declare class DirectedEdge<T = number> extends AbstractEdge<T> {
     /**
-     * The constructor function initializes the source and destination vertices of an edge, with an optional weight.
+     * The constructor function initializes the source and destination vertices of an edge, along with an optional weight
+     * and value.
      * @param {VertexId} src - The `src` parameter is the source vertex ID. It represents the starting point of an edge in
      * a graph.
-     * @param {VertexId} dest - The `dest` parameter is the identifier of the destination vertex. It represents the vertex
-     * to which an edge is directed.
-     * @param {number} [weight] - The `weight` parameter is an optional number that represents the weight of the edge
-     * between two vertices.
-     */
-    constructor(src: VertexId, dest: VertexId, weight?: number);
+     * @param {VertexId} 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. 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 will default to `undefined`.
+     * @param {T} [val] - The "val" parameter is an optional parameter of type T. It represents the value associated with
+     * the edge.
+     */
+    constructor(src: VertexId, dest: VertexId, weight?: number, val?: T);
     private _src;
     get src(): VertexId;
     set src(v: VertexId);
@@ -26,142 +32,165 @@ export declare class DirectedEdge extends AbstractEdge {
     get dest(): VertexId;
     set dest(v: VertexId);
 }
-export declare class DirectedGraph<V extends DirectedVertex, E extends DirectedEdge> extends AbstractGraph<V, E> implements IDirectedGraph<V, E> {
-    protected _outEdgeMap: Map<V, E[]>;
-    protected _inEdgeMap: Map<V, E[]>;
+export declare class DirectedGraph<V extends DirectedVertex<any> = DirectedVertex, E extends DirectedEdge<any> = DirectedEdge> extends AbstractGraph<V, E> implements IDirectedGraph<V, E> {
     constructor();
-    /**
-     * The function `getEdge` returns the first edge between two vertices, given their source and destination.
-     * @param {V | null | VertexId} srcOrId - The `srcOrId` parameter can be either a vertex object (`V`), a vertex ID
-     * (`VertexId`), or `null`. It represents the source vertex of the edge.
-     * @param {V | null | VertexId} destOrId - The `destOrId` parameter is either a vertex object (`V`), a vertex ID
-     * (`VertexId`), or `null`. It represents the destination vertex of the edge.
-     * @returns an edge (E) or null.
+    private _outEdgeMap;
+    get outEdgeMap(): Map<V, E[]>;
+    private _inEdgeMap;
+    get inEdgeMap(): Map<V, E[]>;
+    /**
+     * In TypeScript, a subclass inherits the interface implementation of its parent class, without needing to implement the same interface again in the subclass. This behavior differs from Java's approach. In Java, if a parent class implements an interface, the subclass needs to explicitly implement the same interface, even if the parent class has already implemented it.
+     * This means that using abstract methods in the parent class cannot constrain the grandchild classes. Defining methods within an interface also cannot constrain the descendant classes. When inheriting from this class, developers need to be aware that this method needs to be overridden.
+     * @param id
+     * @param val
+     */
+    _createVertex(id: VertexId, val?: V['val']): V;
+    /**
+     * In TypeScript, a subclass inherits the interface implementation of its parent class, without needing to implement the same interface again in the subclass. This behavior differs from Java's approach. In Java, if a parent class implements an interface, the subclass needs to explicitly implement the same interface, even if the parent class has already implemented it.
+     * This means that using abstract methods in the parent class cannot constrain the grandchild classes. Defining methods within an interface also cannot constrain the descendant classes. When inheriting from this class, developers need to be aware that this method needs to be overridden.
+     * @param src
+     * @param dest
+     * @param weight
+     * @param val
+     */
+    _createEdge(src: VertexId, dest: VertexId, weight?: number, val?: E['val']): E;
+    /**
+     * The function `getEdge` returns the directed edge between two vertices, given their source and destination.
+     * @param {V | null | VertexId} srcOrId - The source vertex or its ID. It can be either a
+     * DirectedVertex object or a VertexId.
+     * @param {V | null | VertexId} destOrId - The `destOrId` parameter is the destination vertex or its
+     * ID. It can be either a `DirectedVertex` object or a `VertexId` value.
+     * @returns a E object or null.
      */
     getEdge(srcOrId: V | null | VertexId, destOrId: V | null | VertexId): E | null;
     /**
-     * The `addEdge` function adds an edge to a graph if the source and destination vertices exist.
-     * @param {E} edge - The parameter `edge` is of type `E`, which represents an edge in the graph. It contains
-     * information about the source vertex (`src`) and the destination vertex (`dest`) of the edge.
-     * @returns The `addEdge` function returns a boolean value. It returns `true` if the edge was successfully added to the
-     * graph, and `false` if either the source or destination vertices of the edge are not present in the graph.
+     * The `addEdge` function adds a directed edge to a graph if the source and destination vertices exist.
+     * @param edge - The parameter `edge` is of type `E`, which represents a directed edge in a graph. It
+     * contains two properties:
+     * @returns The method `addEdge` returns a boolean value. It returns `true` if the edge was successfully added to the
+     * graph, and `false` if either the source or destination vertex of the edge is not present in the graph.
      */
     addEdge(edge: E): boolean;
     /**
-     * The function removes an edge between two vertices in a directed graph and returns the removed edge.
-     * @param {V | VertexId} srcOrId - The source vertex or its ID.
-     * @param {V | VertexId} destOrId - The `destOrId` parameter in the `removeEdgeBetween` function represents the
-     * destination vertex of the edge that needs to be removed. It can be either a vertex object (`V`) or a vertex ID
-     * (`VertexId`).
-     * @returns The function `removeEdgeBetween` returns the removed edge (`E`) if the edge between the source and
-     * destination vertices is successfully removed. If either the source or destination vertex is not found, or if the
-     * edge does not exist, it returns `null`.
+     * The `removeEdgeBetween` function removes an edge between two vertices in a directed graph and returns the removed
+     * edge, or null if the edge was not found.
+     * @param {V | VertexId} srcOrId - The `srcOrId` parameter represents either a `V`
+     * object or a `VertexId` value. It is used to specify the source vertex of the edge that you want to remove.
+     * @param {V | VertexId} destOrId - The `destOrId` parameter represents the destination vertex of the
+     * edge that you want to remove. It can be either a `V` object or a `VertexId` value.
+     * @returns The function `removeEdgeBetween` returns the removed edge (`E`) if it exists, or `null` if
+     * the edge does not exist.
      */
     removeEdgeBetween(srcOrId: V | VertexId, destOrId: V | VertexId): E | null;
     /**
-     * The removeEdge function removes an edge from a graph and returns the removed edge, or null if the edge was not
-     * found.
-     * @param {E} edge - The `edge` parameter is an object that represents an edge in a graph. It has two properties: `src`
-     * and `dest`, which represent the source and destination vertices of the edge, respectively.
-     * @returns The method `removeEdge` returns the removed edge (`E`) if it exists, or `null` if the edge does not exist.
+     * The `removeEdge` function removes a directed edge from a graph and returns the removed edge, or null if the edge was
+     * not found.
+     * @param edge - The `edge` parameter is an object of type `E`, which represents a directed edge in a
+     * graph. It has two properties:
+     * @returns The function `removeEdge` returns a `E` object if an edge is successfully removed, or `null`
+     * if no edge is removed.
      */
     removeEdge(edge: E): E | null;
     /**
      * The function removeAllEdges removes all edges between two vertices.
-     * @param {VertexId | V} src - The `src` parameter represents the source vertex from which the edges will be removed.
-     * It can be either a `VertexId` or a `V` type, which represents the identifier or object of the vertex.
-     * @param {VertexId | V} dest - The `dest` parameter represents the destination vertex of an edge. It can be either a
-     * `VertexId` or a vertex object `V`.
-     * @returns An empty array is being returned.
+     * @param {VertexId | V} src - The `src` parameter can be either a `VertexId` or a `V`.
+     * @param {VertexId | V} dest - The `dest` parameter represents the destination vertex of an edge. It
+     * can be either a `VertexId` or a `V`.
+     * @returns An empty array of DirectedEdge objects is being returned.
      */
     removeAllEdges(src: VertexId | V, dest: VertexId | V): E[];
     /**
-     * The function `incomingEdgesOf` returns an array of incoming edges for a given vertex or vertex ID.
-     * @param {V | VertexId} vertexOrId - The parameter `vertexOrId` can be either a vertex object (`V`) or a vertex ID
-     * (`VertexId`).
-     * @returns The method `incomingEdgesOf` returns an array of edges (`E[]`).
+     * The function returns an array of incoming edges of a given vertex or vertex ID.
+     * @param {V | VertexId} vertexOrId - The parameter `vertexOrId` can be either a `V`
+     * object or a `VertexId`.
+     * @returns The method `incomingEdgesOf` returns an array of `E` objects.
      */
     incomingEdgesOf(vertexOrId: V | VertexId): E[];
     /**
-     * The function `outgoingEdgesOf` returns an array of outgoing edges from a given vertex or vertex ID.
-     * @param {V | VertexId} vertexOrId - The parameter `vertexOrId` can accept either a vertex object (`V`) or a vertex ID
-     * (`VertexId`).
-     * @returns The method `outgoingEdgesOf` returns an array of outgoing edges from a given vertex or vertex ID.
+     * The function `outgoingEdgesOf` returns an array of outgoing directed edges from a given vertex or vertex ID.
+     * @param {V | VertexId} vertexOrId - The parameter `vertexOrId` can be either a `V`
+     * object or a `VertexId`.
+     * @returns The method `outgoingEdgesOf` returns an array of `E` objects.
      */
     outgoingEdgesOf(vertexOrId: V | VertexId): E[];
     /**
-     * The function "degreeOf" returns the total degree of a vertex, which is the sum of its out-degree and in-degree.
-     * @param {VertexId | V} vertexOrId - The parameter `vertexOrId` can be either a `VertexId` or a `V`.
-     * @returns the sum of the out-degree and in-degree of the specified vertex or vertex ID.
+     * The function "degreeOf" returns the total degree of a vertex in a directed graph, which is the sum of its out-degree
+     * and in-degree.
+     * @param {VertexId | V} vertexOrId - The parameter `vertexOrId` can be either a `VertexId` or a
+     * `V`.
+     * @returns The sum of the out-degree and in-degree of the given vertex or vertex ID.
      */
     degreeOf(vertexOrId: VertexId | V): number;
     /**
-     * The function "inDegreeOf" returns the number of incoming edges for a given vertex.
-     * @param {VertexId | V} vertexOrId - The parameter `vertexOrId` can be either a `VertexId` or a `V`.
+     * The function "inDegreeOf" returns the number of incoming edges for a given vertex or vertex ID in a directed graph.
+     * @param {VertexId | V} vertexOrId - The parameter `vertexOrId` can be either a `VertexId` or a
+     * `V`.
      * @returns The number of incoming edges of the specified vertex or vertex ID.
      */
     inDegreeOf(vertexOrId: VertexId | V): number;
     /**
-     * The function `outDegreeOf` returns the number of outgoing edges from a given vertex.
-     * @param {VertexId | V} vertexOrId - The parameter `vertexOrId` can be either a `VertexId` or a `V`.
+     * The function "outDegreeOf" returns the number of outgoing edges from a given vertex.
+     * @param {VertexId | V} vertexOrId - The parameter `vertexOrId` can be either a `VertexId` or a
+     * `V`.
      * @returns The number of outgoing edges from the specified vertex or vertex ID.
      */
     outDegreeOf(vertexOrId: VertexId | V): number;
     /**
-     * The function "edgesOf" returns an array of both outgoing and incoming edges of a given vertex or vertex ID.
-     * @param {VertexId | V} vertexOrId - The parameter `vertexOrId` can be either a `VertexId` or a `V`.
-     * @returns The function `edgesOf` returns an array of edges.
+     * The function "edgesOf" returns an array of both outgoing and incoming directed edges of a given vertex or vertex ID.
+     * @param {VertexId | V} vertexOrId - The parameter `vertexOrId` can be either a `VertexId` or a
+     * `V`.
+     * @returns an array of directed edges.
      */
     edgesOf(vertexOrId: VertexId | V): E[];
     /**
-     * The function "getEdgeSrc" returns the source vertex of an edge, or null if the edge does not exist.
-     * @param {E} e - E - an edge object
-     * @returns the source vertex of the given edge, or null if the edge does not exist.
+     * The function "getEdgeSrc" returns the source vertex of a directed edge, or null if the edge does not exist.
+     * @param e - A directed edge object of type E.
+     * @returns either a DirectedVertex object or null.
      */
     getEdgeSrc(e: E): V | null;
     /**
-     * The function "getEdgeDest" returns the vertex associated with the destination of an edge.
-     * @param {E} e - The parameter `e` is of type `E`, which represents an edge in a graph.
-     * @returns either a vertex object (of type V) or null.
+     * The function "getEdgeDest" returns the destination vertex of a directed edge.
+     * @param e - E - This is an object representing a directed edge in a graph. It contains information
+     * about the source vertex, destination vertex, and any associated data.
+     * @returns either a DirectedVertex object or null.
      */
     getEdgeDest(e: E): V | null;
     /**
-     * The function `getDestinations` returns an array of destination vertices connected to a given vertex.
-     * @param {V | VertexId | null} vertex - The `vertex` parameter represents the starting vertex from which we want to
-     * find the destinations. It can be either a `V` object, a `VertexId` (which is a unique identifier for a vertex), or
-     * `null` if we want to find destinations from all vertices.
-     * @returns an array of vertices (V[]).
+     * The function `getDestinations` returns an array of directed vertices that are the destinations of outgoing edges
+     * from a given vertex.
+     * @param {V | VertexId | null} vertex - The `vertex` parameter can be one of the following:
+     * @returns an array of DirectedVertex objects.
      */
     getDestinations(vertex: V | VertexId | null): V[];
-    /**--- start find cycles --- */
     /**
-     * when stored with adjacency list time: O(V+E)
-     * when stored with adjacency matrix time: O(V^2)
-     * The `topologicalSort` function performs a topological sort on a graph and returns the sorted vertices in reverse
-     * order, or null if the graph contains a cycle.
-     * @returns The function `topologicalSort()` returns an array of vertices in topological order if there is no cycle in
-     * the graph. If there is a cycle, it returns `null`.
+     * The `topologicalSort` function performs a topological sort on a directed graph and returns the sorted vertices in
+     * reverse order, or null if the graph contains a cycle.
+     * @returns The function `topologicalSort()` returns an array of `V` or `VertexId` objects in
+     * topological order, or `null` if there is a cycle in the graph.
      */
     topologicalSort(): Array<V | VertexId> | null;
-    /**--- end find cycles --- */
     /**
-     * The `edgeSet` function returns an array of all the edges in the graph.
-     * @returns The `edgeSet()` method returns an array of edges (`E[]`).
+     * The `edgeSet` function returns an array of all directed edges in the graph.
+     * @returns The `edgeSet()` method returns an array of `E` objects.
      */
     edgeSet(): E[];
+    /**--- start find cycles --- */
     /**
-     * The function `getNeighbors` returns an array of neighboring vertices for a given vertex or vertex ID.
-     * @param {V | VertexId} vertexOrId - The parameter `vertexOrId` can be either a vertex object (`V`) or a vertex ID
-     * (`VertexId`).
-     * @returns an array of vertices (V[]).
+     * The function `getNeighbors` returns an array of neighboring vertices of a given vertex in a directed graph.
+     * @param {V | VertexId} vertexOrId - The parameter `vertexOrId` can be either a `V`
+     * object or a `VertexId`.
+     * @returns an array of DirectedVertex objects.
      */
     getNeighbors(vertexOrId: V | VertexId): V[];
+    /**--- end find cycles --- */
     /**
-     * The function "getEndsOfEdge" returns the source and destination vertices of an edge if it exists in the graph,
-     * otherwise it returns null.
-     * @param {E} edge - The parameter "edge" is of type E, which represents an edge in a graph.
-     * @returns an array containing two vertices [V, V] if the edge is found in the graph. If the edge is not found, it
-     * returns null.
+     * The function "getEndsOfEdge" returns the source and destination vertices of a directed edge if it exists in the
+     * graph, otherwise it returns null.
+     * @param edge - A directed edge object with a generic type E.
+     * @returns an array containing the starting and ending vertices of the given directed edge, or null if the edge does
+     * not exist in the graph.
      */
     getEndsOfEdge(edge: E): [V, V] | null;
+    protected _setOutEdgeMap(value: Map<V, E[]>): void;
+    protected _setInEdgeMap(value: Map<V, E[]>): void;
 }