@lakuna/umath 1.3.4 → 1.3.5

package/src/linalg/Matrix.ts

@@ -1,14 +1,13 @@
-/**
- * A rectangular array of numbers, arranged in rows and columns.
- * @see [Matrix](https://en.wikipedia.org/wiki/Matrix_(mathematics))
- */
-export type MatrixLike = Matrix | ArrayLike<number>;
+import type { Matrix4Like } from "./Matrix4.js";
+
+/** An object that could be interpreted as a matrix. */
+export type MatrixLike = Record<number, number>;
 
 /**
  * A rectangular array of numbers, arranged in rows and columns.
  * @see [Matrix](https://en.wikipedia.org/wiki/Matrix_(mathematics))
  */
-export default interface Matrix extends ArrayLike<number> {
+export default interface Matrix extends MatrixLike {
 	/** The number of rows in this matrix. */
 	height: number;
 
@@ -16,84 +15,84 @@ export default interface Matrix extends ArrayLike<number> {
 	width: number;
 
 	/**
-	 * The Frobenius norm of this matrix.
+	 * Get the Frobenius norm of this matrix.
 	 * @see [Matrix norm](https://en.wikipedia.org/wiki/Matrix_norm)
 	 */
 	get frob(): number;
 
 	/**
-	 * Adds two matrices of the same size.
-	 * @param matrix The other matrix.
+	 * Add two matrices of the same size.
+	 * @param matrix - The other matrix.
 	 * @returns The sum of the matrices.
 	 * @see [Matrix addition](https://en.wikipedia.org/wiki/Matrix_addition)
 	 */
-	add(matrix: MatrixLike): Matrix;
+	add(matrix: Matrix4Like): MatrixLike;
 
 	/**
-	 * Creates a copy of this matrix.
+	 * Create a copy of this matrix.
 	 * @returns A copy of this matrix.
 	 */
-	clone(): Matrix;
+	clone(): MatrixLike;
 
 	/**
-	 * Copies the values of another matrix into this one.
-	 * @param matrix The matrix to copy.
+	 * Copy the values of another matrix into this one.
+	 * @param matrix - The matrix to copy.
 	 * @returns This matrix.
 	 */
-	copy(matrix: MatrixLike): this;
+	copy(matrix: Matrix4Like): this;
 
 	/**
-	 * Determines whether this matrix is roughly equivalent to another.
-	 * @param matrix The other matrix.
+	 * Determine whether or not this matrix is roughly equivalent to another.
+	 * @param matrix - The other matrix.
 	 * @returns Whether the matrices are equivalent.
 	 */
-	equals(matrix: MatrixLike): boolean;
+	equals(matrix: Matrix4Like): boolean;
 
 	/**
-	 * Determines whether this matrix is exactly equivalent to another.
-	 * @param matrix The other matrix.
+	 * Determine whether or not this matrix is exactly equivalent to another.
+	 * @param matrix - The other matrix.
 	 * @returns Whether the matrices are equivalent.
 	 */
-	exactEquals(matrix: MatrixLike): boolean;
+	exactEquals(matrix: Matrix4Like): boolean;
 
 	/**
-	 * Multiplies this matrix by another.
-	 * @param matrix The other matrix.
+	 * Multiply this matrix by another.
+	 * @param matrix - The other matrix.
 	 * @returns The product of the matrices.
 	 * @see [Matrix multiplication](https://en.wikipedia.org/wiki/Matrix_multiplication)
 	 */
-	multiply(matrix: MatrixLike): Matrix;
+	multiply(matrix: Matrix4Like): MatrixLike;
 
 	/**
-	 * Multiplies this matrix by a scalar value.
-	 * @param scalar The scalar value.
+	 * Multiply this matrix by a scalar value.
+	 * @param scalar - The scalar value.
 	 * @returns The product of the matrix and the scalar value.
 	 * @see [Matrix multiplication](https://en.wikipedia.org/wiki/Matrix_multiplication)
 	 */
-	multiplyScalar(scalar: number): Matrix;
+	multiplyScalar(scalar: number): MatrixLike;
 
 	/**
-	 * Adds this matrix to another after multiplying the other by a scalar.
-	 * @param matrix The other matrix.
-	 * @param scalar The scalar.
+	 * Add this matrix to another after multiplying the other by a scalar.
+	 * @param matrix - The other matrix.
+	 * @param scalar - The scalar.
 	 * @returns The sum.
 	 * @see [Matrix addition](https://en.wikipedia.org/wiki/Matrix_addition)
 	 * @see [Matrix multiplication](https://en.wikipedia.org/wiki/Matrix_multiplication)
 	 */
-	multiplyScalarAndAdd(matrix: MatrixLike, scalar: number): Matrix;
+	multiplyScalarAndAdd(matrix: Matrix4Like, scalar: number): MatrixLike;
 
 	/**
-	 * Subtracts another matrix from this one.
-	 * @param matrix The other matrix.
+	 * Subtract another matrix from this one.
+	 * @param matrix - The other matrix.
 	 * @returns The difference between the matrices.
 	 * @see [Matrix addition](https://en.wikipedia.org/wiki/Matrix_addition)
 	 */
-	subtract(matrix: MatrixLike): Matrix;
+	subtract(matrix: Matrix4Like): MatrixLike;
 
 	/**
-	 * Transposes this matrix.
+	 * Transpose this matrix.
 	 * @returns The transpose of this matrix.
 	 * @see [Transpose](https://en.wikipedia.org/wiki/Transpose)
 	 */
-	transpose(): Matrix;
+	transpose(): MatrixLike;
 }