@lakuna/umath 1.3.2 → 1.3.3

package/src/linalg/Quaternion.ts

@@ -20,6 +20,14 @@ import epsilon from "#epsilon";
 /** A complex number that is commonly used to describe rotations. */
 export type QuaternionLike = Quaternion | [number, number, number, number];
 
+/**
+ * Creates a quaternion-like object.
+ * @returns A quaternion-like object.
+ */
+export function createQuaternionLike(): QuaternionLike {
+	return new Float32Array(4) as QuaternionLike;
+}
+
 /**
  * Creates a quaternion from a three-by-three rotation matrix.
  * @param matrix The matrix.
@@ -104,11 +112,15 @@ export function fromEuler<T extends QuaternionLike>(
 	return out;
 }
 
-/** A three-by-three matrix that is used to store intermediary values for some functions. */
+/**
+ * A three-by-three matrix that is used to store intermediary values for some
+ * functions.
+ */
 const intermediary: Matrix3Like = new Float32Array(9) as Matrix3Like;
 
 /**
- * Creates a quaternion with values corresponding to the given orthonormal set of vectors.
+ * Creates a quaternion with values corresponding to the given orthonormal set
+ * of vectors.
  * @param view The vector representing the viewing direction.
  * @param right The vector representing the local "right" direction.
  * @param up The vector representing the local "up" direction.
@@ -318,7 +330,8 @@ export function rotateZ<T extends QuaternionLike>(
 }
 
 /**
- * Calculates the fourth component of a unit quaternion from the first three, ignoring the existing fourth component.
+ * Calculates the fourth component of a unit quaternion from the first three,
+ * ignoring the existing fourth component.
  * @param quaternion The quaternion.
  * @param out The quaternion to store the result in.
  * @returns The quaternion.
@@ -486,7 +499,8 @@ export function random<T extends QuaternionLike>(out: T): T {
 }
 
 /**
- * Calculates the inverse of a quaternion. If the quaternion is normalized, the conjugate is the same but faster to calculate.
+ * Calculates the inverse of a quaternion. If the quaternion is normalized, the
+ * conjugate is the same but faster to calculate.
  * @param quaternion The quaternion.
  * @param out The quaternion to store the result in.
  * @returns The inverse.
@@ -519,7 +533,8 @@ export function invert<T extends QuaternionLike>(
 }
 
 /**
- * Calculates the conjugate of a quaternion. If the quaternion is normalized, this is the same as the inverse but faster to calculate.
+ * Calculates the conjugate of a quaternion. If the quaternion is normalized,
+ * this is the same as the inverse but faster to calculate.
  * @param quaternion The quaternion.
  * @param out The quaternion to store the result in.
  * @returns The conjugate.
@@ -535,14 +550,19 @@ export function conjugate<T extends QuaternionLike>(
 	return out;
 }
 
-/** A quaternion that is used to store intermediary values for some functions. */
+/**
+ * A quaternion that is used to store intermediary values for some functions.
+ */
 const controlPointOne: QuaternionLike = new Float32Array(4) as QuaternionLike;
 
-/** A quaternion that is used to store intermediary values for some functions. */
+/**
+ * A quaternion that is used to store intermediary values for some functions.
+ */
 const controlPointTwo: QuaternionLike = new Float32Array(4) as QuaternionLike;
 
 /**
- * Performs a spherical linear interpolation with two control points between two quaternions.
+ * Performs a spherical linear interpolation with two control points between
+ * two quaternions.
  * @param a The first quaternion.
  * @param b The first control point.
  * @param c The second control point.
@@ -675,7 +695,8 @@ export default class Quaternion extends Float32Array {
 	}
 
 	/**
-	 * Creates a quaternion with values corresponding to the given orthonormal set of vectors.
+	 * Creates a quaternion with values corresponding to the given orthonormal
+	 * set of vectors.
 	 * @param view The vector representing the viewing direction.
 	 * @param right The vector representing the local "right" direction.
 	 * @param up The vector representing the local "up" direction.
@@ -688,7 +709,8 @@ export default class Quaternion extends Float32Array {
 	): Quaternion;
 
 	/**
-	 * Creates a quaternion with values corresponding to the given orthonormal set of vectors.
+	 * Creates a quaternion with values corresponding to the given orthonormal
+	 * set of vectors.
 	 * @param view The vector representing the viewing direction.
 	 * @param right The vector representing the local "right" direction.
 	 * @param up The vector representing the local "up" direction.
@@ -855,13 +877,15 @@ export default class Quaternion extends Float32Array {
 	}
 
 	/**
-	 * Calculates the fourth component of this unit quaternion from the first three, ignoring the existing fourth component.
+	 * Calculates the fourth component of this unit quaternion from the first
+	 * three, ignoring the existing fourth component.
 	 * @returns The quaternion.
 	 */
 	public calculateW(): Quaternion;
 
 	/**
-	 * Calculates the fourth component of this unit quaternion from the first three, ignoring the existing fourth component.
+	 * Calculates the fourth component of this unit quaternion from the first
+	 * three, ignoring the existing fourth component.
 	 * @param out The quaternion to store the result in.
 	 * @returns The quaternion.
 	 */
