data-structure-typed 2.5.3 → 2.6.1

package/docs-site-docusaurus/docs/api/classes/MapGraph.md

@@ -461,7 +461,7 @@ Time O(V * E), Space O(V + E)
 clear(): void;
 ```
 
-Defined in: [data-structures/graph/directed-graph.ts:944](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L944)
+Defined in: [data-structures/graph/directed-graph.ts:968](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L968)
 
 Remove all vertices and edges.
 
@@ -623,7 +623,7 @@ Time O(1), Space O(1)
 degreeOf(vertexOrKey): number;
 ```
 
-Defined in: [data-structures/graph/directed-graph.ts:626](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L626)
+Defined in: [data-structures/graph/directed-graph.ts:641](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L641)
 
 Degree (in + out) of a vertex.
 
@@ -657,7 +657,7 @@ Time O(1) avg, Space O(1)
 deleteEdge(edgeOrSrcVertexKey, destVertexKey?): EO | undefined;
 ```
 
-Defined in: [data-structures/graph/directed-graph.ts:381](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L381)
+Defined in: [data-structures/graph/directed-graph.ts:387](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L387)
 
 Delete an edge by instance or by `(srcKey, destKey)`.
 
@@ -728,7 +728,7 @@ Time O(1) avg, Space O(1)
 deleteEdgeSrcToDest(srcOrKey, destOrKey): EO | undefined;
 ```
 
-Defined in: [data-structures/graph/directed-graph.ts:290](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L290)
+Defined in: [data-structures/graph/directed-graph.ts:293](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L293)
 
 Delete edge `src -> dest` if present.
 
@@ -768,7 +768,7 @@ Time O(1) avg, Space O(1)
 deleteVertex(vertexOrKey): boolean;
 ```
 
-Defined in: [data-structures/graph/directed-graph.ts:459](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L459)
+Defined in: [data-structures/graph/directed-graph.ts:468](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L468)
 
 Remove a vertex
 
@@ -865,7 +865,7 @@ Time O(V^2 + E), Space O(V + E)
 edgeSet(): EO[];
 ```
 
-Defined in: [data-structures/graph/directed-graph.ts:839](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L839)
+Defined in: [data-structures/graph/directed-graph.ts:860](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L860)
 
 Get all edges
 
@@ -898,7 +898,7 @@ Get all edges
 edgesOf(vertexOrKey): EO[];
 ```
 
-Defined in: [data-structures/graph/directed-graph.ts:656](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L656)
+Defined in: [data-structures/graph/directed-graph.ts:671](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L671)
 
 All incident edges of a vertex.
 
@@ -1306,7 +1306,7 @@ Time exponential in worst-case, Space O(V + E)
 getDestinations(vertex): VO[];
 ```
 
-Defined in: [data-structures/graph/directed-graph.ts:674](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L674)
+Defined in: [data-structures/graph/directed-graph.ts:689](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L689)
 
 Direct children reachable by one outgoing edge.
 
@@ -1340,7 +1340,7 @@ Time O(deg_out), Space O(deg_out)
 getDFNMap(): Map<VO, number>;
 ```
 
-Defined in: [data-structures/graph/directed-graph.ts:1069](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L1069)
+Defined in: [data-structures/graph/directed-graph.ts:1096](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L1096)
 
 DFN index map computed by `tarjan()`.
 
@@ -1366,7 +1366,7 @@ Time O(V), Space O(V)
 getEdge(srcOrKey, destOrKey): EO | undefined;
 ```
 
-Defined in: [data-structures/graph/directed-graph.ts:265](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L265)
+Defined in: [data-structures/graph/directed-graph.ts:268](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L268)
 
 Get the unique edge from `src` to `dest`, if present.
 
@@ -1420,7 +1420,7 @@ Time O(1) avg, Space O(1)
 getEndsOfEdge(edge): [VO, VO] | undefined;
 ```
 
-Defined in: [data-structures/graph/directed-graph.ts:919](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L919)
+Defined in: [data-structures/graph/directed-graph.ts:943](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L943)
 
 Resolve an edge's `[src, dest]` endpoints to vertex instances.
 
@@ -1454,7 +1454,7 @@ Time O(1), Space O(1)
 getLowMap(): Map<VO, number>;
 ```
 
-Defined in: [data-structures/graph/directed-graph.ts:1078](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L1078)
+Defined in: [data-structures/graph/directed-graph.ts:1105](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L1105)
 
 LOW link map computed by `tarjan()`.
 
