@lakuna/umath 1.5.0 → 3.0.0

package/src/linalg/Matrix.ts

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

package/src/linalg/Matrix2.ts

@@ -1,3 +1,9 @@
+import type { MatrixLike } from "./Matrix.js";
+import type SquareMatrix from "./SquareMatrix.js";
+import type { Vector2Like } from "./Vector2.js";
+
+import approxRelative from "../algorithms/approxRelative.js";
+import SingularMatrixError from "../utility/SingularMatrixError.js";
 import {
 	add as vector4Add,
 	copy as vector4Copy,
@@ -8,11 +14,6 @@ import {
 	scaleAndAdd as vector4ScaleAndAdd,
 	subtract as vector4Subtract
 } from "./Vector4.js";
-import type { MatrixLike } from "./Matrix.js";
-import SingularMatrixError from "../utility/SingularMatrixError.js";
-import type SquareMatrix from "./SquareMatrix.js";
-import type { Vector2Like } from "./Vector2.js";
-import approxRelative from "../algorithms/approxRelative.js";
 
 /**
  * Numbers arranged into two columns and two rows.
@@ -21,15 +22,19 @@ import approxRelative from "../algorithms/approxRelative.js";
  */
 export interface Matrix2Like extends MatrixLike {
 	/** The value in the first column and first row. */
+	// eslint-disable-next-line @typescript-eslint/naming-convention
 	0: number;
 
 	/** The value in the first column and second row. */
+	// eslint-disable-next-line @typescript-eslint/naming-convention
 	1: number;
 
 	/** The value in the second column and first row. */
+	// eslint-disable-next-line @typescript-eslint/naming-convention
 	2: number;
 
 	/** The value in the second column and second row. */
+	// eslint-disable-next-line @typescript-eslint/naming-convention
 	3: number;
 }
 
@@ -38,9 +43,9 @@ export interface Matrix2Like extends MatrixLike {
  * @returns A two-by-two matrix-like object.
  * @public
  */
-export const createMatrix2Like = (): Float32Array & Matrix2Like => {
-	return new Float32Array(4) as Float32Array & Matrix2Like;
-};
+export const createMatrix2Like = (): Float32Array & Matrix2Like =>
+	// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
+	new Float32Array(4) as Float32Array & Matrix2Like;
 
 /**
  * Create a two-by-two matrix with the given values.
@@ -371,53 +376,44 @@ export const scale = <T extends Matrix2Like>(
  */
 export default class Matrix2
 	extends Float32Array
-	implements SquareMatrix, Matrix2Like
+	implements Matrix2Like, SquareMatrix
 {
-	/**
-	 * Create a transformation matrix that represents a rotation by the given angle around the Z-axis.
-	 * @param r - The angle in radians.
-	 * @param out - The matrix to store the result in.
-	 * @returns The transformation matrix.
-	 * @see {@link https://en.wikipedia.org/wiki/Rotation_matrix | Rotation matrix}
-	 */
-	public static fromRotation<T extends Matrix2Like = Matrix2>(
-		r: number,
-		out: T = new Matrix2() as Matrix2 & T
-	): T {
-		return fromRotation(r, out);
-	}
+	/** The value in the first column and first row. */
+	// eslint-disable-next-line @typescript-eslint/naming-convention
+	public 0: number;
+
+	/** The value in the first column and second row. */
+	// eslint-disable-next-line @typescript-eslint/naming-convention
+	public 1: number;
+
+	/** The value in the second column and first row. */
+	// eslint-disable-next-line @typescript-eslint/naming-convention
+	public 2: number;
+
+	/** The value in the second column and second row. */
+	// eslint-disable-next-line @typescript-eslint/naming-convention
+	public 3: number;
+
+	/** The number of rows in this matrix. */
+	public readonly height: 2;
+
+	/** The number of columns in this matrix. */
+	public readonly width: 2;
 
 	/**
-	 * Create a transformation matrix that represents a scaling by the given vector.
-	 * @param vector - The scaling vector.
-	 * @param out - The matrix to store the result in.
-	 * @returns The transformation matrix.
-	 * @see {@link https://en.wikipedia.org/wiki/Transformation_matrix | Transformation matrix}
+	 * Get the determinant of this matrix.
+	 * @see {@link https://en.wikipedia.org/wiki/Determinant | Determinant}
 	 */
-	public static fromScaling<T extends Matrix2Like = Matrix2>(
-		vector: Vector2Like,
-		out: T = new Matrix2() as Matrix2 & T
-	): T {
-		return fromScaling(vector, out);
+	public get determinant(): number {
+		return determinant(this);
 	}
 
 	/**
-	 * Create a two-by-two matrix with the given values.
-	 * @param c0r0 - The value in the first column and first row.
-	 * @param c0r1 - The value in the first column and second row.
-	 * @param c1r0 - The value in the second column and first row.
-	 * @param c1r1 - The value in the second column and second row.
-	 * @param out - The matrix to store the result in.
-	 * @returns The matrix.
+	 * Get the Frobenius norm of this matrix.
+	 * @see {@link https://en.wikipedia.org/wiki/Matrix_norm | Matrix norm}
 	 */
-	public static fromValues<T extends Matrix2Like = Matrix2>(
-		c0r0: number,
-		c0r1: number,
-		c1r0: number,
-		c1r1: number,
-		out: T = new Matrix2() as Matrix2 & T
-	): T {
-		return fromValues(c0r0, c0r1, c1r0, c1r1, out);
+	public get frob(): number {
+		return frob(this);
 	}
 
 	/**
@@ -434,77 +430,68 @@ export default class Matrix2
 		this.height = 2;
 	}
 
-	/** The value in the first column and first row. */
-	public 0: number;
-
-	/** The value in the first column and second row. */
-	public 1: number;
-
-	/** The value in the second column and first row. */
-	public 2: number;
-
-	/** The value in the second column and second row. */
-	public 3: number;
-
-	/** The number of columns in this matrix. */
-	public readonly width: 2;
-
-	/** The number of rows in this matrix. */
-	public readonly height: 2;
+	/**
+	 * Create a transformation matrix that represents a rotation by the given angle around the Z-axis.
+	 * @param r - The angle in radians.
+	 * @returns The transformation matrix.
+	 * @see {@link https://en.wikipedia.org/wiki/Rotation_matrix | Rotation matrix}
+	 */
+	public static fromRotation(r: number): Matrix2 {
+		return fromRotation(r, new Matrix2());
+	}
 
 	/**
-	 * Determine whether or not this matrix is roughly equivalent to another.
-	 * @param matrix - The other matrix.
-	 * @returns Whether the matrices are equivalent.
+	 * Create a transformation matrix that represents a scaling by the given vector.
+	 * @param vector - The scaling vector.
+	 * @returns The transformation matrix.
+	 * @see {@link https://en.wikipedia.org/wiki/Transformation_matrix | Transformation matrix}
 	 */
-	public equals(matrix: Matrix2Like): boolean {
-		return equals(this, matrix);
+	public static fromScaling(vector: Vector2Like): Matrix2 {
+		return fromScaling(vector, new Matrix2());
 	}
 
 	/**
-	 * Determine whether or not this matrix is exactly equivalent to another.
-	 * @param matrix - The other matrix.
-	 * @returns Whether the matrices are equivalent.
+	 * Create a two-by-two matrix with the given values.
+	 * @param c0r0 - The value in the first column and first row.
+	 * @param c0r1 - The value in the first column and second row.
+	 * @param c1r0 - The value in the second column and first row.
+	 * @param c1r1 - The value in the second column and second row.
+	 * @returns The matrix.
 	 */
-	public exactEquals(matrix: Matrix2Like): boolean {
-		return exactEquals(this, matrix);
+	public static fromValues(
+		c0r0: number,
+		c0r1: number,
+		c1r0: number,
+		c1r1: number
+	): Matrix2 {
+		return fromValues(c0r0, c0r1, c1r0, c1r1, new Matrix2());
 	}
 
 	/**
 	 * Add another matrix to this one.
 	 * @param matrix - The other matrix.
-	 * @param out - The matrix to store the result in.
 	 * @returns The sum of the matrices.
 	 * @see {@link https://en.wikipedia.org/wiki/Matrix_addition | Matrix addition}
 	 */
-	public add<T extends Matrix2Like = Matrix2>(
-		matrix: Matrix2Like,
-		out: T = new Matrix2() as Matrix2 & T
-	): T {
-		return add(this, matrix, out);
+	public add(matrix: Matrix2Like): Matrix2 {
+		return add(this, matrix, new Matrix2());
 	}
 
 	/**
 	 * Calculate the adjugate of this matrix.
-	 * @param out - The matrix to store the result in.
 	 * @returns The adjugate of this matrix.
 	 * @see {@link https://en.wikipedia.org/wiki/Adjugate_matrix | Adjugate matrix}
 	 */
-	public adjoint<T extends Matrix2Like = Matrix2>(
-		out: T = new Matrix2() as Matrix2 & T
-	): T {
-		return adjoint(this, out);
+	public adjoint(): Matrix2 {
+		return adjoint(this, new Matrix2());
 	}
 
 	/**
 	 * Copy the values from this matrix to another one.
-	 * @param out - The matrix to store the result in.
 	 * @returns The copy.
 	 */
-	public clone<T extends Matrix2Like = Matrix2>(
-		out: T = new Matrix2() as Matrix2 & T
-	): T {
-		return copy(this, out);
+	public clone(): Matrix2 {
+		return copy(this, new Matrix2());
 	}
 
 	/**
@@ -517,139 +504,110 @@ export default class Matrix2
 	}
 
 	/**
-	 * Get the Frobenius norm of this matrix.
-	 * @see {@link https://en.wikipedia.org/wiki/Matrix_norm | Matrix norm}
+	 * Determine whether or not this matrix is roughly equivalent to another.
+	 * @param matrix - The other matrix.
+	 * @returns Whether the matrices are equivalent.
 	 */
-	public get frob(): number {
-		return frob(this);
+	public equals(matrix: Matrix2Like): boolean {
+		return equals(this, matrix);
+	}
+
+	/**
+	 * Determine whether or not this matrix is exactly equivalent to another.
+	 * @param matrix - The other matrix.
+	 * @returns Whether the matrices are equivalent.
+	 */
+	public exactEquals(matrix: Matrix2Like): boolean {
+		return exactEquals(this, matrix);
+	}
+
+	/**
+	 * Reset this matrix to identity.
+	 * @returns This matrix.
+	 * @see {@link https://en.wikipedia.org/wiki/Identity_matrix | Identity matrix}
+	 */
+	public identity(): this {
+		return identity(this);
+	}
+
+	/**
+	 * Invert this matrix.
+	 * @returns The inverted matrix.
+	 * @see {@link https://en.wikipedia.org/wiki/Invertible_matrix | Invertible matrix}
+	 */
+	public invert(): Matrix2 {
+		return invert(this, new Matrix2());
 	}
 
 	/**
 	 * Multiply this matrix by another.
 	 * @param matrix - The other matrix.
-	 * @param out - The matrix to store the result in.
 	 * @returns The product of the matrices.
 	 * @see {@link https://en.wikipedia.org/wiki/Matrix_multiplication | Matrix multiplication}
 	 * @public
 	 */
-	public multiply<T extends Matrix2Like = Matrix2>(
-		matrix: Matrix2Like,
-		out: T = new Matrix2() as Matrix2 & T
-	): T {
-		return multiply(this, matrix, out);
+	public multiply(matrix: Matrix2Like): Matrix2 {
+		return multiply(this, matrix, new Matrix2());
 	}
 
 	/**
 	 * Multiply this matrix by a scalar value.
 	 * @param scalar - The scalar value.
-	 * @param out - The matrix to store the result in.
 	 * @returns The product of the matrix and the scalar value.
 	 * @see {@link https://en.wikipedia.org/wiki/Matrix_multiplication | Matrix multiplication}
 	 */
-	public multiplyScalar<T extends Matrix2Like = Matrix2>(
-		scalar: number,
-		out: T = new Matrix2() as Matrix2 & T
-	): T {
-		return multiplyScalar(this, scalar, out);
+	public multiplyScalar(scalar: number): Matrix2 {
+		return multiplyScalar(this, scalar, new Matrix2());
 	}
 
 	/**
 	 * Add this matrix to another after multiplying the other by a scalar.
 	 * @param matrix - The other matrix.
 	 * @param scalar - The scalar.
-	 * @param out - The matrix to store the result in.
 	 * @returns The sum.
 	 * @see {@link https://en.wikipedia.org/wiki/Matrix_addition | Matrix addition}
 	 * @see {@link https://en.wikipedia.org/wiki/Matrix_multiplication | Matrix multiplication}
 	 */
-	public multiplyScalarAndAdd<T extends Matrix2Like = Matrix2>(
-		matrix: Matrix2Like,
-		scalar: number,
-		out: T = new Matrix2() as Matrix2 & T
-	): T {
-		return multiplyScalarAndAdd(this, matrix, scalar, out);
-	}
-
-	/**
-	 * Subtract another matrix from this one.
-	 * @param matrix - The other matrix.
-	 * @param out - The matrix to store the result in.
-	 * @returns The difference between the matrices.
-	 * @see {@link https://en.wikipedia.org/wiki/Matrix_addition | Matrix addition}
-	 */
-	public subtract<T extends Matrix2Like = Matrix2>(
-		matrix: Matrix2Like,
-		out: T = new Matrix2() as Matrix2 & T
-	): T {
-		return subtract(this, matrix, out);
-	}
-
-	/**
-	 * Transpose this matrix.
-	 * @param out - The matrix to store the result in.
-	 * @returns The transpose of this matrix.
-	 * @see {@link https://en.wikipedia.org/wiki/Transpose | Transpose}
-	 */
-	public transpose<T extends Matrix2Like = Matrix2>(
-		out: T = new Matrix2() as Matrix2 & T
-	): T {
-		return transpose(this, out);
-	}
-
-	/**
-	 * Get the determinant of this matrix.
-	 * @see {@link https://en.wikipedia.org/wiki/Determinant | Determinant}
-	 */
-	public get determinant(): number {
-		return determinant(this);
-	}
-
-	/**
-	 * Reset this matrix to identity.
-	 * @returns This matrix.
-	 * @see {@link https://en.wikipedia.org/wiki/Identity_matrix | Identity matrix}
-	 */
-	public identity(): this {
-		return identity(this);
-	}
-
-	/**
-	 * Invert this matrix.
-	 * @param out - The matrix to store the result in.
-	 * @returns The inverted matrix.
-	 * @see {@link https://en.wikipedia.org/wiki/Invertible_matrix | Invertible matrix}
-	 */
-	public invert<T extends Matrix2Like = Matrix2>(
-		out: T = new Matrix2() as Matrix2 & T
-	): T {
-		return invert(this, out);
+	public multiplyScalarAndAdd(matrix: Matrix2Like, scalar: number): Matrix2 {
+		return multiplyScalarAndAdd(this, matrix, scalar, new Matrix2());
 	}
 
 	/**
 	 * Rotate this matrix by the given angle.
 	 * @param r - The angle in radians.
-	 * @param out - The matrix to store the result in.
 	 * @returns The rotated matrix.
 	 * @see {@link https://en.wikipedia.org/wiki/Rotation_matrix | Rotation matrix}
 	 */
-	public rotate<T extends Matrix2Like = Matrix2>(
-		r: number,
-		out: T = new Matrix2() as Matrix2 & T
-	): T {
-		return rotate(this, r, out);
+	public rotate(r: number): Matrix2 {
+		return rotate(this, r, new Matrix2());
 	}
 
 	/**
 	 * Scale this matrix by the given vector.
 	 * @param vector - The scaling vector.
-	 * @param out - The matrix to store the result in.
 	 * @returns The scaled matrix.
 	 * @see {@link https://en.wikipedia.org/wiki/Transformation_matrix | Transformation matrix}
 	 */
-	public scale<T extends Matrix2Like = Matrix2>(
-		vector: Vector2Like,
-		out: T = new Matrix2() as Matrix2 & T
-	): T {
-		return scale(this, vector, out);
+	public scale(vector: Vector2Like): Matrix2 {
+		return scale(this, vector, new Matrix2());
+	}
+
+	/**
+	 * Subtract another matrix from this one.
+	 * @param matrix - The other matrix.
+	 * @returns The difference between the matrices.
+	 * @see {@link https://en.wikipedia.org/wiki/Matrix_addition | Matrix addition}
+	 */
+	public subtract(matrix: Matrix2Like): Matrix2 {
+		return subtract(this, matrix, new Matrix2());
+	}
+
+	/**
+	 * Transpose this matrix.
+	 * @returns The transpose of this matrix.
+	 * @see {@link https://en.wikipedia.org/wiki/Transpose | Transpose}
+	 */
+	public transpose(): Matrix2 {
+		return transpose(this, new Matrix2());
 	}
 }