@@ -930,7 +954,8 @@ export default class Quaternion extends Float32Array {
 	}
 
 	/**
-	 * Performs a spherical linear interpolation between this and another quaternion.
+	 * Performs a spherical linear interpolation between this and another
+	 * quaternion.
 	 * @param quaternion The other quaternion.
 	 * @param t The interpolation amount in `[0,1]`.
 	 * @returns The interpolated quaternion.
@@ -939,7 +964,8 @@ export default class Quaternion extends Float32Array {
 	public slerp(quaternion: QuaternionLike, t: number): Quaternion;
 
 	/**
-	 * Performs a spherical linear interpolation between this and another quaternion.
+	 * Performs a spherical linear interpolation between this and another
+	 * quaternion.
 	 * @param quaternion The other quaternion.
 	 * @param t The interpolation amount in `[0,1]`.
 	 * @param out The quaternion to store the result in.
@@ -969,13 +995,15 @@ export default class Quaternion extends Float32Array {
 	}
 
 	/**
-	 * Calculates the inverse of this quaternion. If the quaternion is normalized, the conjugate is the same but faster to calculate.
+	 * Calculates the inverse of this quaternion. If the quaternion is
+	 * normalized, the conjugate is the same but faster to calculate.
 	 * @returns The inverse.
 	 */
 	public invert(): Quaternion;
 
 	/**
-	 * Calculates the inverse of this quaternion. If the quaternion is normalized, the conjugate is the same but faster to calculate.
+	 * Calculates the inverse of this quaternion. If the quaternion is
+	 * normalized, the conjugate is the same but faster to calculate.
 	 * @param out The quaternion to store the result in.
 	 * @returns The inverse.
 	 */
@@ -986,13 +1014,15 @@ export default class Quaternion extends Float32Array {
 	}
 
 	/**
-	 * Calculates the conjugate of this quaternion. If the quaternion is normalized, this is the same as the inverse but faster to calculate.
+	 * Calculates the conjugate of this quaternion. If the quaternion is
+	 * normalized, this is the same as the inverse but faster to calculate.
 	 * @returns The conjugate.
 	 */
 	public conjugate(): Quaternion;
 
 	/**
-	 * Calculates the conjugate of this quaternion. If the quaternion is normalized, this is the same as the inverse but faster to calculate.
+	 * Calculates the conjugate of this quaternion. If the quaternion is
+	 * normalized, this is the same as the inverse but faster to calculate.
 	 * @param out The quaternion to store the result in.
 	 * @returns The conjugate.
 	 */
@@ -1179,7 +1209,8 @@ export default class Quaternion extends Float32Array {
 	}
 
 	/**
-	 * Performs a spherical linear interpolation with two control points between this and another quaternion.
+	 * Performs a spherical linear interpolation with two control points
+	 * between this and another quaternion.
 	 * @param a The first control point.
 	 * @param b The second control point.
 	 * @param quaternion The other quaternion.
@@ -1195,7 +1226,8 @@ export default class Quaternion extends Float32Array {
 	): Quaternion;
 
 	/**
-	 * Performs a spherical linear interpolation with two control points between this and another quaternion.
+	 * Performs a spherical linear interpolation with two control points
+	 * between this and another quaternion.
 	 * @param a The first control point.
 	 * @param b The second control point.
 	 * @param quaternion The other quaternion.

package/src/linalg/SlowSquareMatrix.ts

@@ -12,7 +12,8 @@ export default class SlowSquareMatrix
 	implements SquareMatrix
 {
 	/**
-	 * Creates a variable-size matrix with the same number of rows and columns from the given columns.
+	 * Creates a variable-size matrix with the same number of rows and columns
+	 * from the given columns.
 	 * @param cols The columns in the matrix.
 	 * @see [Square matrix](https://en.wikipedia.org/wiki/Square_matrix)
 	 */
@@ -160,7 +161,8 @@ export default class SlowSquareMatrix
 	}
 
 	/**
-	 * Calculates the minor of this matrix which results from removing the given row and column.
+	 * Calculates the minor of this matrix which results from removing the
+	 * given row and column.
 	 * @param row The row to remove.
 	 * @param col The column to remove.
 	 * @returns The minor.
@@ -171,7 +173,8 @@ export default class SlowSquareMatrix
 	}
 
 	/**
-	 * Creates a submatrix by removing the given row and column from this matrix.
+	 * Creates a submatrix by removing the given row and column from this
+	 * matrix.
 	 * @param row The row to remove.
 	 * @param col The column to remove.
 	 * @returns The submatrix.

package/src/linalg/Vector.ts

@@ -116,7 +116,8 @@ export default interface Vector extends Iterable<number> {
 	distance(vector: VectorLike): number;
 
 	/**
-	 * Calculates the squared Euclidean distance between this vector and another.
+	 * Calculates the squared Euclidean distance between this vector and
+	 * another.
 	 * @param vector The other vector.
 	 * @returns The squared distance.
 	 */

