@lakuna/umath 3.0.0 → 4.0.0

package/src/linalg/SlowVector.ts

@@ -17,7 +17,7 @@ interface SizedVectorLike extends VectorLike {
  * Determine whether the given `VectorLike` has size information.
  * @internal
  */
-const isSized = (vector: VectorLike): vector is SizedVectorLike =>
+const isSized = (vector: Readonly<VectorLike>): vector is SizedVectorLike =>
 	"length" in vector && typeof vector.length === "number";
 
 /**
@@ -45,7 +45,7 @@ export default class SlowVector extends Float32Array implements Vector {
 	 * Create a variable-size vector from the given values.
 	 * @param values - The values in the vector.
 	 */
-	public constructor(...values: number[]) {
+	public constructor(...values: readonly number[]) {
 		super(values);
 	}
 
@@ -54,7 +54,7 @@ export default class SlowVector extends Float32Array implements Vector {
 	 * @param vector - The other vector.
 	 * @returns The sum of the vectors.
 	 */
-	public add(vector: VectorLike): SlowVector {
+	public add(vector: Readonly<VectorLike>): SlowVector {
 		if (!isSized(vector) || this.length !== vector.length) {
 			throw new VectorSizeError();
 		}
@@ -93,7 +93,7 @@ export default class SlowVector extends Float32Array implements Vector {
 	 * @param vector - The vector to copy.
 	 * @returns This vector.
 	 */
-	public copy(vector: VectorLike): this {
+	public copy(vector: Readonly<VectorLike>): this {
 		if (!isSized(vector) || this.length !== vector.length) {
 			throw new VectorSizeError();
 		}
@@ -110,7 +110,7 @@ export default class SlowVector extends Float32Array implements Vector {
 	 * @param vector - The other vector.
 	 * @returns The distance.
 	 */
-	public distance(vector: VectorLike): number {
+	public distance(vector: Readonly<VectorLike>): number {
 		if (!isSized(vector) || this.length !== vector.length) {
 			throw new VectorSizeError();
 		}
@@ -128,7 +128,7 @@ export default class SlowVector extends Float32Array implements Vector {
 	 * @param vector - The other vector.
 	 * @returns The quotient of the vectors.
 	 */
-	public divide(vector: VectorLike): SlowVector {
+	public divide(vector: Readonly<VectorLike>): SlowVector {
 		if (!isSized(vector) || this.length !== vector.length) {
 			throw new VectorSizeError();
 		}
@@ -147,7 +147,7 @@ export default class SlowVector extends Float32Array implements Vector {
 	 * @returns The dot product.
 	 * @see {@link https://en.wikipedia.org/wiki/Dot_product | Dot product}
 	 */
-	public dot(vector: VectorLike): number {
+	public dot(vector: Readonly<VectorLike>): number {
 		if (!isSized(vector) || this.length !== vector.length) {
 			throw new VectorSizeError();
 		}
@@ -165,7 +165,7 @@ export default class SlowVector extends Float32Array implements Vector {
 	 * @param vector - The other vector.
 	 * @returns Whether the vectors are equivalent.
 	 */
-	public equals(vector: VectorLike): boolean {
+	public equals(vector: Readonly<VectorLike>): boolean {
 		if (!isSized(vector) || this.length !== vector.length) {
 			throw new VectorSizeError();
 		}
@@ -190,7 +190,7 @@ export default class SlowVector extends Float32Array implements Vector {
 	 * @param vector - The other vector.
 	 * @returns Whether the vectors are equivalent.
 	 */
-	public exactEquals(vector: VectorLike): boolean {
+	public exactEquals(vector: Readonly<VectorLike>): boolean {
 		if (!isSized(vector) || this.length !== vector.length) {
 			throw new VectorSizeError();
 		}
@@ -236,7 +236,7 @@ export default class SlowVector extends Float32Array implements Vector {
 	 * @param t - The interpolation amount (in `[0,1]`).
 	 * @returns The interpolated vector.
 	 */
-	public lerp(vector: VectorLike, t: number): SlowVector {
+	public lerp(vector: Readonly<VectorLike>, t: number): SlowVector {
 		if (!isSized(vector) || this.length !== vector.length) {
 			throw new VectorSizeError();
 		}
@@ -255,7 +255,7 @@ export default class SlowVector extends Float32Array implements Vector {
 	 * @param vector - The other vector.
 	 * @returns The maximum.
 	 */
-	public max(vector: VectorLike): SlowVector {
+	public max(vector: Readonly<VectorLike>): SlowVector {
 		if (!isSized(vector) || this.length !== vector.length) {
 			throw new VectorSizeError();
 		}
@@ -273,7 +273,7 @@ export default class SlowVector extends Float32Array implements Vector {
 	 * @param vector - The other vector.
 	 * @returns The minimum.
 	 */
-	public min(vector: VectorLike): SlowVector {
+	public min(vector: Readonly<VectorLike>): SlowVector {
 		if (!isSized(vector) || this.length !== vector.length) {
 			throw new VectorSizeError();
 		}
@@ -291,7 +291,7 @@ export default class SlowVector extends Float32Array implements Vector {
 	 * @param vector - The other vector.
 	 * @returns The product of the vectors.
 	 */
-	public multiply(vector: VectorLike): SlowVector {
+	public multiply(vector: Readonly<VectorLike>): SlowVector {
 		if (!isSized(vector) || this.length !== vector.length) {
 			throw new VectorSizeError();
 		}
@@ -387,7 +387,7 @@ export default class SlowVector extends Float32Array implements Vector {
 	 * @param scalar - The scalar.
 	 * @returns The sum.
 	 */
-	public scaleAndAdd(vector: VectorLike, scalar: number): SlowVector {
+	public scaleAndAdd(vector: Readonly<VectorLike>, scalar: number): SlowVector {
 		if (!isSized(vector)) {
 			throw new VectorSizeError();
 		}
@@ -405,7 +405,7 @@ export default class SlowVector extends Float32Array implements Vector {
 	 * @param vector - The other vector.
 	 * @returns The squared distance.
 	 */
-	public squaredDistance(vector: VectorLike): number {
+	public squaredDistance(vector: Readonly<VectorLike>): number {
 		if (!isSized(vector) || this.length !== vector.length) {
 			throw new VectorSizeError();
 		}
@@ -423,7 +423,7 @@ export default class SlowVector extends Float32Array implements Vector {
 	 * @param vector - The other vector.
 	 * @returns The difference between the vectors.
 	 */
-	public subtract(vector: VectorLike): SlowVector {
+	public subtract(vector: Readonly<VectorLike>): SlowVector {
 		if (!isSized(vector) || this.length !== vector.length) {
 			throw new VectorSizeError();
 		}

package/src/linalg/Vector.ts

@@ -11,7 +11,7 @@ export default interface Vector extends VectorLike {
 	 * @param vector - The other vector.
 	 * @returns The sum of the vectors.
 	 */
-	add: (vector: Vector4Like) => VectorLike;
+	add: (vector: Readonly<Vector4Like>) => VectorLike;
 
 	/**
 	 * Round up the components of this vector.
@@ -30,21 +30,21 @@ export default interface Vector extends VectorLike {
 	 * @param vector - The vector to copy.
 	 * @returns This vector.
 	 */
-	copy: (vector: Vector4Like) => this;
+	copy: (vector: Readonly<Vector4Like>) => this;
 
 	/**
 	 * Calculate the Euclidean distance between this vector and another.
 	 * @param vector - The other vector.
 	 * @returns The distance.
 	 */
-	distance: (vector: Vector4Like) => number;
+	distance: (vector: Readonly<Vector4Like>) => number;
 
 	/**
 	 * Divide this vector by another.
 	 * @param vector - The other vector.
 	 * @returns The quotient of the vectors.
 	 */
-	divide: (vector: Vector4Like) => VectorLike;
+	divide: (vector: Readonly<Vector4Like>) => VectorLike;
 
 	/**
 	 * Calculate the dot product of this and another vector.
@@ -52,21 +52,21 @@ export default interface Vector extends VectorLike {
 	 * @returns The dot product.
 	 * @see {@link https://en.wikipedia.org/wiki/Dot_product | Dot product}
 	 */
-	dot: (vector: Vector4Like) => number;
+	dot: (vector: Readonly<Vector4Like>) => number;
 
 	/**
 	 * Determine whether this vector is roughly equivalent to another.
 	 * @param vector - The other vector.
 	 * @returns Whether the vectors are equivalent.
 	 */
-	equals: (vector: Vector4Like) => boolean;
+	equals: (vector: Readonly<Vector4Like>) => boolean;
 
 	/**
 	 * Determine whether this vector is exactly equivalent to another.
 	 * @param vector - The other vector.
 	 * @returns Whether the vectors are equivalent.
 	 */
-	exactEquals: (vector: Vector4Like) => boolean;
+	exactEquals: (vector: Readonly<Vector4Like>) => boolean;
 
 	/**
 	 * Round down the components of this vector.
@@ -86,7 +86,7 @@ export default interface Vector extends VectorLike {
 	 * @param t - The interpolation amount (in `[0,1]`).
 	 * @returns The interpolated vector.
 	 */
-	lerp: (vector: Vector4Like, t: number) => VectorLike;
+	lerp: (vector: Readonly<Vector4Like>, t: number) => VectorLike;
 
 	/** Get the magnitude (length) of this vector. */
 	get magnitude(): number;
@@ -96,21 +96,21 @@ export default interface Vector extends VectorLike {
 	 * @param vector - The other vector.
 	 * @returns The maximum.
 	 */
-	max: (vector: Vector4Like) => VectorLike;
+	max: (vector: Readonly<Vector4Like>) => VectorLike;
 
 	/**
 	 * Return the minimum of this and another vector.
 	 * @param vector - The other vector.
 	 * @returns The minimum.
 	 */
-	min: (vector: Vector4Like) => VectorLike;
+	min: (vector: Readonly<Vector4Like>) => VectorLike;
 
 	/**
 	 * Multiply this vector by another.
 	 * @param vector - The other vector.
 	 * @returns The product of the vectors.
 	 */
-	multiply: (vector: Vector4Like) => VectorLike;
+	multiply: (vector: Readonly<Vector4Like>) => VectorLike;
 
 	/**
 	 * Negate this vector.
@@ -158,14 +158,14 @@ export default interface Vector extends VectorLike {
 	 * @param scalar - The scalar.
 	 * @returns The sum.
 	 */
-	scaleAndAdd: (vector: Vector4Like, scalar: number) => VectorLike;
+	scaleAndAdd: (vector: Readonly<Vector4Like>, scalar: number) => VectorLike;
 
 	/**
 	 * Calculate the squared Euclidean distance between this vector and another.
 	 * @param vector - The other vector.
 	 * @returns The squared distance.
 	 */
-	squaredDistance: (vector: Vector4Like) => number;
+	squaredDistance: (vector: Readonly<Vector4Like>) => number;
 
 	/** Get the squared magnitude (length) of this vector. */
 	get squaredMagnitude(): number;
@@ -175,7 +175,7 @@ export default interface Vector extends VectorLike {
 	 * @param vector - The other vector.
 	 * @returns The difference between the vectors.
 	 */
-	subtract: (vector: Vector4Like) => VectorLike;
+	subtract: (vector: Readonly<Vector4Like>) => VectorLike;
 
 	/**
 	 * Set this to the zero vector.