data-structure-typed 2.5.2 → 2.6.0

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

@@ -6,7 +6,7 @@
 
 # Class: Matrix
 
-Defined in: [data-structures/matrix/matrix.ts:97](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/matrix.ts#L97)
+Defined in: [data-structures/matrix/matrix.ts:97](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L97)
 
 Matrix — a numeric matrix with standard linear algebra operations.
 
@@ -107,7 +107,7 @@ Matrix — a numeric matrix with standard linear algebra operations.
 new Matrix(data, options?): Matrix;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:105](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/matrix.ts#L105)
+Defined in: [data-structures/matrix/matrix.ts:105](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L105)
 
 The constructor function initializes a matrix object with the provided data and options, or with
 default values if no options are provided.
@@ -141,7 +141,7 @@ properties:
 get addFn(): (a, b) => number | undefined;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:164](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/matrix.ts#L164)
+Defined in: [data-structures/matrix/matrix.ts:164](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L164)
 
 The above function returns the value of the _addFn property.
 
@@ -161,7 +161,7 @@ The value of the property `_addFn` is being returned.
 get cols(): number;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:146](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/matrix.ts#L146)
+Defined in: [data-structures/matrix/matrix.ts:146](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L146)
 
 The function returns the value of the protected variable _cols.
 
@@ -181,7 +181,7 @@ The number of columns.
 get data(): number[][];
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:156](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/matrix.ts#L156)
+Defined in: [data-structures/matrix/matrix.ts:156](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L156)
 
 The function returns a two-dimensional array of numbers.
 
@@ -201,7 +201,7 @@ The data property, which is a two-dimensional array of numbers.
 get multiplyFn(): (a, b) => number;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:180](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/matrix.ts#L180)
+Defined in: [data-structures/matrix/matrix.ts:180](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L180)
 
 The function returns the value of the _multiplyFn property.
 
@@ -221,7 +221,7 @@ The `_multiplyFn` property is being returned.
 get rows(): number;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:136](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/matrix.ts#L136)
+Defined in: [data-structures/matrix/matrix.ts:136](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L136)
 
 The function returns the number of rows.
 
@@ -241,7 +241,7 @@ The number of rows.
 get size(): [number, number];
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:904](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/matrix.ts#L904)
+Defined in: [data-structures/matrix/matrix.ts:936](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L936)
 
 Returns [rows, cols] dimensions tuple.
 
@@ -259,7 +259,7 @@ Returns [rows, cols] dimensions tuple.
 get subtractFn(): (a, b) => number;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:172](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/matrix.ts#L172)
+Defined in: [data-structures/matrix/matrix.ts:172](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L172)
 
 The function returns the value of the _subtractFn property.
 
@@ -277,7 +277,7 @@ The `_subtractFn` property is being returned.
 iterator: IterableIterator<number[]>;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:933](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/matrix.ts#L933)
+Defined in: [data-structures/matrix/matrix.ts:965](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L965)
 
 Iterates over rows.
 
@@ -293,7 +293,7 @@ Iterates over rows.
 add(matrix): Matrix | undefined;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:385](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/matrix.ts#L385)
+Defined in: [data-structures/matrix/matrix.ts:397](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L397)
 
 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:886](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/matrix.ts#L886)
+Defined in: [data-structures/matrix/matrix.ts:918](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L918)
 
 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:835](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/matrix.ts#L835)
+Defined in: [data-structures/matrix/matrix.ts:867](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L867)
 
 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:922](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/matrix.ts#L922)
+Defined in: [data-structures/matrix/matrix.ts:954](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L954)
 
 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:952](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/matrix.ts#L952)
+Defined in: [data-structures/matrix/matrix.ts:984](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L984)
 
 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:244](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/matrix.ts#L244)
+Defined in: [data-structures/matrix/matrix.ts:248](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L248)
 
 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:714](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/matrix.ts#L714)
+Defined in: [data-structures/matrix/matrix.ts:742](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L742)
 
 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:318](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/matrix.ts#L318)
+Defined in: [data-structures/matrix/matrix.ts:326](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L326)
 
 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:876](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/matrix.ts#L876)
+Defined in: [data-structures/matrix/matrix.ts:908](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L908)
 
 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:963](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/matrix.ts#L963)
+Defined in: [data-structures/matrix/matrix.ts:995](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L995)
 
 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:548](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/matrix.ts#L548)
+Defined in: [data-structures/matrix/matrix.ts:568](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L568)
 
 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:304](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/matrix.ts#L304)
+Defined in: [data-structures/matrix/matrix.ts:312](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L312)
 
 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:459](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/matrix.ts#L459)
+Defined in: [data-structures/matrix/matrix.ts:475](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L475)
 
 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:915](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/matrix.ts#L915)
+Defined in: [data-structures/matrix/matrix.ts:947](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L947)
 
 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:640](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/matrix.ts#L640)
+Defined in: [data-structures/matrix/matrix.ts:664](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L664)
 
 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:1022](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/matrix.ts#L1022)
+Defined in: [data-structures/matrix/matrix.ts:1054](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L1054)
 
 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:1007](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/matrix.ts#L1007)
+Defined in: [data-structures/matrix/matrix.ts:1039](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L1039)
 
 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:995](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/matrix.ts#L995)
+Defined in: [data-structures/matrix/matrix.ts:1027](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L1027)
 
 Creates a rows×cols zero matrix.
 
@@ -928,7 +928,7 @@ protected _addScaledRow(
    scalar): void;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:1076](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/matrix.ts#L1076)
+Defined in: [data-structures/matrix/matrix.ts:1108](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L1108)
 
 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:1058](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/matrix.ts#L1058)
+Defined in: [data-structures/matrix/matrix.ts:1090](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L1090)
 
 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:1045](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/matrix/matrix.ts#L1045)
+Defined in: [data-structures/matrix/matrix.ts:1077](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L1077)
 
 The function `_swapRows` swaps the positions of two rows in an array.