package/src/linalg/Vector2.ts

@@ -8,6 +8,14 @@ import epsilon from "#epsilon";
 /** A quantity with magnitude and direction in two dimensions. */
 export type Vector2Like = Vector2 | [number, number];
 
+/**
+ * Creates a 2x1 vector-like object.
+ * @returns A 2x1 vector-like object.
+ */
+export function createVector2Like(): Vector2Like {
+	return new Float32Array(2) as Vector2Like;
+}
+
 /**
  * Creates a vector with the given values.
  * @param x The first component.
@@ -84,7 +92,8 @@ export function copy<T extends Vector2Like>(vector: Vector2Like, out: T): T {
 }
 
 /**
- * Multiplies the components in one vector by the corresponding components in another.
+ * Multiplies the components in one vector by the corresponding components in
+ * another.
  * @param a The multiplicand.
  * @param b The multiplier.
  * @param out The vector to store the result in.
@@ -634,14 +643,16 @@ export default class Vector2 extends Float32Array implements Vector {
 	}
 
 	/**
-	 * Multiplies the components in this vector by the corresponding components in another.
+	 * Multiplies the components in this vector by the corresponding components
+	 * in another.
 	 * @param vector The other vector.
 	 * @returns The product of the vectors.
 	 */
 	public multiply(vector: Vector2Like): Vector2;
 
 	/**
-	 * Multiplies the components in this vector by the corresponding components in another.
+	 * Multiplies the components in this vector by the corresponding components
+	 * in another.
 	 * @param vector The other vector.
 	 * @param out The vector to store the result in.
 	 * @returns The product of the vectors.

package/src/linalg/Vector3.ts

@@ -8,6 +8,14 @@ import epsilon from "#epsilon";
 /** A quantity with magnitude and direction in three dimensions. */
 export type Vector3Like = Vector3 | [number, number, number];
 
+/**
+ * Creates a 3x1 vector-like object.
+ * @returns A 3x1 vector-like object.
+ */
+export function createVector3Like(): Vector3Like {
+	return new Float32Array(3) as Vector3Like;
+}
+
 /**
  * Creates a vector with the given values.
  * @param x The first component.
@@ -745,7 +753,8 @@ const yAxis: Vector3Like = new Float32Array([0, 1, 0]) as Vector3Like;
 const intermediary: Vector3Like = new Float32Array(3) as Vector3Like;
 
 /**
- * Creates a quaternion that represents the shortest rotation from one unit vector to another.
+ * Creates a quaternion that represents the shortest rotation from one unit
+ * vector to another.
  * @param a The first vector.
  * @param b The second vector.
  * @param out The quaternion to store the result in.
@@ -1122,7 +1131,8 @@ export default class Vector3 extends Float32Array implements Vector {
 	}
 
 	/**
-	 * Calculates the squared Euclidean distance between this vector and another.
+	 * Calculates the squared Euclidean distance between this vector and
+	 * another.
 	 * @param vector The other vector.
 	 * @returns The squared distance.
 	 * @see [Euclidean distance](https://en.wikipedia.org/wiki/Euclidean_distance)
@@ -1419,7 +1429,8 @@ export default class Vector3 extends Float32Array implements Vector {
 	}
 
 	/**
-	 * Performs a Hermite interpolation with two control points between this vector and another.
+	 * Performs a Hermite interpolation with two control points between this
+	 * vector and another.
 	 * @param a The first control point.
 	 * @param b The second control point.
 	 * @param end The other vector.
@@ -1435,7 +1446,8 @@ export default class Vector3 extends Float32Array implements Vector {
 	): Vector3;
 
 	/**
-	 * Performs a Hermite interpolation with two control points between this vector and another.
+	 * Performs a Hermite interpolation with two control points between this
+	 * vector and another.
 	 * @param a The first control point.
 	 * @param b The second control point.
 	 * @param end The other vector.
@@ -1463,7 +1475,8 @@ export default class Vector3 extends Float32Array implements Vector {
 	}
 
 	/**
-	 * Performs a Bézier interpolation with two control points between this vector and another.
+	 * Performs a Bézier interpolation with two control points between this
+	 * vector and another.
 	 * @param a The first control point.
 	 * @param b The second control point.
 	 * @param end The other vector.
@@ -1479,7 +1492,8 @@ export default class Vector3 extends Float32Array implements Vector {
 	): Vector3;
 
 	/**
-	 * Performs a Bézier interpolation with two control points between this vector and another.
+	 * Performs a Bézier interpolation with two control points between this
+	 * vector and another.
 	 * @param a The first control point.
 	 * @param b The second control point.
 	 * @param end The other vector.
@@ -1534,14 +1548,16 @@ export default class Vector3 extends Float32Array implements Vector {
 	}
 
 	/**
-	 * Creates a quaternion that represents the shortest rotation from this vector to another.
+	 * Creates a quaternion that represents the shortest rotation from this
+	 * vector to another.
 	 * @param vector The other vector.
 	 * @returns The rotation.
 	 */
 	public rotationTo(vector: Vector3Like): Quaternion;
 
 	/**
-	 * Creates a quaternion that represents the shortest rotation from this unit vector to another.
+	 * Creates a quaternion that represents the shortest rotation from this
+	 * unit vector to another.
 	 * @param vector The other vector.
 	 * @param out The quaternion to store the result in.
 	 * @returns The quaternion.

package/src/linalg/Vector4.ts

@@ -6,6 +6,14 @@ import epsilon from "#epsilon";
 /** A quantity with magnitude and direction in four dimensions. */
 export type Vector4Like = Vector4 | [number, number, number, number];
 