@@ -1585,7 +1585,7 @@ Time O((V + E) log V) weighted / O(V + E) unweighted, Space O(V + E)
 getNeighbors(vertexOrKey): VO[];
 ```
 
-Defined in: [data-structures/graph/directed-graph.ts:897](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L897)
+Defined in: [data-structures/graph/directed-graph.ts:921](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L921)
 
 Get outgoing neighbors
 
@@ -1661,7 +1661,7 @@ Time O(L), Space O(1) where L is path length
 getSCCs(): Map<number, VO[]>;
 ```
 
-Defined in: [data-structures/graph/directed-graph.ts:1134](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L1134)
+Defined in: [data-structures/graph/directed-graph.ts:1164](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L1164)
 
 Strongly connected components computed by `tarjan()`.
 
@@ -1880,7 +1880,7 @@ Time O(1) avg, Space O(1)
 incomingEdgesOf(vertexOrKey): EO[];
 ```
 
-Defined in: [data-structures/graph/directed-graph.ts:553](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L553)
+Defined in: [data-structures/graph/directed-graph.ts:565](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L565)
 
 Incoming edges of a vertex.
 
@@ -1929,7 +1929,7 @@ Time O(deg_in), Space O(deg_in)
 isEmpty(): boolean;
 ```
 
-Defined in: [data-structures/graph/directed-graph.ts:936](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L936)
+Defined in: [data-structures/graph/directed-graph.ts:960](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L960)
 
 Whether the graph has no vertices and no edges.
 
@@ -2053,7 +2053,7 @@ Time O(n), Space O(n)
 outgoingEdgesOf(vertexOrKey): EO[];
 ```
 
-Defined in: [data-structures/graph/directed-graph.ts:612](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L612)
+Defined in: [data-structures/graph/directed-graph.ts:627](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L627)
 
 Outgoing edges of a vertex.
 
@@ -2301,7 +2301,7 @@ Time O(n), Space O(1)
 tarjan(): object;
 ```
 
-Defined in: [data-structures/graph/directed-graph.ts:1013](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L1013)
+Defined in: [data-structures/graph/directed-graph.ts:1040](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L1040)
 
 Tarjan's algorithm for strongly connected components.
 
@@ -2430,7 +2430,7 @@ DOT format string.
 topologicalSort(propertyName?): (VertexKey | VO)[] | undefined;
 ```
 
-Defined in: [data-structures/graph/directed-graph.ts:756](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L756)
+Defined in: [data-structures/graph/directed-graph.ts:774](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L774)
 
 Topological sort if DAG; returns `undefined` if a cycle exists.
 
@@ -2672,7 +2672,7 @@ Override in subclasses (e.g., '--' for undirected, '->' for directed).
 protected _addEdge(edge): boolean;
 ```
 
-Defined in: [data-structures/graph/directed-graph.ts:1144](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L1144)
+Defined in: [data-structures/graph/directed-graph.ts:1174](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/graph/directed-graph.ts#L1174)
 
 Internal hook to attach a directed edge into adjacency maps.
 

package/docs-site-docusaurus/docs/api/classes/Matrix.md

@@ -241,7 +241,7 @@ The number of rows.
 get size(): [number, number];
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:936](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L936)
+Defined in: [data-structures/matrix/matrix.ts:960](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L960)
 
 Returns [rows, cols] dimensions tuple.
 
@@ -277,7 +277,7 @@ The `_subtractFn` property is being returned.
 iterator: IterableIterator<number[]>;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:965](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L965)
+Defined in: [data-structures/matrix/matrix.ts:989](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L989)
 
 Iterates over rows.
 
@@ -293,7 +293,7 @@ Iterates over rows.
 add(matrix): Matrix | undefined;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:397](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L397)
+Defined in: [data-structures/matrix/matrix.ts:406](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L406)
 
 The `add` function adds two matrices together, returning a new matrix with the result.
 
@@ -348,7 +348,7 @@ current matrix with the provided `matrix` parameter.
 clone(): Matrix;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:918](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L918)
+Defined in: [data-structures/matrix/matrix.ts:942](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L942)
 
 The `clone` function returns a new instance of the Matrix class with the same data and properties
 as the original instance.
@@ -368,7 +368,7 @@ and properties as the current instance.
 dot(matrix): Matrix | undefined;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:867](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L867)
+Defined in: [data-structures/matrix/matrix.ts:891](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L891)
 
 The dot function calculates the dot product of two matrices and returns a new matrix.
 
@@ -406,7 +406,7 @@ a new Matrix object.
 flatten(): number[];
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:954](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L954)
+Defined in: [data-structures/matrix/matrix.ts:978](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L978)
 
 Returns a flat row-major array.
 
@@ -422,7 +422,7 @@ Returns a flat row-major array.
 forEach(callback): void;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:984](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L984)
+Defined in: [data-structures/matrix/matrix.ts:1008](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L1008)
 
 Visits each element with its row and column index.
 
