data-structure-typed 2.6.1 → 2.6.2

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

@@ -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/main/src/data-structures/matrix/matrix.ts#L164)
+Defined in: [data-structures/matrix/matrix.ts:163](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L163)
 
 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/main/src/data-structures/matrix/matrix.ts#L146)
+Defined in: [data-structures/matrix/matrix.ts:145](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L145)
 
 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/main/src/data-structures/matrix/matrix.ts#L156)
+Defined in: [data-structures/matrix/matrix.ts:155](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L155)
 
 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/main/src/data-structures/matrix/matrix.ts#L180)
+Defined in: [data-structures/matrix/matrix.ts:179](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L179)
 
 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/main/src/data-structures/matrix/matrix.ts#L136)
+Defined in: [data-structures/matrix/matrix.ts:135](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L135)
 
 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:960](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L960)
+Defined in: [data-structures/matrix/matrix.ts:186](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L186)
 
 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/main/src/data-structures/matrix/matrix.ts#L172)
+Defined in: [data-structures/matrix/matrix.ts:171](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L171)
 
 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:989](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L989)
+Defined in: [data-structures/matrix/matrix.ts:688](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L688)
 
 Iterates over rows.
 
@@ -293,7 +293,7 @@ Iterates over rows.
 add(matrix): Matrix | undefined;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:406](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L406)
+Defined in: [data-structures/matrix/matrix.ts:324](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L324)
 
 The `add` function adds two matrices together, returning a new matrix with the result.
 
@@ -312,8 +312,6 @@ The `matrix` parameter is an instance of the `Matrix` class.
 The `add` method returns a new `Matrix` object that represents the result of adding the
 current matrix with the provided `matrix` parameter.
 
- *
-
 #### Example
 
 ```ts
@@ -348,7 +346,7 @@ current matrix with the provided `matrix` parameter.
 clone(): Matrix;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:942](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L942)
+Defined in: [data-structures/matrix/matrix.ts:650](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L650)
 
 The `clone` function returns a new instance of the Matrix class with the same data and properties
 as the original instance.
@@ -368,7 +366,7 @@ and properties as the current instance.
 dot(matrix): Matrix | undefined;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:891](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L891)
+Defined in: [data-structures/matrix/matrix.ts:601](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L601)
 
 The dot function calculates the dot product of two matrices and returns a new matrix.
 
@@ -386,16 +384,23 @@ The `matrix` parameter is an instance of the `Matrix` class.
 
 a new Matrix object.
 
- *
-
 #### Example
 
 ```ts
 // Dot product of two matrices
- const a = Matrix.from([[1, 2], [3, 4]]);
-    const b = Matrix.from([[5, 6], [7, 8]]);
+ const a = Matrix.from([
+      [1, 2],
+      [3, 4]
+    ]);
+    const b = Matrix.from([
+      [5, 6],
+      [7, 8]
+    ]);
     const result = a.dot(b);
-    console.log(result?.toArray()); // [[19, 22], [43, 50]];
+    console.log(result?.toArray()); // [
+ //      [19, 22],
+ //      [43, 50]
+ //    ];
 ```
 
 ***
@@ -406,7 +411,7 @@ a new Matrix object.
 flatten(): number[];
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:978](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L978)
+Defined in: [data-structures/matrix/matrix.ts:677](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L677)
 
 Returns a flat row-major array.
 
@@ -422,7 +427,7 @@ Returns a flat row-major array.
 forEach(callback): void;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:1008](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L1008)
+Defined in: [data-structures/matrix/matrix.ts:709](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L709)
 
 Visits each element with its row and column index.
 
@@ -444,7 +449,7 @@ Visits each element with its row and column index.
 get(row, col): number | undefined;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:251](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L251)
+Defined in: [data-structures/matrix/matrix.ts:253](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L253)
 
 The `get` function returns the value at the specified row and column index if it is a valid index.
 
@@ -471,8 +476,6 @@ retrieve from the data array.
 The `get` function returns a number if the provided row and column indices are valid.
 Otherwise, it returns `undefined`.
 
- *
-
 #### Example
 
 ```ts
@@ -501,7 +504,7 @@ Otherwise, it returns `undefined`.
 inverse(): Matrix | undefined;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:763](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L763)
+Defined in: [data-structures/matrix/matrix.ts:518](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L518)
 
 The `inverse` function calculates the inverse of a square matrix using Gaussian elimination.
 
@@ -511,13 +514,14 @@ The `inverse` function calculates the inverse of a square matrix using Gaussian
 
 a Matrix object, which represents the inverse of the original matrix.
 
