@lakuna/umath 1.3.5 → 1.3.7

package/dist/linalg/Matrix3.js

@@ -1,9 +1,20 @@
 import SingularMatrixError from "../utility/SingularMatrixError.js";
 import epsilon from "../utility/epsilon.js";
-export function createMatrix3Like() {
+/**
+ * Creates a 3x3 matrix-like object.
+ * @returns A 3x3 matrix-like object.
+ */
+export const createMatrix3Like = () => {
     return new Float32Array(9);
-}
-export function fromRotation(r, out) {
+};
+/**
+ * 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 [Rotation matrix](https://en.wikipedia.org/wiki/Rotation_matrix)
+ */
+export const fromRotation = (r, out) => {
     const s = Math.sin(r);
     const c = Math.cos(r);
     out[0] = c;
@@ -16,8 +27,15 @@ export function fromRotation(r, out) {
     out[7] = 0;
     out[8] = 1;
     return out;
-}
-export function fromScaling(vector, out) {
+};
+/**
+ * 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 [Transformation matrix](https://en.wikipedia.org/wiki/Transformation_matrix)
+ */
+export const fromScaling = (vector, out) => {
     out[0] = vector[0];
     out[1] = 0;
     out[2] = 0;
@@ -28,8 +46,15 @@ export function fromScaling(vector, out) {
     out[7] = 0;
     out[8] = 1;
     return out;
-}
-export function fromTranslation(vector, out) {
+};
+/**
+ * Create a transformation matrix that represents a translation by the given vector.
+ * @param vector - The translation vector.
+ * @param out - The matrix to store the result in.
+ * @returns The transformation matrix.
+ * @see [Transformation matrix](https://en.wikipedia.org/wiki/Transformation_matrix)
+ */
+export const fromTranslation = (vector, out) => {
     out[0] = 1;
     out[1] = 0;
     out[2] = 0;
@@ -40,8 +65,16 @@ export function fromTranslation(vector, out) {
     out[7] = vector[1];
     out[8] = 1;
     return out;
-}
-export function fromQuaternion(quaternion, out) {
+};
+/**
+ * Create a transformation matrix that represents a rotation by the given quaternion.
+ * @param quaternion - The quaternion.
+ * @param out - The matrix to store the result in.
+ * @returns The transformation matrix.
+ * @see [Quaternion](https://en.wikipedia.org/wiki/Quaternion)
+ * @see [Rotation matrix](https://en.wikipedia.org/wiki/Rotation_matrix)
+ */
+export const fromQuaternion = (quaternion, out) => {
     const x = quaternion[0];
     const y = quaternion[1];
     const z = quaternion[2];
@@ -68,8 +101,15 @@ export function fromQuaternion(quaternion, out) {
     out[5] = zy + wx;
     out[8] = 1 - xx - yy;
     return out;
-}
-export function normalFromMatrix4(matrix, out) {
+};
+/**
+ * Calculate a three-by-three normal (inverse transpose) matrix from a four-by-four matrix.
+ * @param matrix - The four-by-four matrix.
+ * @param out - The matrix to store the result in.
+ * @returns The normal matrix.
+ * @see [Normal matrix](https://en.wikipedia.org/wiki/Normal_matrix)
+ */
+export const normalFromMatrix4 = (matrix, out) => {
     const a00 = matrix[0];
     const a01 = matrix[1];
     const a02 = matrix[2];
@@ -113,8 +153,17 @@ export function normalFromMatrix4(matrix, out) {
     out[7] = (a32 * b02 - a30 * b05 - a33 * b01) * det;
     out[8] = (a30 * b04 - a31 * b02 + a33 * b00) * det;
     return out;
-}
-export function projection(width, height, out) {
+};
+/**
+ * Generate a two-dimensional projection matrix with the given bounds.
+ * @param width - The width of the projection.
+ * @param height - The height of the projection.
+ * @param out - The matrix to store the result in.
+ * @returns The projection matrix.
+ * @see [Camera matrix](https://en.wikipedia.org/wiki/Camera_matrix)
+ * @see [3D projection](https://en.wikipedia.org/wiki/3D_projection)
+ */
+export const projection = (width, height, out) => {
     out[0] = 2 / width;
     out[1] = 0;
     out[2] = 0;
@@ -125,8 +174,14 @@ export function projection(width, height, out) {
     out[7] = 1;
     out[8] = 1;
     return out;
-}
-export function fromMatrix4(matrix, out) {
+};
+/**
+ * Create a three-by-three matrix from the upper-left corner of a four-by-four matrix.
+ * @param matrix - The four-by-four matrix.
+ * @param out - The matrix to store the result in.
+ * @returns The three-by-three matrix.
+ */
+export const fromMatrix4 = (matrix, out) => {
     out[0] = matrix[0];
     out[1] = matrix[1];
     out[2] = matrix[2];
@@ -137,8 +192,22 @@ export function fromMatrix4(matrix, out) {
     out[7] = matrix[9];
     out[8] = matrix[10];
     return out;
-}
-export function fromValues(c0r0, c0r1, c0r2, c1r0, c1r1, c1r2, c2r0, c2r1, c2r2, out) {
+};
+/**
+ * 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 c0r2 - The value in the first column and third row.
+ * @param c1r0 - The value in the second column and first row.
+ * @param c1r1 - The value in the second column and second row.
+ * @param c1r2 - The value in the second column and third row.
+ * @param c2r0 - The value in the third column and first row.
+ * @param c2r1 - The value in the third column and second row.
+ * @param c2r2 - The value in the third column and third row.
+ * @param out - The matrix to store the result in.
+ * @returns The matrix.
+ */
+export const fromValues = (c0r0, c0r1, c0r2, c1r0, c1r1, c1r2, c2r0, c2r1, c2r2, out) => {
     out[0] = c0r0;
     out[1] = c0r1;
     out[2] = c0r2;
@@ -149,8 +218,14 @@ export function fromValues(c0r0, c0r1, c0r2, c1r0, c1r1, c1r2, c2r0, c2r1, c2r2,
     out[7] = c2r1;
     out[8] = c2r2;
     return out;
-}
-export function equals(a, b) {
+};
+/**
+ * Determine whether or not two matrices are roughly equivalent.
+ * @param a - The first matrix.
+ * @param b - The second matrix.
+ * @returns Whether or not the matrices are equivalent.
+ */
+export const equals = (a, b) => {
     const a0 = a[0];
     const a1 = a[1];
     const a2 = a[2];
@@ -178,8 +253,14 @@ export function equals(a, b) {
         Math.abs(a6 - b6) <= epsilon * Math.max(1, Math.abs(a6), Math.abs(b6)) &&
         Math.abs(a7 - b7) <= epsilon * Math.max(1, Math.abs(a7), Math.abs(b7)) &&
         Math.abs(a8 - b8) <= epsilon * Math.max(1, Math.abs(a8), Math.abs(b8)));
-}
-export function exactEquals(a, b) {
+};
+/**
+ * Determine whether or not two matrices are exactly equivalent.
+ * @param a - The first matrix.
+ * @param b - The second matrix.
+ * @returns Whether or not the matrices are equivalent.
+ */
+export const exactEquals = (a, b) => {
     return (a[0] === b[0] &&
         a[1] === b[1] &&
         a[2] === b[2] &&
@@ -189,8 +270,16 @@ export function exactEquals(a, b) {
         a[6] === b[6] &&
         a[7] === b[7] &&
         a[8] === b[8]);
-}
-export function add(a, b, out) {
+};
+/**
+ * Add two matrices.
+ * @param a - The augend.
+ * @param b - The addend.
+ * @param out - The matrix to store the result in.
+ * @returns The sum.
+ * @see [Matrix addition](https://en.wikipedia.org/wiki/Matrix_addition)
+ */
+export const add = (a, b, out) => {
     out[0] = a[0] + b[0];
     out[1] = a[1] + b[1];
     out[2] = a[2] + b[2];
@@ -201,8 +290,15 @@ export function add(a, b, out) {
     out[7] = a[7] + b[7];
     out[8] = a[8] + b[8];
     return out;
-}
-export function adjoint(matrix, out) {
+};
+/**
+ * Calculate the adjugate of a matrix.
+ * @param matrix - The matrix.
+ * @param out - The matrix to store the result in.
+ * @returns The adjugate of the matrix.
+ * @see [Adjugate matrix](https://en.wikipedia.org/wiki/Adjugate_matrix)
+ */
+export const adjoint = (matrix, out) => {
     const a00 = matrix[0];
     const a01 = matrix[1];
     const a02 = matrix[2];
@@ -222,8 +318,14 @@ export function adjoint(matrix, out) {
     out[7] = a01 * a20 - a00 * a21;
     out[8] = a00 * a11 - a01 * a10;
     return out;
-}
-export function copy(matrix, out) {
+};
+/**
+ * Copy the values of one matrix into another.
+ * @param matrix - The matrix to copy.
+ * @param out - The matrix to store the result in.
+ * @returns This matrix.
+ */
+export const copy = (matrix, out) => {
     out[0] = matrix[0];
     out[1] = matrix[1];
     out[2] = matrix[2];
@@ -234,11 +336,25 @@ export function copy(matrix, out) {
     out[7] = matrix[7];
     out[8] = matrix[8];
     return out;
-}
-export function frob(matrix) {
+};
+/**
+ * Calculate the Frobenius norm of a matrix.
+ * @param matrix - The matrix.
+ * @returns The Frobenius norm.
+ * @see [Matrix norm](https://en.wikipedia.org/wiki/Matrix_norm)
+ */
+export const frob = (matrix) => {
     return Math.hypot(matrix[0], matrix[1], matrix[2], matrix[3], matrix[4], matrix[5], matrix[6], matrix[7], matrix[8]);
-}
-export function multiply(a, b, out) {
+};
+/**
+ * Multiply two matrices.
+ * @param a - The multiplicand.
+ * @param b - The multiplier.
+ * @param out - The matrix to store the result in.
+ * @returns The product of the matrices.
+ * @see [Matrix multiplication](https://en.wikipedia.org/wiki/Matrix_multiplication)
+ */
+export const multiply = (a, b, out) => {
     const a00 = a[0];
     const a01 = a[1];
     const a02 = a[2];
@@ -267,8 +383,16 @@ export function multiply(a, b, out) {
     out[7] = b20 * a01 + b21 * a11 + b22 * a21;
     out[8] = b20 * a02 + b21 * a12 + b22 * a22;
     return out;
-}
-export function multiplyScalar(matrix, scalar, out) {
+};
+/**
+ * Multiply a matrix by a scalar value.
+ * @param matrix - The multiplicand.
+ * @param scalar - The multiplier.
+ * @param out - The matrix to store the result in.
+ * @returns The product.
+ * @see [Matrix multiplication](https://en.wikipedia.org/wiki/Matrix_multiplication)
+ */
+export const multiplyScalar = (matrix, scalar, out) => {
     out[0] = matrix[0] * scalar;
     out[1] = matrix[1] * scalar;
     out[2] = matrix[2] * scalar;
@@ -279,8 +403,18 @@ export function multiplyScalar(matrix, scalar, out) {
     out[7] = matrix[7] * scalar;
     out[8] = matrix[8] * scalar;
     return out;
-}
-export function multiplyScalarAndAdd(a, b, scalar, out) {
+};
+/**
+ * Add a matrix to another after multiplying the other by a scalar.
+ * @param a - The augend.
+ * @param b - The addend.
+ * @param scalar - The multiplier.
+ * @param out - The matrix to store the result in.
+ * @returns The sum.
+ * @see [Matrix addition](https://en.wikipedia.org/wiki/Matrix_addition)
+ * @see [Matrix multiplication](https://en.wikipedia.org/wiki/Matrix_multiplication)
+ */
+export const multiplyScalarAndAdd = (a, b, scalar, out) => {
     out[0] = a[0] + b[0] * scalar;
     out[1] = a[1] + b[1] * scalar;
     out[2] = a[2] + b[2] * scalar;
@@ -291,8 +425,16 @@ export function multiplyScalarAndAdd(a, b, scalar, out) {
     out[7] = a[7] + b[7] * scalar;
     out[8] = a[8] + b[8] * scalar;
     return out;
-}
-export function subtract(a, b, out) {
+};
+/**
+ * Subtract two matrices.
+ * @param a - The minuend.
+ * @param b - The subtrahend.
+ * @param out - The matrix to store the result in.
+ * @returns The difference.
+ * @see [Matrix addition](https://en.wikipedia.org/wiki/Matrix_addition)
+ */
+export const subtract = (a, b, out) => {
     out[0] = a[0] - b[0];
     out[1] = a[1] - b[1];
     out[2] = a[2] - b[2];
@@ -303,8 +445,15 @@ export function subtract(a, b, out) {
     out[7] = a[7] - b[7];
     out[8] = a[8] - b[8];
     return out;
-}
-export function transpose(matrix, out) {
+};
+/**
+ * Transpose a matrix.
+ * @param matrix - The matrix.
+ * @param out - The matrix to store the result in.
+ * @returns The transpose of the matrix.
+ * @see [Transpose](https://en.wikipedia.org/wiki/Transpose)
+ */
+export const transpose = (matrix, out) => {
     if (out === matrix) {
         const a01 = matrix[1];
         const a02 = matrix[2];
@@ -328,8 +477,14 @@ export function transpose(matrix, out) {
         out[8] = matrix[8];
     }
     return out;
-}
-export function determinant(matrix) {
+};
+/**
+ * Calculate the determinant of a matrix.
+ * @param matrix - The matrix.
+ * @returns The determinant.
+ * @see [Determinant](https://en.wikipedia.org/wiki/Determinant)
+ */
+export const determinant = (matrix) => {
     const a00 = matrix[0];
     const a01 = matrix[1];
     const a02 = matrix[2];
@@ -342,8 +497,14 @@ export function determinant(matrix) {
     return (a00 * (a22 * a11 - a12 * a21) +
         a01 * (-a22 * a10 + a12 * a20) +
         a02 * (a21 * a10 - a11 * a20));
-}
-export function identity(out) {
+};
+/**
+ * Reset a matrix to identity.
+ * @param out - The matrix to store the result in.
+ * @returns The matrix.
+ * @see [Identity matrix](https://en.wikipedia.org/wiki/Identity_matrix)
+ */
+export const identity = (out) => {
     out[0] = 1;
     out[1] = 0;
     out[2] = 0;
@@ -354,8 +515,15 @@ export function identity(out) {
     out[7] = 0;
     out[8] = 1;
     return out;
-}
-export function invert(matrix, out) {
+};
+/**
+ * Invert a matrix.
+ * @param matrix - The matrix.
+ * @param out - The matrix to store the result in.
+ * @returns The inverted matrix.
+ * @see [Invertible matrix](https://en.wikipedia.org/wiki/Invertible_matrix)
+ */
+export const invert = (matrix, out) => {
     const a00 = matrix[0];
     const a01 = matrix[1];
     const a02 = matrix[2];
@@ -383,8 +551,16 @@ export function invert(matrix, out) {
     out[7] = (-a21 * a00 + a01 * a20) * det;
     out[8] = (a11 * a00 - a01 * a10) * det;
     return out;
-}
-export function rotate(matrix, radians, out) {
+};
+/**
+ * Rotate a matrix by the given angle around the Z-axis.
+ * @param matrix - The matrix.
+ * @param radians - The angle in radians.
+ * @param out - The matrix to store the result in.
+ * @returns The rotated matrix.
+ * @see [Rotation matrix](https://en.wikipedia.org/wiki/Rotation_matrix)
+ */
+export const rotate = (matrix, radians, out) => {
     const a00 = matrix[0];
     const a01 = matrix[1];
     const a02 = matrix[2];
@@ -406,8 +582,16 @@ export function rotate(matrix, radians, out) {
     out[7] = a21;
     out[8] = a22;
     return out;
-}
-export function scale(matrix, vector, out) {
+};
+/**
+ * Scale a matrix by the given vector.
+ * @param matrix - The matrix.
+ * @param vector - The scaling vector.
+ * @param out - The matrix to store the result in.
+ * @returns The scaled matrix.
+ * @see [Transformation matrix](https://en.wikipedia.org/wiki/Transformation_matrix)
+ */
+export const scale = (matrix, vector, out) => {
     const x = vector[0];
     const y = vector[1];
     out[0] = matrix[0] * x;
@@ -420,8 +604,16 @@ export function scale(matrix, vector, out) {
     out[7] = matrix[7];
     out[8] = matrix[8];
     return out;
-}
-export function translate(matrix, vector, out) {
+};
+/**
+ * Translate a matrix by the given vector.
+ * @param matrix - The matrix.
+ * @param vector - The translation vector.
+ * @param out - The matrix to store the result in.
+ * @returns The translated matrix.
+ * @see [Transformation matrix](https://en.wikipedia.org/wiki/Transformation_matrix)
+ */
+export const translate = (matrix, vector, out) => {
     const a00 = matrix[0];
     const a01 = matrix[1];
     const a02 = matrix[2];
@@ -443,32 +635,105 @@ export function translate(matrix, vector, out) {
     out[7] = x * a01 + y * a11 + a21;
     out[8] = x * a02 + y * a12 + a22;
     return out;
-}
+};
+/**
+ * A three-by-three matrix.
+ * @see [Matrix](https://en.wikipedia.org/wiki/Matrix_(mathematics))
+ */
 export default class Matrix3 extends Float32Array {
+    /**
+     * 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 [Rotation matrix](https://en.wikipedia.org/wiki/Rotation_matrix)
+     */
     static fromRotation(r, out = new Matrix3()) {
         return fromRotation(r, out);
     }
+    /**
+     * 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 [Transformation matrix](https://en.wikipedia.org/wiki/Transformation_matrix)
+     */
     static fromScaling(vector, out = new Matrix3()) {
         return fromScaling(vector, out);
     }
+    /**
+     * Create a transformation matrix that represents a translation by the given vector.
+     * @param vector - The translation vector.
+     * @param out - The matrix to store the result in.
+     * @returns The transformation matrix.
+     * @see [Transformation matrix](https://en.wikipedia.org/wiki/Transformation_matrix)
+     */
     static fromTranslation(vector, out = new Matrix3()) {
         return fromTranslation(vector, out);
     }
+    /**
+     * Create a transformation matrix that represents a rotation by the given quaternion.
+     * @param quaternion - The quaternion.
+     * @param out - The matrix to store the result in.
+     * @returns The transformation matrix.
+     * @see [Quaternion](https://en.wikipedia.org/wiki/Quaternion)
+     * @see [Rotation matrix](https://en.wikipedia.org/wiki/Rotation_matrix)
+     */
     static fromQuaternion(quaternion, out = new Matrix3()) {
         return fromQuaternion(quaternion, out);
     }
+    /**
+     * Calculate a three-by-three normal (inverse transpose) matrix from a four-by-four matrix.
+     * @param matrix - The four-by-four matrix.
+     * @param out - The matrix to store the result in.
+     * @returns The normal matrix.
+     * @see [Normal matrix](https://en.wikipedia.org/wiki/Normal_matrix)
+     */
     static normalFromMatrix4(matrix, out = new Matrix3()) {
         return normalFromMatrix4(matrix, out);
     }
+    /**
+     * Generate a two-dimensional projection matrix with the given bounds.
+     * @param width - The width of the projection.
+     * @param height - The height of the projection.
+     * @param out - The matrix to store the result in.
+     * @returns The projection matrix.
+     * @see [Camera matrix](https://en.wikipedia.org/wiki/Camera_matrix)
+     * @see [3D projection](https://en.wikipedia.org/wiki/3D_projection)
+     */
     static projection(width, height, out = new Matrix3()) {
         return projection(width, height, out);
     }
+    /**
+     * Create a three-by-three matrix from the upper-left corner of a four-by-four matrix.
+     * @param matrix - The four-by-four matrix.
+     * @param out - The matrix to store the result in.
+     * @returns The three-by-three matrix.
+     */
     static fromMatrix4(matrix, out = new Matrix3()) {
         return fromMatrix4(matrix, out);
     }
+    /**
+     * 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 c0r2 - The value in the first column and third row.
+     * @param c1r0 - The value in the second column and first row.
+     * @param c1r1 - The value in the second column and second row.
+     * @param c1r2 - The value in the second column and third row.
+     * @param c2r0 - The value in the third column and first row.
+     * @param c2r1 - The value in the third column and second row.
+     * @param c2r2 - The value in the third column and third row.
+     * @param out - The matrix to store the result in.
+     * @returns The matrix.
+     */
     static fromValues(c0r0, c0r1, c0r2, c1r0, c1r1, c1r2, c2r0, c2r1, c2r2, out = new Matrix3()) {
         return fromValues(c0r0, c0r1, c0r2, c1r0, c1r1, c1r2, c2r0, c2r1, c2r2, out);
     }
+    /**
+     * Create a three-by-three identity matrix.
+     * @see [Identity matrix](https://en.wikipedia.org/wiki/Identity_matrix)
+     */
     constructor() {
         super(9);
         this[0] = 1;
@@ -477,68 +742,188 @@ export default class Matrix3 extends Float32Array {
         this.width = 3;
         this.height = 3;
     }
+    /** The value in the first column and first row. */
     0;
+    /** The value in the first column and second row. */
     1;
+    /** The value in the first column and third row. */
     2;
+    /** The value in the second column and first row. */
     3;
+    /** The value in the second column and second row. */
     4;
+    /** The value in the second column and third row. */
     5;
+    /** The value in the third column and first row. */
     6;
+    /** The value in the third column and second row. */
     7;
+    /** The value in the third column and third row. */
     8;
+    /** The number of columns in this matrix. */
     width;
+    /** The number of rows in this matrix. */
     height;
+    /**
+     * Determine whether or not this matrix is roughly equivalent to another.
+     * @param matrix - The other matrix.
+     * @returns Whether or not the matrices are equivalent.
+     */
     equals(matrix) {
         return equals(this, matrix);
     }
+    /**
+     * Determine whether or not this matrix is exactly equivalent to another.
+     * @param matrix - The other matrix.
+     * @returns Whether or not the matrices are equivalent.
+     */
     exactEquals(matrix) {
         return exactEquals(this, matrix);
     }
+    /**
+     * Add two matrices of the same size.
+     * @param matrix - The other matrix.
+     * @param out - The matrix to store the result in.
+     * @returns The sum of the matrices.
+     * @see [Matrix addition](https://en.wikipedia.org/wiki/Matrix_addition)
+     */
     add(matrix, out = new Matrix3()) {
         return add(this, matrix, out);
     }
+    /**
+     * Calculate the adjugate of this matrix.
+     * @param out - The matrix to store the result in.
+     * @returns The adjugate of this matrix.
+     * @see [Adjugate matrix](https://en.wikipedia.org/wiki/Adjugate_matrix)
+     */
     adjoint(out = new Matrix3()) {
         return adjoint(this, out);
     }
+    /**
+     * Copy the values from this matrix to another one.
+     * @param out - The matrix to store the result in.
+     * @returns The copy.
+     */
     clone(out = new Matrix3()) {
         return copy(this, out);
     }
+    /**
+     * Copy the values of another matrix into this one.
+     * @param matrix - The matrix to copy.
+     * @returns This matrix.
+     */
     copy(matrix) {
         return copy(matrix, this);
     }
+    /**
+     * Get the Frobenius norm of this matrix.
+     * @see [Matrix norm](https://en.wikipedia.org/wiki/Matrix_norm)
+     */
     get frob() {
         return frob(this);
     }
+    /**
+     * 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 [Matrix multiplication](https://en.wikipedia.org/wiki/Matrix_multiplication)
+     */
     multiply(matrix, out = new Matrix3()) {
         return multiply(this, matrix, out);
     }
+    /**
+     * 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 [Matrix multiplication](https://en.wikipedia.org/wiki/Matrix_multiplication)
+     */
     multiplyScalar(scalar, out = new Matrix3()) {
         return multiplyScalar(this, scalar, out);
     }
+    /**
+     * 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 [Matrix addition](https://en.wikipedia.org/wiki/Matrix_addition)
+     * @see [Matrix multiplication](https://en.wikipedia.org/wiki/Matrix_multiplication)
+     */
     multiplyScalarAndAdd(matrix, scalar, out = new Matrix3()) {
         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 [Matrix addition](https://en.wikipedia.org/wiki/Matrix_addition)
+     */
     subtract(matrix, out = new Matrix3()) {
         return subtract(this, matrix, out);
     }
+    /**
+     * Transpose this matrix.
+     * @param out - The matrix to store the result in.
+     * @returns The transpose of this matrix.
+     * @see [Transpose](https://en.wikipedia.org/wiki/Transpose)
+     */
     transpose(out = new Matrix3()) {
         return transpose(this, out);
     }
+    /**
+     * Get the determinant of this matrix.
+     * @see [Determinant](https://en.wikipedia.org/wiki/Determinant)
+     */
     get determinant() {
         return determinant(this);
     }
+    /**
+     * Reset this matrix to identity.
+     * @returns This matrix.
+     * @see [Identity matrix](https://en.wikipedia.org/wiki/Identity_matrix)
+     */
     identity() {
         return identity(this);
     }
+    /**
+     * Invert this matrix.
+     * @param out - The matrix to store the result in.
+     * @returns The inverted matrix.
+     * @see [Invertible matrix](https://en.wikipedia.org/wiki/Invertible_matrix)
+     */
     invert(out = new Matrix3()) {
         return invert(this, out);
     }
+    /**
+     * Rotate this matrix 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 rotated matrix.
+     * @see [Rotation matrix](https://en.wikipedia.org/wiki/Rotation_matrix)
+     */
     rotate(r, out = new Matrix3()) {
         return rotate(this, r, out);
     }
+    /**
+     * 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 [Transformation matrix](https://en.wikipedia.org/wiki/Transformation_matrix)
+     */
     scale(vector, out = new Matrix3()) {
         return scale(this, vector, out);
     }
+    /**
+     * Translate this matrix by the given vector.
+     * @param vector - The translation vector.
+     * @param out - The matrix to store the result in.
+     * @returns The translated matrix.
+     * @see [Transformation matrix](https://en.wikipedia.org/wiki/Transformation_matrix)
+     */
     translate(vector, out = new Matrix3()) {
         return translate(this, vector, out);
     }