+/**
+ * Creates a 4x1 vector-like object.
+ * @returns A 4x1 vector-like object.
+ */
+export function createVector4Like(): Vector4Like {
+	return new Float32Array(4) as Vector4Like;
+}
+
 /**
  * Creates a vector with the given values.
  * @param x The first component.
@@ -895,7 +903,8 @@ export default class Vector4 extends Float32Array implements Vector {
 	}
 
 	/**
-	 * Calculates the squared Euclidean distance between this vector and another.
+	 * Calculates the squared Euclidean distance between this vector and
+	 * another.
 	 * @param vector The other vector.
 	 * @returns The squared distance.
 	 * @see [Euclidean distance](https://en.wikipedia.org/wiki/Euclidean_distance)
@@ -978,7 +987,8 @@ export default class Vector4 extends Float32Array implements Vector {
 	}
 
 	/**
-	 * Calculates the cross product of this and two other vectors in a four-dimensional space.
+	 * Calculates the cross product of this and two other vectors in a
+	 * four-dimensional space.
 	 * @param a One other vector.
 	 * @param b The other other vector.
 	 * @returns The cross product.
@@ -987,7 +997,8 @@ export default class Vector4 extends Float32Array implements Vector {
 	public cross(a: Vector4Like, b: Vector4Like): Vector4;
 
 	/**
-	 * Calculates the cross product of this and two other vectors in a four-dimensional space.
+	 * Calculates the cross product of this and two other vectors in a
+	 * four-dimensional space.
 	 * @param a One other vector.
 	 * @param b The other other vector.
 	 * @param out The vector to store the result in.

package/src/utility/BigNumber.ts

@@ -122,7 +122,8 @@ export default class BigNumber {
 	}
 
 	/**
-	 * Converts this number to a regular `number`. Might result in loss of precision.
+	 * Converts this number to a regular `number`. Might result in loss of
+	 * precision.
 	 * @returns This number as a `number`.
 	 */
 	public toNumber(): number {

package/src/utility/MatrixSizeError.ts

@@ -1,7 +1,8 @@
 /** An error resulting from trying to use a matrix that is the wrong size. */
 export default class PartialMatrixError extends Error {
 	/**
-	 * Creates an error resulting from trying to use a matrix that is the wrong size.
+	 * Creates an error resulting from trying to use a matrix that is the wrong
+	 * size.
 	 * @param message The message of the error.
 	 */
 	public constructor(message = "Invalid matrix dimensions.") {

package/src/utility/PartialMatrixError.ts

@@ -1,7 +1,8 @@
 /** An error resulting from creating a matrix that isn't a perfect rectangle. */
 export default class PartialMatrixError extends Error {
 	/**
-	 * Creates an error resulting from creating a matrix that isn't a perfect rectangle.
+	 * Creates an error resulting from creating a matrix that isn't a perfect
+	 * rectangle.
 	 * @param message The message of the error.
 	 */
 	public constructor(message = "The matrix is not rectangular.") {

package/src/utility/SingularMatrixError.ts

@@ -9,5 +9,6 @@ export default class SingularMatrixError extends Error {
 	 */
 	public constructor(message = "The matrix cannot be inverted.") {
 		super(message);
+		this.name = "SingularMatrixError";
 	}
 }

package/src/utility/epsilon.ts

@@ -1,2 +1,5 @@
-/** The largest difference between two numbers for them to be considered "roughly" equivalent. */
+/**
+ * The largest difference between two numbers for them to be considered
+ * "roughly" equivalent.
+ */
 export default 0.000001;