data-structure-typed 1.42.7 → 1.42.9

package/dist/mjs/src/data-structures/graph/directed-graph.js

@@ -93,6 +93,13 @@ class DirectedGraph extends abstract_graph_1.AbstractGraph {
         return new DirectedEdge(src, dest, weight ?? 1, value);
     }
     /**
+     * Time Complexity: O(|V|) where |V| is the number of vertices
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(|V|) where |V| is the number of vertices
+     * Space Complexity: O(1)
+     *
      * The `getEdge` function retrieves an edge between two vertices based on their source and destination IDs.
      * @param {VO | VertexKey | null} srcOrKey - The source vertex or its ID. It can be either a vertex object or a vertex ID.
      * @param {VO | VertexKey | null} destOrKey - The `destOrKey` parameter in the `getEdge` function represents the
@@ -115,6 +122,13 @@ class DirectedGraph extends abstract_graph_1.AbstractGraph {
         return edges[0] || null;
     }
     /**
+     * Time Complexity: O(|E|) where |E| is the number of edges
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(|E|) where |E| is the number of edges
+     * Space Complexity: O(1)
+     *
      * The function removes an edge between two vertices in a graph and returns the removed edge.
      * @param {VO | VertexKey} srcOrKey - The source vertex or its ID.
      * @param {VO | VertexKey} destOrKey - The `destOrKey` parameter represents the destination vertex or its ID.
@@ -138,6 +152,13 @@ class DirectedGraph extends abstract_graph_1.AbstractGraph {
         return removed;
     }
     /**
+     * Time Complexity: O(|E|) where |E| is the number of edges
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(|E|) where |E| is the number of edges
+     * Space Complexity: O(1)
+     *
      * The function removes an edge from a graph and returns the removed edge, or null if the edge was not found.
      * @param {EO} 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.
@@ -160,6 +181,13 @@ class DirectedGraph extends abstract_graph_1.AbstractGraph {
         return removed;
     }
     /**
+     * Time Complexity: O(|E|) where |E| is the number of edges
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(|E|) where |E| is the number of edges
+     * Space Complexity: O(1)
+     *
      * The function removes edges between two vertices and returns the removed edges.
      * @param {VertexKey | VO} v1 - The parameter `v1` can be either a `VertexKey` or a `VO`. A `VertexKey` represents the
      * unique identifier of a vertex in a graph, while `VO` represents the actual vertex object.
@@ -178,6 +206,13 @@ class DirectedGraph extends abstract_graph_1.AbstractGraph {
         return removed;
     }
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The function `incomingEdgesOf` returns an array of incoming edges for a given vertex or vertex ID.
      * @param {VO | VertexKey} vertexOrKey - The parameter `vertexOrKey` can be either a vertex object (`VO`) or a vertex ID
      * (`VertexKey`).
@@ -191,6 +226,13 @@ class DirectedGraph extends abstract_graph_1.AbstractGraph {
         return [];
     }
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The function `outgoingEdgesOf` returns an array of outgoing edges from a given vertex or vertex ID.
      * @param {VO | VertexKey} vertexOrKey - The parameter `vertexOrKey` can accept either a vertex object (`VO`) or a vertex ID
      * (`VertexKey`).
@@ -204,6 +246,13 @@ class DirectedGraph extends abstract_graph_1.AbstractGraph {
         return [];
     }
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The function "degreeOf" returns the total degree of a vertex, which is the sum of its out-degree and in-degree.
      * @param {VertexKey | VO} vertexOrKey - The parameter `vertexOrKey` can be either a `VertexKey` or a `VO`.
      * @returns The sum of the out-degree and in-degree of the specified vertex or vertex ID.
@@ -212,6 +261,13 @@ class DirectedGraph extends abstract_graph_1.AbstractGraph {
         return this.outDegreeOf(vertexOrKey) + this.inDegreeOf(vertexOrKey);
     }
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The function "inDegreeOf" returns the number of incoming edges for a given vertex.
      * @param {VertexKey | VO} vertexOrKey - The parameter `vertexOrKey` can be either a `VertexKey` or a `VO`.
      * @returns The number of incoming edges of the specified vertex or vertex ID.
@@ -220,6 +276,13 @@ class DirectedGraph extends abstract_graph_1.AbstractGraph {
         return this.incomingEdgesOf(vertexOrKey).length;
     }
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The function `outDegreeOf` returns the number of outgoing edges from a given vertex.
      * @param {VertexKey | VO} vertexOrKey - The parameter `vertexOrKey` can be either a `VertexKey` or a `VO`.
      * @returns The number of outgoing edges from the specified vertex or vertex ID.
@@ -228,6 +291,13 @@ class DirectedGraph extends abstract_graph_1.AbstractGraph {
         return this.outgoingEdgesOf(vertexOrKey).length;
     }
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The function "edgesOf" returns an array of both outgoing and incoming edges of a given vertex or vertex ID.
      * @param {VertexKey | VO} vertexOrKey - The parameter `vertexOrKey` can be either a `VertexKey` or a `VO`.
      * @returns The function `edgesOf` returns an array of edges.
@@ -236,6 +306,13 @@ class DirectedGraph extends abstract_graph_1.AbstractGraph {
         return [...this.outgoingEdgesOf(vertexOrKey), ...this.incomingEdgesOf(vertexOrKey)];
     }
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The function "getEdgeSrc" returns the source vertex of an edge, or null if the edge does not exist.
      * @param {EO} e - The parameter "e" is of type EO, which represents an edge in a graph.
      * @returns either a vertex object (VO) or null.
@@ -244,6 +321,13 @@ class DirectedGraph extends abstract_graph_1.AbstractGraph {
         return this._getVertex(e.src);
     }
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The function "getEdgeDest" returns the destination vertex of an edge.
      * @param {EO} e - The parameter "e" is of type "EO", which represents an edge in a graph.
      * @returns either a vertex object of type VO or null.
@@ -252,6 +336,13 @@ class DirectedGraph extends abstract_graph_1.AbstractGraph {
         return this._getVertex(e.dest);
     }
     /**
+     * Time Complexity: O(|E|) where |E| is the number of edges
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(|E|) where |E| is the number of edges
+     * Space Complexity: O(1)
+     *
      * The function `getDestinations` returns an array of destination vertices connected to a given vertex.
      * @param {VO | VertexKey | null} vertex - The `vertex` parameter represents the starting vertex from which we want to
      * find the destinations. It can be either a `VO` object, a `VertexKey` value, or `null`.
@@ -272,6 +363,13 @@ class DirectedGraph extends abstract_graph_1.AbstractGraph {
         return destinations;
     }
     /**
+     * Time Complexity: O(|V| + |E|) where |V| is the number of vertices and |E| is the number of edges
+     * Space Complexity: O(|V|)
+     */
+    /**
+     * Time Complexity: O(|V| + |E|) where |V| is the number of vertices and |E| is the number of edges
+     * Space Complexity: O(|V|)
+     *
      * The `topologicalSort` function performs a topological sort on a graph and returns an array of vertices or vertex IDs
      * in the sorted order, or null if the graph contains a cycle.
      * @param {'vertex' | 'key'} [propertyName] - The `propertyName` parameter is an optional parameter that specifies the
@@ -316,6 +414,13 @@ class DirectedGraph extends abstract_graph_1.AbstractGraph {
         return sorted.reverse();
     }
     /**
+     * Time Complexity: O(|E|) where |E| is the number of edges
+     * Space Complexity: O(|E|)
+     */
+    /**
+     * Time Complexity: O(|E|) where |E| is the number of edges
+     * Space Complexity: O(|E|)
+     *
      * The `edgeSet` function returns an array of all the edges in the graph.
      * @returns The `edgeSet()` method returns an array of edges (`EO[]`).
      */