- *
-
 #### Example
 
 ```ts
 // Compute the inverse of a 2x2 matrix
- const m = Matrix.from([[4, 7], [2, 6]]);
+ const m = Matrix.from([
+      [4, 7],
+      [2, 6]
+    ]);
     const inv = m.inverse();
     console.log(inv); // defined;
     // A * A^-1 should ≈ Identity
@@ -536,7 +540,7 @@ a Matrix object, which represents the inverse of the original matrix.
 isMatchForCalculate(matrix): boolean;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:332](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L332)
+Defined in: [data-structures/matrix/matrix.ts:292](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L292)
 
 The function checks if the dimensions of the given matrix match the dimensions of the current
 matrix.
@@ -563,7 +567,7 @@ a boolean value.
 isValidIndex(row, col): boolean;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:932](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L932)
+Defined in: [data-structures/matrix/matrix.ts:640](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L640)
 
 The function checks if a given row and column index is valid within a specified range.
 
@@ -597,7 +601,7 @@ A boolean value is being returned.
 map(callback): Matrix;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:1019](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L1019)
+Defined in: [data-structures/matrix/matrix.ts:720](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L720)
 
 Maps each element (number → number) and returns a new Matrix.
 
@@ -619,7 +623,7 @@ Maps each element (number → number) and returns a new Matrix.
 multiply(matrix): Matrix | undefined;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:583](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L583)
+Defined in: [data-structures/matrix/matrix.ts:422](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L422)
 
 The `multiply` function performs matrix multiplication between two matrices and returns the result
 as a new matrix.
@@ -638,8 +642,6 @@ The `matrix` parameter is an instance of the `Matrix` class.
 
 a new Matrix object.
 
- *
-
 #### Example
 
 ```ts
@@ -677,7 +679,7 @@ set(
    value): boolean;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:318](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L318)
+Defined in: [data-structures/matrix/matrix.ts:278](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L278)
 
 The set function updates the value at a specified row and column in a two-dimensional array.
 
@@ -712,8 +714,6 @@ a boolean value. It returns true if the index (row, col) is valid and the value
 successfully set in the data array. It returns false if the index is invalid and the value is not
 set.
 
- *
-
 #### Example
 
 ```ts
@@ -733,7 +733,7 @@ set.
 subtract(matrix): Matrix | undefined;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:487](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L487)
+Defined in: [data-structures/matrix/matrix.ts:370](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L370)
 
 The `subtract` function performs element-wise subtraction between two matrices and returns a new
 matrix with the result.
@@ -753,16 +753,23 @@ represents the matrix that you want to subtract from the current matrix.
 
 a new Matrix object with the result of the subtraction operation.
 
- *
-
 #### Example
 
 ```ts
 // Element-wise subtraction
- const a = Matrix.from([[5, 6], [7, 8]]);
-    const b = Matrix.from([[1, 2], [3, 4]]);
+ const a = Matrix.from([
+      [5, 6],
+      [7, 8]
+    ]);
+    const b = Matrix.from([
+      [1, 2],
+      [3, 4]
+    ]);
     const result = a.subtract(b);
-    console.log(result?.toArray()); // [[4, 4], [4, 4]];
+    console.log(result?.toArray()); // [
+ //      [4, 4],
+ //      [4, 4]
+ //    ];
 ```
 
 ***
@@ -773,7 +780,7 @@ a new Matrix object with the result of the subtraction operation.
 toArray(): number[][];
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:971](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L971)
+Defined in: [data-structures/matrix/matrix.ts:670](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L670)
 
 Returns a deep copy of the data as a plain 2D array.
 
@@ -789,7 +796,7 @@ Returns a deep copy of the data as a plain 2D array.
 transpose(): Matrix;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:682](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L682)
+Defined in: [data-structures/matrix/matrix.ts:477](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L477)
 
 The transpose function takes a matrix and returns a new matrix that is the transpose of the
 original matrix.
@@ -800,8 +807,6 @@ original matrix.
 
 The transpose() function returns a new Matrix object with the transposed data.
 
- *
-
 #### Example
 
 ```ts
@@ -833,7 +838,7 @@ The transpose() function returns a new Matrix object with the transposed data.
 static from(data): Matrix;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:1078](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L1078)
+Defined in: [data-structures/matrix/matrix.ts:224](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L224)
 
 Creates a Matrix from a plain 2D array (deep copy).
 
@@ -862,7 +867,7 @@ m.get(0, 1); // 2
 static identity(n): Matrix;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:1063](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L1063)
+Defined in: [data-structures/matrix/matrix.ts:209](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L209)
 
 Creates an n×n identity matrix.
 
@@ -890,7 +895,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:1051](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L1051)
+Defined in: [data-structures/matrix/matrix.ts:197](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L197)
 
 Creates a rows×cols zero matrix.
 
@@ -928,7 +933,7 @@ protected _addScaledRow(
    scalar): void;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:1132](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L1132)
+Defined in: [data-structures/matrix/matrix.ts:793](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L793)
 
 The function `_addScaledRow` multiplies a row in a matrix by a scalar value and adds it to another
 row.
@@ -968,7 +973,7 @@ source row before adding them to the target row.
 protected _scaleRow(row, scalar): void;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:1114](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L1114)
+Defined in: [data-structures/matrix/matrix.ts:775](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L775)
 
 The function scales a specific row in a matrix by a given scalar value.
 
@@ -1000,7 +1005,7 @@ a specific row of a matrix.
 protected _swapRows(row1, row2): void;
 ```
 
-Defined in: [data-structures/matrix/matrix.ts:1101](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L1101)
+Defined in: [data-structures/matrix/matrix.ts:762](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/matrix/matrix.ts#L762)
 
 The function `_swapRows` swaps the positions of two rows in an array.