min-heap-typed 1.42.8 → 1.43.0

package/src/data-structures/graph/directed-graph.ts

@@ -111,6 +111,14 @@ export class DirectedGraph<
   }
 
   /**
+   * 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
@@ -137,6 +145,14 @@ export class DirectedGraph<
   }
 
   /**
+   * 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.
@@ -163,6 +179,14 @@ export class DirectedGraph<
   }
 
   /**
+   * 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.
@@ -188,6 +212,14 @@ export class DirectedGraph<
   }
 
   /**
+   * 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.
@@ -210,6 +242,14 @@ export class DirectedGraph<
   }
 
   /**
+   * 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`).
@@ -224,6 +264,14 @@ export class DirectedGraph<
   }
 
   /**
+   * 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`).
@@ -238,6 +286,14 @@ export class DirectedGraph<
   }
 
   /**
+   * 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.
@@ -247,6 +303,14 @@ export class DirectedGraph<
   }
 
   /**
+   * 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.
@@ -256,6 +320,14 @@ export class DirectedGraph<
   }
 
   /**
+   * 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.
@@ -265,6 +337,14 @@ export class DirectedGraph<
   }
 
   /**
+   * 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.
@@ -274,6 +354,14 @@ export class DirectedGraph<
   }
 
   /**
+   * 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.
@@ -283,6 +371,14 @@ export class DirectedGraph<
   }
 
   /**
+   * 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.
@@ -292,6 +388,14 @@ export class DirectedGraph<
   }
 
   /**
+   * 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`.
@@ -313,6 +417,14 @@ export class DirectedGraph<
   }
 
   /**
+   * 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
@@ -359,6 +471,14 @@ export class DirectedGraph<
   }
 
   /**
+   * 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[]`).
    */
@@ -371,6 +491,14 @@ export class DirectedGraph<
   }
 
   /**
+   * 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`).
@@ -393,6 +521,14 @@ export class DirectedGraph<
   }
 
   /**
+   * 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.
@@ -413,6 +549,14 @@ export class DirectedGraph<
   }
 
   /**
+   * 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.
@@ -447,4 +591,4 @@ export class DirectedGraph<
       return false;
     }
   }
-}
+}

package/src/data-structures/graph/undirected-graph.ts

@@ -93,6 +93,14 @@ export class UndirectedGraph<
   }
 
   /**
+   * 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).
@@ -116,6 +124,14 @@ export class UndirectedGraph<
   }
 
   /**
+   * 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
@@ -143,6 +159,14 @@ export class UndirectedGraph<
   }
 
   /**
+   * 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.
@@ -152,6 +176,14 @@ export class UndirectedGraph<
   }
 
   /**
+   * 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`.
@@ -168,6 +200,14 @@ export class UndirectedGraph<
   }
 
   /**
+   * 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.
@@ -183,6 +223,14 @@ export class UndirectedGraph<
   }
 
   /**
+   * 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[]`.
    */
@@ -197,6 +245,14 @@ export class UndirectedGraph<
   }
 
   /**
+   * 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`).
@@ -218,6 +274,14 @@ export class UndirectedGraph<
   }
 
   /**
+   * 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.
@@ -238,6 +302,14 @@ export class UndirectedGraph<
   }
 
   /**
+   * 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.