data-structure-typed 2.6.1 → 2.6.2

package/dist/esm/matrix.mjs

@@ -113,138 +113,96 @@ var Matrix = class _Matrix {
     return this._multiplyFn;
   }
   /**
-    * The `get` function returns the value at the specified row and column index if it is a valid index.
-    * @param {number} row - The `row` parameter represents the row index of the element you want to
-    * retrieve from the data array.
-    * @param {number} col - The parameter "col" represents the column number of the element you want to
-    * retrieve from the data array.
-    * @returns The `get` function returns a number if the provided row and column indices are valid.
-    * Otherwise, it returns `undefined`.
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-     * @example
-  * // Get and set individual cells
-  *  const m = new Matrix([
-  *       [0, 0, 0],
-  *       [0, 0, 0]
-  *     ]);
-  *
-  *     m.set(0, 1, 42);
-  *     m.set(1, 2, 99);
-  *
-  *     console.log(m.get(0, 1)); // 42;
-  *     console.log(m.get(1, 2)); // 99;
-  *     console.log(m.get(0, 0)); // 0;
-  *
-  *     // Out of bounds returns undefined
-  *     console.log(m.get(5, 5)); // undefined;
-    */
+   * Returns [rows, cols] dimensions tuple.
+   */
+  get size() {
+    return [this._rows, this._cols];
+  }
+  /**
+   * Creates a rows×cols zero matrix.
+   * @example
+   * ```ts
+   * const z = Matrix.zeros(2, 3); // [[0,0,0],[0,0,0]]
+   * ```
+   */
+  static zeros(rows, cols) {
+    const data = Array.from({ length: rows }, () => new Array(cols).fill(0));
+    return new _Matrix(data);
+  }
+  /**
+   * Creates an n×n identity matrix.
+   * @example
+   * ```ts
+   * const I = Matrix.identity(3); // [[1,0,0],[0,1,0],[0,0,1]]
+   * ```
+   */
+  static identity(n) {
+    const data = Array.from(
+      { length: n },
+      (_, i) => Array.from({ length: n }, (_2, j) => i === j ? 1 : 0)
+    );
+    return new _Matrix(data);
+  }
+  /**
+   * Creates a Matrix from a plain 2D array (deep copy).
+   * @example
+   * ```ts
+   * const m = Matrix.from([[1, 2], [3, 4]]);
+   * m.get(0, 1); // 2
+   * ```
+   */
+  static from(data) {
+    return new _Matrix(data.map((row) => [...row]));
+  }
+  /**
+   * The `get` function returns the value at the specified row and column index if it is a valid index.
+   * @param {number} row - The `row` parameter represents the row index of the element you want to
+   * retrieve from the data array.
+   * @param {number} col - The parameter "col" represents the column number of the element you want to
+   * retrieve from the data array.
+   * @returns The `get` function returns a number if the provided row and column indices are valid.
+   * Otherwise, it returns `undefined`.
+   * @example
+   * // Get and set individual cells
+   *  const m = new Matrix([
+   *       [0, 0, 0],
+   *       [0, 0, 0]
+   *     ]);
+   *
+   *     m.set(0, 1, 42);
+   *     m.set(1, 2, 99);
+   *
+   *     console.log(m.get(0, 1)); // 42;
+   *     console.log(m.get(1, 2)); // 99;
+   *     console.log(m.get(0, 0)); // 0;
+   *
+   *     // Out of bounds returns undefined
+   *     console.log(m.get(5, 5)); // undefined;
+   */
   get(row, col) {
     if (this.isValidIndex(row, col)) {
       return this.data[row][col];
     }
   }
   /**
-    * The set function updates the value at a specified row and column in a two-dimensional array.
-    * @param {number} row - The "row" parameter represents the row index of the element in a
-    * two-dimensional array or matrix. It specifies the row where the value will be set.
-    * @param {number} col - The "col" parameter represents the column index of the element in a
-    * two-dimensional array.
-    * @param {number} value - The value parameter represents the number that you want to set at the
-    * specified row and column in the data array.
-    * @returns a boolean value. It returns true if the index (row, col) is valid and the value is
-    * successfully set in the data array. It returns false if the index is invalid and the value is not
-    * set.
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-     * @example
-  * // Modify individual cells
-  *  const m = Matrix.zeros(2, 2);
-  *     console.log(m.set(0, 0, 5)); // true;
-  *     console.log(m.set(1, 1, 10)); // true;
-  *     console.log(m.get(0, 0)); // 5;
-  *     console.log(m.get(1, 1)); // 10;
-    */
+   * The set function updates the value at a specified row and column in a two-dimensional array.
+   * @param {number} row - The "row" parameter represents the row index of the element in a
+   * two-dimensional array or matrix. It specifies the row where the value will be set.
+   * @param {number} col - The "col" parameter represents the column index of the element in a
+   * two-dimensional array.
+   * @param {number} value - The value parameter represents the number that you want to set at the
+   * specified row and column in the data array.
+   * @returns a boolean value. It returns true if the index (row, col) is valid and the value is
+   * successfully set in the data array. It returns false if the index is invalid and the value is not
+   * set.
+   * @example
+   * // Modify individual cells
+   *  const m = Matrix.zeros(2, 2);
+   *     console.log(m.set(0, 0, 5)); // true;
+   *     console.log(m.set(1, 1, 10)); // true;
+   *     console.log(m.get(0, 0)); // 5;
+   *     console.log(m.get(1, 1)); // 10;
+   */
   set(row, col, value) {
     if (this.isValidIndex(row, col)) {
       this.data[row][col] = value;
@@ -262,75 +220,33 @@ var Matrix = class _Matrix {
     return this.rows === matrix.rows && this.cols === matrix.cols;
   }
   /**
-    * The `add` function adds two matrices together, returning a new matrix with the result.
-    * @param {Matrix} matrix - The `matrix` parameter is an instance of the `Matrix` class.
-    * @returns The `add` method returns a new `Matrix` object that represents the result of adding the
-    * current matrix with the provided `matrix` parameter.
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-     * @example
-  * // Basic matrix arithmetic
-  *  const a = new Matrix([
-  *       [1, 2],
-  *       [3, 4]
-  *     ]);
-  *     const b = new Matrix([
-  *       [5, 6],
-  *       [7, 8]
-  *     ]);
-  *
-  *     const sum = a.add(b);
-  *     console.log(sum?.data); // [
-  *  //      [6, 8],
-  *  //      [10, 12]
-  *  //    ];
-  *
-  *     const diff = b.subtract(a);
-  *     console.log(diff?.data); // [
-  *  //      [4, 4],
-  *  //      [4, 4]
-  *  //    ];
-    */
+   * The `add` function adds two matrices together, returning a new matrix with the result.
+   * @param {Matrix} matrix - The `matrix` parameter is an instance of the `Matrix` class.
+   * @returns The `add` method returns a new `Matrix` object that represents the result of adding the
+   * current matrix with the provided `matrix` parameter.
+   * @example
+   * // Basic matrix arithmetic
+   *  const a = new Matrix([
+   *       [1, 2],
+   *       [3, 4]
+   *     ]);
+   *     const b = new Matrix([
+   *       [5, 6],
+   *       [7, 8]
+   *     ]);
+   *
+   *     const sum = a.add(b);
+   *     console.log(sum?.data); // [
+   *  //      [6, 8],
+   *  //      [10, 12]
+   *  //    ];
+   *
+   *     const diff = b.subtract(a);
+   *     console.log(diff?.data); // [
+   *  //      [4, 4],
+   *  //      [4, 4]
+   *  //    ];
+   */
   add(matrix) {
     if (!this.isMatchForCalculate(matrix)) {
       raise(Error, ERR.matrixDimensionMismatch("addition"));
@@ -354,60 +270,27 @@ var Matrix = class _Matrix {
     });
   }
   /**
-    * The `subtract` function performs element-wise subtraction between two matrices and returns a new
-    * matrix with the result.
-    * @param {Matrix} matrix - The `matrix` parameter is an instance of the `Matrix` class. It
-    * represents the matrix that you want to subtract from the current matrix.
-    * @returns a new Matrix object with the result of the subtraction operation.
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-     * @example
-  * // Element-wise subtraction
-  *  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]];
-    */
+   * The `subtract` function performs element-wise subtraction between two matrices and returns a new
+   * matrix with the result.
+   * @param {Matrix} matrix - The `matrix` parameter is an instance of the `Matrix` class. It
+   * represents the matrix that you want to subtract from the current matrix.
+   * @returns a new Matrix object with the result of the subtraction operation.
+   * @example
+   * // Element-wise subtraction
+   *  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]
+   *  //    ];
+   */
   subtract(matrix) {
     if (!this.isMatchForCalculate(matrix)) {
       raise(Error, ERR.matrixDimensionMismatch("subtraction"));
@@ -431,75 +314,33 @@ var Matrix = class _Matrix {
     });
   }
   /**
-    * The `multiply` function performs matrix multiplication between two matrices and returns the result
-    * as a new matrix.
-    * @param {Matrix} matrix - The `matrix` parameter is an instance of the `Matrix` class.
-    * @returns a new Matrix object.
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-     * @example
-  * // Matrix multiplication for transformations
-  *  // 2x3 matrix * 3x2 matrix = 2x2 matrix
-  *     const a = new Matrix([
-  *       [1, 2, 3],
-  *       [4, 5, 6]
-  *     ]);
-  *     const b = new Matrix([
-  *       [7, 8],
-  *       [9, 10],
-  *       [11, 12]
-  *     ]);
-  *
-  *     const product = a.multiply(b);
-  *     console.log(product?.rows); // 2;
-  *     console.log(product?.cols); // 2;
-  *     // Row 0: 1*7+2*9+3*11=58, 1*8+2*10+3*12=64
-  *     // Row 1: 4*7+5*9+6*11=139, 4*8+5*10+6*12=154
-  *     console.log(product?.data); // [
-  *  //      [58, 64],
-  *  //      [139, 154]
-  *  //    ];
-    */
+   * The `multiply` function performs matrix multiplication between two matrices and returns the result
+   * as a new matrix.
+   * @param {Matrix} matrix - The `matrix` parameter is an instance of the `Matrix` class.
+   * @returns a new Matrix object.
+   * @example
+   * // Matrix multiplication for transformations
+   *  // 2x3 matrix * 3x2 matrix = 2x2 matrix
+   *     const a = new Matrix([
+   *       [1, 2, 3],
+   *       [4, 5, 6]
+   *     ]);
+   *     const b = new Matrix([
+   *       [7, 8],
+   *       [9, 10],
+   *       [11, 12]
+   *     ]);
+   *
+   *     const product = a.multiply(b);
+   *     console.log(product?.rows); // 2;
+   *     console.log(product?.cols); // 2;
+   *     // Row 0: 1*7+2*9+3*11=58, 1*8+2*10+3*12=64
+   *     // Row 1: 4*7+5*9+6*11=139, 4*8+5*10+6*12=154
+   *     console.log(product?.data); // [
+   *  //      [58, 64],
+   *  //      [139, 154]
+   *  //    ];
+   */
   multiply(matrix) {
     if (this.cols !== matrix.rows) {
       raise(Error, ERR.matrixDimensionMismatch("multiplication (A.cols must equal B.rows)"));
@@ -530,71 +371,29 @@ var Matrix = class _Matrix {
     });
   }
   /**
-    * The transpose function takes a matrix and returns a new matrix that is the transpose of the
-    * original matrix.
-    * @returns The transpose() function returns a new Matrix object with the transposed data.
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-     * @example
-  * // Matrix transpose (square matrix)
-  *  const m = new Matrix([
-  *       [1, 2, 3],
-  *       [4, 5, 6],
-  *       [7, 8, 9]
-  *     ]);
-  *
-  *     const transposed = m.transpose();
-  *     console.log(transposed.rows); // 3;
-  *     console.log(transposed.cols); // 3;
-  *     console.log(transposed.data); // [
-  *  //      [1, 4, 7],
-  *  //      [2, 5, 8],
-  *  //      [3, 6, 9]
-  *  //    ];
-  *
-  *     // Transpose of transpose = original
-  *     console.log(transposed.transpose().data); // m.data;
-    */
+   * The transpose function takes a matrix and returns a new matrix that is the transpose of the
+   * original matrix.
+   * @returns The transpose() function returns a new Matrix object with the transposed data.
+   * @example
+   * // Matrix transpose (square matrix)
+   *  const m = new Matrix([
+   *       [1, 2, 3],
+   *       [4, 5, 6],
+   *       [7, 8, 9]
+   *     ]);
+   *
+   *     const transposed = m.transpose();
+   *     console.log(transposed.rows); // 3;
+   *     console.log(transposed.cols); // 3;
+   *     console.log(transposed.data); // [
+   *  //      [1, 4, 7],
+   *  //      [2, 5, 8],
+   *  //      [3, 6, 9]
+   *  //    ];
+   *
+   *     // Transpose of transpose = original
+   *     console.log(transposed.transpose().data); // m.data;
+   */
   transpose() {
     if (this.data.some((row) => row.length !== this.cols)) {
       raise(Error, ERR.matrixNotRectangular());
@@ -615,63 +414,25 @@ var Matrix = class _Matrix {
       multiplyFn: this.multiplyFn
     });
   }
+  // ─── Standard interface ─────────────────────────────────────
   /**
-    * The `inverse` function calculates the inverse of a square matrix using Gaussian elimination.
-    * @returns a Matrix object, which represents the inverse of the original matrix.
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-     * @example
-  * // Compute the inverse of a 2x2 matrix
-  *  const m = Matrix.from([[4, 7], [2, 6]]);
-  *     const inv = m.inverse();
-  *     console.log(inv); // defined;
-  *     // A * A^-1 should ≈ Identity
-  *     const product = m.multiply(inv!);
-  *     console.log(product?.get(0, 0)); // toBeCloseTo;
-  *     console.log(product?.get(0, 1)); // toBeCloseTo;
-  *     console.log(product?.get(1, 0)); // toBeCloseTo;
-  *     console.log(product?.get(1, 1)); // toBeCloseTo;
-    */
+   * The `inverse` function calculates the inverse of a square matrix using Gaussian elimination.
+   * @returns a Matrix object, which represents the inverse of the original matrix.
+   * @example
+   * // Compute the inverse of a 2x2 matrix
+   *  const m = Matrix.from([
+   *       [4, 7],
+   *       [2, 6]
+   *     ]);
+   *     const inv = m.inverse();
+   *     console.log(inv); // defined;
+   *     // A * A^-1 should ≈ Identity
+   *     const product = m.multiply(inv!);
+   *     console.log(product?.get(0, 0)); // toBeCloseTo;
+   *     console.log(product?.get(0, 1)); // toBeCloseTo;
+   *     console.log(product?.get(1, 0)); // toBeCloseTo;
+   *     console.log(product?.get(1, 1)); // toBeCloseTo;
+   */
   inverse() {
     if (this.rows !== this.cols) {
       raise(Error, ERR.matrixNotSquare());
@@ -725,58 +486,25 @@ var Matrix = class _Matrix {
     });
   }
   /**
-    * The dot function calculates the dot product of two matrices and returns a new matrix.
-    * @param {Matrix} matrix - The `matrix` parameter is an instance of the `Matrix` class.
-    * @returns a new Matrix object.
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-     * @example
-  * // Dot product of two matrices
-  *  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]];
-    */
+   * The dot function calculates the dot product of two matrices and returns a new matrix.
+   * @param {Matrix} matrix - The `matrix` parameter is an instance of the `Matrix` class.
+   * @returns a new Matrix object.
+   * @example
+   * // Dot product of two matrices
+   *  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]
+   *  //    ];
+   */
   dot(matrix) {
     if (this.cols !== matrix.rows) {
       raise(Error, ERR.matrixDimensionMismatch("dot product (A.cols must equal B.rows)"));
@@ -835,13 +563,6 @@ var Matrix = class _Matrix {
       }
     );
   }
