@lakuna/umath 2.0.0 → 3.0.1

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: Readonly<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: Readonly<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: Readonly<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: Readonly<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: Readonly<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,10 @@ 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: Readonly<Matrix4Like>,
+		scalar: number
+	) => MatrixLike;
 
 	/**
 	 * Subtract another matrix from this one.
@@ -91,12 +85,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: Readonly<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.
@@ -84,7 +89,7 @@ export const fromRotation = <T extends Matrix2Like>(r: number, out: T): T => {
  * @public
  */
 export const fromScaling = <T extends Matrix2Like>(
-	vector: Vector2Like,
+	vector: Readonly<Vector2Like>,
 	out: T
 ): T => fromValues(vector[0], 0, 0, vector[1], out);
 
@@ -95,7 +100,10 @@ export const fromScaling = <T extends Matrix2Like>(
  * @returns Whether or not the matrices are equivalent.
  * @public
  */
-export const equals = (a: Matrix2Like, b: Matrix2Like): boolean =>
+export const equals = (
+	a: Readonly<Matrix2Like>,
+	b: Readonly<Matrix2Like>
+): boolean =>
 	approxRelative(a[0], b[0]) &&
 	approxRelative(a[1], b[1]) &&
 	approxRelative(a[2], b[2]) &&
@@ -108,8 +116,10 @@ export const equals = (a: Matrix2Like, b: Matrix2Like): boolean =>
  * @returns Whether the matrices are equivalent.
  * @public
  */
-export const exactEquals: (a: Matrix2Like, b: Matrix2Like) => boolean =
-	vector4ExactEquals;
+export const exactEquals: (
+	a: Readonly<Matrix2Like>,
+	b: Readonly<Matrix2Like>
+) => boolean = vector4ExactEquals;
 
 /**
  * Add two matrices.
@@ -121,8 +131,8 @@ export const exactEquals: (a: Matrix2Like, b: Matrix2Like) => boolean =
  * @public
  */
 export const add: <T extends Matrix2Like>(
-	a: Matrix2Like,
-	b: Matrix2Like,
+	a: Readonly<Matrix2Like>,
+	b: Readonly<Matrix2Like>,
 	out: T
 ) => T = vector4Add;
 
@@ -135,7 +145,7 @@ export const add: <T extends Matrix2Like>(
  * @public
  */
 export const adjoint = <T extends Matrix2Like>(
-	matrix: Matrix2Like,
+	matrix: Readonly<Matrix2Like>,
 	out: T
 ): T => fromValues(matrix[3], -matrix[1], -matrix[2], matrix[0], out);
 
@@ -146,8 +156,10 @@ export const adjoint = <T extends Matrix2Like>(
  * @returns The copy matrix.
  * @public
  */
-export const copy: <T extends Matrix2Like>(matrix: Matrix2Like, out: T) => T =
-	vector4Copy;
+export const copy: <T extends Matrix2Like>(
+	matrix: Readonly<Matrix2Like>,
+	out: T
+) => T = vector4Copy;
 
 /**
  * Calculate the Frobenius norm of a matrix.
@@ -156,7 +168,8 @@ export const copy: <T extends Matrix2Like>(matrix: Matrix2Like, out: T) => T =
  * @see {@link https://en.wikipedia.org/wiki/Matrix_norm | Matrix norm}
  * @public
  */
-export const frob: (matrix: Matrix2Like) => number = vector4GetMagnitude;
+export const frob: (matrix: Readonly<Matrix2Like>) => number =
+	vector4GetMagnitude;
 
 /**
  * Multiply one matrix by another.
@@ -168,8 +181,8 @@ export const frob: (matrix: Matrix2Like) => number = vector4GetMagnitude;
  * @public
  */
 export const multiply = <T extends Matrix2Like>(
-	a: Matrix2Like,
-	b: Matrix2Like,
+	a: Readonly<Matrix2Like>,
+	b: Readonly<Matrix2Like>,
 	out: T
 ): T => {
 	const a0 = a[0];
@@ -201,7 +214,7 @@ export const multiply = <T extends Matrix2Like>(
  * @public
  */
 export const multiplyScalar: <T extends Matrix2Like>(
-	matrix: Matrix2Like,
+	matrix: Readonly<Matrix2Like>,
 	scalar: number,
 	out: T
 ) => T = vector4Scale;
@@ -218,8 +231,8 @@ export const multiplyScalar: <T extends Matrix2Like>(
  * @public
  */
 export const multiplyScalarAndAdd: <T extends Matrix2Like>(
-	a: Matrix2Like,
-	b: Matrix2Like,
+	a: Readonly<Matrix2Like>,
+	b: Readonly<Matrix2Like>,
 	scalar: number,
 	out: T
 ) => T = vector4ScaleAndAdd;
@@ -234,8 +247,8 @@ export const multiplyScalarAndAdd: <T extends Matrix2Like>(
  * @public
  */
 export const subtract: <T extends Matrix2Like>(
-	a: Matrix2Like,
-	b: Matrix2Like,
+	a: Readonly<Matrix2Like>,
+	b: Readonly<Matrix2Like>,
 	out: T
 ) => T = vector4Subtract;
 
@@ -248,7 +261,7 @@ export const subtract: <T extends Matrix2Like>(
  * @public
  */
 export const transpose = <T extends Matrix2Like>(
-	matrix: Matrix2Like,
+	matrix: Readonly<Matrix2Like>,
 	out: T
 ): T => {
 	if (out === matrix) {
@@ -268,7 +281,7 @@ export const transpose = <T extends Matrix2Like>(
  * @see {@link https://en.wikipedia.org/wiki/Determinant | Determinant}
  * @public
  */
-export const determinant = (matrix: Matrix2Like): number =>
+export const determinant = (matrix: Readonly<Matrix2Like>): number =>
 	matrix[0] * matrix[3] - matrix[2] * matrix[1];
 
 /**
@@ -290,7 +303,7 @@ export const identity = <T extends Matrix2Like>(out: T): T =>
  * @public
  */
 export const invert = <T extends Matrix2Like>(
-	matrix: Matrix2Like,
+	matrix: Readonly<Matrix2Like>,
 	out: T
 ): T => {
 	const a0 = matrix[0];
@@ -317,7 +330,7 @@ export const invert = <T extends Matrix2Like>(
  * @public
  */
 export const rotate = <T extends Matrix2Like>(
-	matrix: Matrix2Like,
+	matrix: Readonly<Matrix2Like>,
 	r: number,
 	out: T
 ): T => {
@@ -348,8 +361,8 @@ export const rotate = <T extends Matrix2Like>(
  * @public
  */
 export const scale = <T extends Matrix2Like>(
-	matrix: Matrix2Like,
-	vector: Vector2Like,
+	matrix: Readonly<Matrix2Like>,
+	vector: Readonly<Vector2Like>,
 	out: T
 ): T => {
 	const v0 = vector[0];
@@ -371,8 +384,60 @@ export const scale = <T extends Matrix2Like>(
  */
 export default class Matrix2
 	extends Float32Array
-	implements SquareMatrix, Matrix2Like
+	implements Matrix2Like, SquareMatrix
 {
+	/** 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;
+
+	/**
+	 * Get the determinant of this matrix.
+	 * @see {@link https://en.wikipedia.org/wiki/Determinant | Determinant}
+	 */
+	public get determinant(): number {
+		return determinant(this);
+	}
+
+	/**
+	 * Get the Frobenius norm of this matrix.
+	 * @see {@link https://en.wikipedia.org/wiki/Matrix_norm | Matrix norm}
+	 */
+	public get frob(): number {
+		return frob(this);
+	}
+
+	/**
+	 * Create a two-by-two identity matrix.
+	 * @see {@link https://en.wikipedia.org/wiki/Identity_matrix | Identity matrix}
+	 */
+	public constructor() {
+		super(4);
+
+		this[0] = 1;
+		this[3] = 1;
+
+		this.width = 2;
+		this.height = 2;
+	}
+
 	/**
 	 * Create a transformation matrix that represents a rotation by the given angle around the Z-axis.
 	 * @param r - The angle in radians.
@@ -389,7 +454,7 @@ export default class Matrix2
 	 * @returns The transformation matrix.
 	 * @see {@link https://en.wikipedia.org/wiki/Transformation_matrix | Transformation matrix}
 	 */
-	public static fromScaling(vector: Vector2Like): Matrix2 {
+	public static fromScaling(vector: Readonly<Vector2Like>): Matrix2 {
 		return fromScaling(vector, new Matrix2());
 	}
 
@@ -410,63 +475,13 @@ export default class Matrix2
 		return fromValues(c0r0, c0r1, c1r0, c1r1, new Matrix2());
 	}
 
-	/**
-	 * Create a two-by-two identity matrix.
-	 * @see {@link https://en.wikipedia.org/wiki/Identity_matrix | Identity matrix}
-	 */
-	public constructor() {
-		super(4);
-
-		this[0] = 1;
-		this[3] = 1;
-
-		this.width = 2;
-		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;
-
-	/**
-	 * Determine whether or not this matrix is roughly equivalent to another.
-	 * @param matrix - The other matrix.
-	 * @returns Whether the matrices are equivalent.
-	 */
-	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);
-	}
-
 	/**
 	 * Add another matrix to this one.
 	 * @param matrix - The other matrix.
 	 * @returns The sum of the matrices.
 	 * @see {@link https://en.wikipedia.org/wiki/Matrix_addition | Matrix addition}
 	 */
-	public add(matrix: Matrix2Like): Matrix2 {
+	public add(matrix: Readonly<Matrix2Like>): Matrix2 {
 		return add(this, matrix, new Matrix2());
 	}
 
@@ -492,16 +507,44 @@ export default class Matrix2
 	 * @param matrix - The matrix to copy.
 	 * @returns This matrix.
 	 */
-	public copy(matrix: Matrix2Like): this {
+	public copy(matrix: Readonly<Matrix2Like>): this {
 		return copy(matrix, this);
 	}
 
 	/**
-	 * 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: Readonly<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: Readonly<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());
 	}
 
 	/**
@@ -511,7 +554,7 @@ export default class Matrix2
 	 * @see {@link https://en.wikipedia.org/wiki/Matrix_multiplication | Matrix multiplication}
 	 * @public
 	 */
-	public multiply(matrix: Matrix2Like): Matrix2 {
+	public multiply(matrix: Readonly<Matrix2Like>): Matrix2 {
 		return multiply(this, matrix, new Matrix2());
 	}
 
@@ -533,55 +576,13 @@ export default class Matrix2
 	 * @see {@link https://en.wikipedia.org/wiki/Matrix_addition | Matrix addition}
 	 * @see {@link https://en.wikipedia.org/wiki/Matrix_multiplication | Matrix multiplication}
 	 */
-	public multiplyScalarAndAdd(matrix: Matrix2Like, scalar: number): Matrix2 {
+	public multiplyScalarAndAdd(
+		matrix: Readonly<Matrix2Like>,
+		scalar: number
+	): Matrix2 {
 		return multiplyScalarAndAdd(this, matrix, scalar, 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());
-	}
-
-	/**
-	 * 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.
-	 * @returns The inverted matrix.
-	 * @see {@link https://en.wikipedia.org/wiki/Invertible_matrix | Invertible matrix}
-	 */
-	public invert(): Matrix2 {
-		return invert(this, new Matrix2());
-	}
-
 	/**
 	 * Rotate this matrix by the given angle.
 	 * @param r - The angle in radians.
@@ -598,7 +599,26 @@ export default class Matrix2
 	 * @returns The scaled matrix.
 	 * @see {@link https://en.wikipedia.org/wiki/Transformation_matrix | Transformation matrix}
 	 */
-	public scale(vector: Vector2Like): Matrix2 {
+	public scale(vector: Readonly<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: Readonly<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());
+	}
 }