@@ -327,6 +432,13 @@ class DirectedGraph extends abstract_graph_1.AbstractGraph {
         return edges;
     }
     /**
+     * Time Complexity: O(|E|) where |E| is the number of edges
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(|E|) where |E| is the number of edges
+     * Space Complexity: O(1)
+     *
      * The function `getNeighbors` returns an array of neighboring vertices of a given vertex or vertex ID in a graph.
      * @param {VO | VertexKey} vertexOrKey - The parameter `vertexOrKey` can be either a vertex object (`VO`) or a vertex ID
      * (`VertexKey`).
@@ -348,6 +460,13 @@ class DirectedGraph extends abstract_graph_1.AbstractGraph {
         return neighbors;
     }
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The function "getEndsOfEdge" returns the source and destination vertices of an edge if it exists in the graph,
      * otherwise it returns null.
      * @param {EO} edge - The parameter `edge` is of type `EO`, which represents an edge in a graph.
@@ -368,6 +487,13 @@ class DirectedGraph extends abstract_graph_1.AbstractGraph {
         }
     }
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The function `_addEdgeOnly` adds an edge to a graph if the source and destination vertices exist.
      * @param {EO} edge - The parameter `edge` is of type `EO`, which represents an edge in a graph. It is the edge that
      * needs to be added to the graph.

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

@@ -54,6 +54,13 @@ export declare class UndirectedGraph<V = any, E = any, VO extends UndirectedVert
      */
     createEdge(v1: VertexKey, v2: VertexKey, weight?: number, value?: EO['value']): EO;
     /**
+     * Time Complexity: O(|E|), where |E| is the number of edges incident to the given vertex.
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(|E|), where |E| is the number of edges incident to the given vertex.
+     * Space Complexity: O(1)
+     *
      * The function `getEdge` returns the first edge that connects two vertices, or null if no such edge exists.
      * @param {VO | VertexKey | null} v1 - The parameter `v1` represents a vertex or vertex ID. It can be of type `VO` (vertex
      * object), `null`, or `VertexKey` (a string or number representing the ID of a vertex).
@@ -63,6 +70,13 @@ export declare class UndirectedGraph<V = any, E = any, VO extends UndirectedVert
      */
     getEdge(v1: VO | VertexKey | null, v2: VO | VertexKey | null): EO | null;
     /**
+     * Time Complexity: O(|E|), where |E| is the number of edges incident to the given vertex.
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(|E|), where |E| is the number of edges incident to the given vertex.
+     * Space Complexity: O(1)
+     *
      * The function removes an edge between two vertices in a graph and returns the removed edge.
      * @param {VO | VertexKey} v1 - The parameter `v1` represents either a vertex object (`VO`) or a vertex ID (`VertexKey`).
      * @param {VO | VertexKey} v2 - VO | VertexKey - This parameter can be either a vertex object (VO) or a vertex ID
@@ -71,12 +85,26 @@ export declare class UndirectedGraph<V = any, E = any, VO extends UndirectedVert
      */
     deleteEdgeBetween(v1: VO | VertexKey, v2: VO | VertexKey): EO | null;
     /**
+     * Time Complexity: O(|E|), where |E| is the number of edges incident to the given vertex.
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(|E|), where |E| is the number of edges incident to the given vertex.
+     * Space Complexity: O(1)
+     *
      * The deleteEdge function removes an edge between two vertices in a graph.
      * @param {EO} edge - The parameter "edge" is of type EO, which represents an edge in a graph.
      * @returns The method is returning either the removed edge (of type EO) or null if the edge was not found.
      */
     deleteEdge(edge: EO): EO | null;
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(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 | VO} vertexOrKey - The parameter `vertexOrKey` can be either a `VertexKey` or a `VO`.
@@ -85,6 +113,13 @@ export declare class UndirectedGraph<V = any, E = any, VO extends UndirectedVert
      */
     degreeOf(vertexOrKey: VertexKey | VO): number;
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The function returns the edges of a given vertex or vertex ID.
      * @param {VertexKey | VO} vertexOrKey - The parameter `vertexOrKey` can be either a `VertexKey` or a `VO`. A `VertexKey` is a
      * unique identifier for a vertex in a graph, while `VO` represents the type of the vertex.