@@ -444,7 +444,7 @@ Visits each element with its row and column index.
 get(row, col): number | undefined;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:248](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L248)
+Defined in: [data-structures/matrix/matrix.ts:251](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L251)
 
 The `get` function returns the value at the specified row and column index if it is a valid index.
 
@@ -501,7 +501,7 @@ Otherwise, it returns `undefined`.
 inverse(): Matrix | undefined;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:742](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L742)
+Defined in: [data-structures/matrix/matrix.ts:763](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L763)
 
 The `inverse` function calculates the inverse of a square matrix using Gaussian elimination.
 
@@ -536,7 +536,7 @@ a Matrix object, which represents the inverse of the original matrix.
 isMatchForCalculate(matrix): boolean;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:326](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L326)
+Defined in: [data-structures/matrix/matrix.ts:332](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L332)
 
 The function checks if the dimensions of the given matrix match the dimensions of the current
 matrix.
@@ -563,7 +563,7 @@ a boolean value.
 isValidIndex(row, col): boolean;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:908](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L908)
+Defined in: [data-structures/matrix/matrix.ts:932](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L932)
 
 The function checks if a given row and column index is valid within a specified range.
 
@@ -597,7 +597,7 @@ A boolean value is being returned.
 map(callback): Matrix;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:995](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L995)
+Defined in: [data-structures/matrix/matrix.ts:1019](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L1019)
 
 Maps each element (number → number) and returns a new Matrix.
 
@@ -619,7 +619,7 @@ Maps each element (number → number) and returns a new Matrix.
 multiply(matrix): Matrix | undefined;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:568](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L568)
+Defined in: [data-structures/matrix/matrix.ts:583](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L583)
 
 The `multiply` function performs matrix multiplication between two matrices and returns the result
 as a new matrix.
@@ -677,7 +677,7 @@ set(
    value): boolean;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:312](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L312)
+Defined in: [data-structures/matrix/matrix.ts:318](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L318)
 
 The set function updates the value at a specified row and column in a two-dimensional array.
 
@@ -733,7 +733,7 @@ set.
 subtract(matrix): Matrix | undefined;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:475](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L475)
+Defined in: [data-structures/matrix/matrix.ts:487](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L487)
 
 The `subtract` function performs element-wise subtraction between two matrices and returns a new
 matrix with the result.
@@ -773,7 +773,7 @@ a new Matrix object with the result of the subtraction operation.
 toArray(): number[][];
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:947](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L947)
+Defined in: [data-structures/matrix/matrix.ts:971](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L971)
 
 Returns a deep copy of the data as a plain 2D array.
 
@@ -789,7 +789,7 @@ Returns a deep copy of the data as a plain 2D array.
 transpose(): Matrix;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:664](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L664)
+Defined in: [data-structures/matrix/matrix.ts:682](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L682)
 
 The transpose function takes a matrix and returns a new matrix that is the transpose of the
 original matrix.
@@ -833,7 +833,7 @@ The transpose() function returns a new Matrix object with the transposed data.
 static from(data): Matrix;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:1054](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L1054)
+Defined in: [data-structures/matrix/matrix.ts:1078](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L1078)
 
 Creates a Matrix from a plain 2D array (deep copy).
 
@@ -862,7 +862,7 @@ m.get(0, 1); // 2
 static identity(n): Matrix;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:1039](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L1039)
+Defined in: [data-structures/matrix/matrix.ts:1063](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L1063)
 
 Creates an n×n identity matrix.
 
@@ -890,7 +890,7 @@ const I = Matrix.identity(3); // [[1,0,0],[0,1,0],[0,0,1]]
 static zeros(rows, cols): Matrix;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:1027](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L1027)
+Defined in: [data-structures/matrix/matrix.ts:1051](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L1051)
 
 Creates a rows×cols zero matrix.
 
@@ -928,7 +928,7 @@ protected _addScaledRow(
    scalar): void;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:1108](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L1108)
+Defined in: [data-structures/matrix/matrix.ts:1132](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L1132)
 
 The function `_addScaledRow` multiplies a row in a matrix by a scalar value and adds it to another
 row.
@@ -968,7 +968,7 @@ source row before adding them to the target row.
 protected _scaleRow(row, scalar): void;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:1090](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L1090)
+Defined in: [data-structures/matrix/matrix.ts:1114](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L1114)
 
 The function scales a specific row in a matrix by a given scalar value.
 
@@ -1000,7 +1000,7 @@ a specific row of a matrix.
 protected _swapRows(row1, row2): void;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:1077](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L1077)
+Defined in: [data-structures/matrix/matrix.ts:1101](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L1101)
 
 The function `_swapRows` swaps the positions of two rows in an array.