-  // ─── Standard interface ─────────────────────────────────────
-  /**
-   * Returns [rows, cols] dimensions tuple.
-   */
-  get size() {
-    return [this._rows, this._cols];
-  }
   isEmpty() {
     return this._rows === 0 || this._cols === 0;
   }
@@ -879,6 +600,7 @@ var Matrix = class _Matrix {
       }
     };
   }
+  // ─── Factory methods ────────────────────────────────────────
   /**
    * Visits each element with its row and column index.
    */
@@ -913,43 +635,6 @@ var Matrix = class _Matrix {
       console.log(row.join("	"));
     }
   }
-  // ─── Factory methods ────────────────────────────────────────
-  /**
-   * Creates a rows×cols zero matrix.
-   * @example
-   * ```ts
-   * const z = Matrix.zeros(2, 3); // [[0,0,0],[0,0,0]]
-   * ```
-   */
-  static zeros(rows, cols) {
-    const data = Array.from({ length: rows }, () => new Array(cols).fill(0));
-    return new _Matrix(data);
-  }
-  /**
-   * Creates an n×n identity matrix.
-   * @example
-   * ```ts
-   * const I = Matrix.identity(3); // [[1,0,0],[0,1,0],[0,0,1]]
-   * ```
-   */
-  static identity(n) {
-    const data = Array.from(
-      { length: n },
-      (_, i) => Array.from({ length: n }, (_2, j) => i === j ? 1 : 0)
-    );
-    return new _Matrix(data);
-  }
-  /**
-   * Creates a Matrix from a plain 2D array (deep copy).
-   * @example
-   * ```ts
-   * const m = Matrix.from([[1, 2], [3, 4]]);
-   * m.get(0, 1); // 2
-   * ```
-   */
-  static from(data) {
-    return new _Matrix(data.map((row) => [...row]));
-  }
   _addFn(a, b) {
     if (a === void 0) return b;
     return a + b;