@@ -92,11 +127,25 @@ export declare class UndirectedGraph<V = any, E = any, VO extends UndirectedVert
      */
     edgesOf(vertexOrKey: VertexKey | VO): EO[];
     /**
+     * Time Complexity: O(|V| + |E|), where |V| is the number of vertices and |E| is the number of edges.
+     * Space Complexity: O(|E|)
+     */
+    /**
+     * Time Complexity: O(|V| + |E|), where |V| is the number of vertices and |E| is the number of edges.
+     * Space Complexity: O(|E|)
+     *
      * The function "edgeSet" returns an array of unique edges from a set of edges.
      * @returns The method `edgeSet()` returns an array of type `EO[]`.
      */
     edgeSet(): EO[];
     /**
+     * Time Complexity: O(|V| + |E|), where |V| is the number of vertices and |E| is the number of edges.
+     * Space Complexity: O(|E|)
+     */
+    /**
+     * Time Complexity: O(|V| + |E|), where |V| is the number of vertices and |E| is the number of edges.
+     * Space Complexity: O(|E|)
+     *
      * The function "getNeighbors" returns an array of neighboring vertices for a given vertex or vertex ID.
      * @param {VO | VertexKey} vertexOrKey - The parameter `vertexOrKey` can be either a vertex object (`VO`) or a vertex ID
      * (`VertexKey`).
@@ -104,6 +153,13 @@ export declare class UndirectedGraph<V = any, E = any, VO extends UndirectedVert
      */
     getNeighbors(vertexOrKey: VO | VertexKey): VO[];
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The function "getEndsOfEdge" returns the vertices at the ends of an edge if the edge exists in the graph, otherwise
      * it returns null.
      * @param {EO} edge - The parameter "edge" is of type EO, which represents an edge in a graph.
@@ -112,6 +168,13 @@ export declare class UndirectedGraph<V = any, E = any, VO extends UndirectedVert
      */
     getEndsOfEdge(edge: EO): [VO, VO] | null;
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The function adds an edge to the graph by updating the adjacency list with the vertices of the edge.
      * @param {EO} edge - The parameter "edge" is of type EO, which represents an edge in a graph.
      * @returns a boolean value.

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

@@ -79,6 +79,13 @@ class UndirectedGraph extends abstract_graph_1.AbstractGraph {
         return new UndirectedEdge(v1, v2, weight ?? 1, value);
     }
     /**
+     * Time Complexity: O(|E|), where |E| is the number of edges incident to the given vertex.
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(|E|), where |E| is the number of edges incident to the given vertex.
+     * Space Complexity: O(1)
+     *
      * The function `getEdge` returns the first edge that connects two vertices, or null if no such edge exists.
      * @param {VO | VertexKey | null} v1 - The parameter `v1` represents a vertex or vertex ID. It can be of type `VO` (vertex
      * object), `null`, or `VertexKey` (a string or number representing the ID of a vertex).
@@ -98,6 +105,13 @@ class UndirectedGraph extends abstract_graph_1.AbstractGraph {
         return edges ? edges[0] || null : null;
     }
     /**
+     * Time Complexity: O(|E|), where |E| is the number of edges incident to the given vertex.
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(|E|), where |E| is the number of edges incident to the given vertex.
+     * Space Complexity: O(1)
+     *
      * The function removes an edge between two vertices in a graph and returns the removed edge.
      * @param {VO | VertexKey} v1 - The parameter `v1` represents either a vertex object (`VO`) or a vertex ID (`VertexKey`).
      * @param {VO | VertexKey} v2 - VO | VertexKey - This parameter can be either a vertex object (VO) or a vertex ID
@@ -122,6 +136,13 @@ class UndirectedGraph extends abstract_graph_1.AbstractGraph {
         return removed;
     }
     /**
+     * Time Complexity: O(|E|), where |E| is the number of edges incident to the given vertex.
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(|E|), where |E| is the number of edges incident to the given vertex.
+     * Space Complexity: O(1)
+     *
      * The deleteEdge function removes an edge between two vertices in a graph.
      * @param {EO} edge - The parameter "edge" is of type EO, which represents an edge in a graph.
      * @returns The method is returning either the removed edge (of type EO) or null if the edge was not found.
@@ -130,6 +151,13 @@ class UndirectedGraph extends abstract_graph_1.AbstractGraph {
         return this.deleteEdgeBetween(edge.vertices[0], edge.vertices[1]);
     }
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(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 | VO} vertexOrKey - The parameter `vertexOrKey` can be either a `VertexKey` or a `VO`.
@@ -146,6 +174,13 @@ class UndirectedGraph extends abstract_graph_1.AbstractGraph {
         }
     }
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The function returns the edges of a given vertex or vertex ID.
      * @param {VertexKey | VO} vertexOrKey - The parameter `vertexOrKey` can be either a `VertexKey` or a `VO`. A `VertexKey` is a
      * unique identifier for a vertex in a graph, while `VO` represents the type of the vertex.
@@ -161,6 +196,13 @@ class UndirectedGraph extends abstract_graph_1.AbstractGraph {
         }
     }
     /**
+     * Time Complexity: O(|V| + |E|), where |V| is the number of vertices and |E| is the number of edges.
+     * Space Complexity: O(|E|)
+     */
+    /**
+     * Time Complexity: O(|V| + |E|), where |V| is the number of vertices and |E| is the number of edges.
+     * Space Complexity: O(|E|)
+     *
      * The function "edgeSet" returns an array of unique edges from a set of edges.
      * @returns The method `edgeSet()` returns an array of type `EO[]`.
      */
@@ -174,6 +216,13 @@ class UndirectedGraph extends abstract_graph_1.AbstractGraph {
         return [...edgeSet];
     }
     /**
+     * Time Complexity: O(|V| + |E|), where |V| is the number of vertices and |E| is the number of edges.
+     * Space Complexity: O(|E|)
+     */
+    /**
+     * Time Complexity: O(|V| + |E|), where |V| is the number of vertices and |E| is the number of edges.
+     * Space Complexity: O(|E|)
+     *
      * The function "getNeighbors" returns an array of neighboring vertices for a given vertex or vertex ID.
      * @param {VO | VertexKey} vertexOrKey - The parameter `vertexOrKey` can be either a vertex object (`VO`) or a vertex ID
      * (`VertexKey`).
@@ -194,6 +243,13 @@ class UndirectedGraph extends abstract_graph_1.AbstractGraph {
         return neighbors;
     }
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The function "getEndsOfEdge" returns the vertices at the ends of an edge if the edge exists in the graph, otherwise
      * it returns null.
      * @param {EO} edge - The parameter "edge" is of type EO, which represents an edge in a graph.
@@ -214,6 +270,13 @@ class UndirectedGraph extends abstract_graph_1.AbstractGraph {
         }
     }
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The function adds an edge to the graph by updating the adjacency list with the vertices of the edge.
      * @param {EO} edge - The parameter "edge" is of type EO, which represents an edge in a graph.
      * @returns a boolean value.