@lakuna/umath 1.3.4 → 1.3.6

package/src/types/AxisAngle.ts

@@ -1,4 +1,4 @@
-import type { Vector3Like } from "#Vector3";
+import type { Vector3Like } from "../linalg/Vector3.js";
 
 /** An axis and an angle to rotate around it. */
 export default interface AxisAngle {

package/src/utility/BigNumber.ts

@@ -1,33 +1,22 @@
-import greatestCommonDivisor from "#greatestCommonDivisor";
-import type { IntegerRepresentation } from "#IntegerRepresentation";
+import greatestCommonDivisor from "../algorithms/greatestCommonDivisor.js";
 
 /** A number with no maximum precise size. */
 export default class BigNumber {
 	/**
-	 * Creates a number.
-	 * @param source The number.
-	 */
-	public constructor(source?: IntegerRepresentation);
-
-	/**
-	 * Creates a number from a fraction.
-	 * @param dividend The dividend of the fraction.
-	 * @param divisor The divisor of the fraction.
+	 * Create a number.
+	 * @param dividend - The dividend of the number.
+	 * @param divisor - The divisor of the number.
 	 */
 	public constructor(
-		dividend?: IntegerRepresentation,
-		divisor?: IntegerRepresentation
-	);
-
-	public constructor(
-		dividend: IntegerRepresentation = 0,
-		divisor: IntegerRepresentation = 1
+		dividend: bigint | boolean | number | string = 0,
+		divisor: bigint | boolean | number | string = 1
 	) {
-		this.dividend = BigInt(dividend);
-		this.divisor = BigInt(divisor);
-		if (!this.divisor) {
+		if (divisor === 0) {
 			throw new Error("Cannot divide by zero.");
 		}
+
+		this.dividend = BigInt(dividend);
+		this.divisor = BigInt(divisor);
 		this.simplify();
 	}
 
@@ -37,16 +26,19 @@ export default class BigNumber {
 	/** The divisor of this fraction. */
 	public divisor: bigint;
 
-	/** Simplifies this fraction. */
-	private simplify(): void {
-		// Switches signs such that only the dividend can be negative.
+	/**
+	 * Simplify this fraction.
+	 * @internal
+	 */
+	private simplify() {
+		// Switch signs such that only the dividend can be negative.
 		if (this.divisor < 0) {
 			this.dividend = -this.dividend;
 			this.divisor = -this.divisor;
 		}
 
 		// Divide both by their greatest common divisor.
-		const gcd: bigint = greatestCommonDivisor(this.dividend, this.divisor);
+		const gcd = greatestCommonDivisor(this.dividend, this.divisor);
 		if (gcd > 1) {
 			this.dividend /= gcd;
 			this.divisor /= gcd;
@@ -54,11 +46,11 @@ export default class BigNumber {
 	}
 
 	/**
-	 * Adds a number to this number.
-	 * @param n The other number.
+	 * Add a number to this number.
+	 * @param n - The other number.
 	 * @returns This number.
 	 */
-	public add(n: IntegerRepresentation | BigNumber): this {
+	public add(n: bigint | boolean | number | string | BigNumber): this {
 		if (n instanceof BigNumber) {
 			this.dividend = this.dividend * n.divisor + n.dividend * this.divisor;
 			this.divisor *= n.divisor;
@@ -71,11 +63,11 @@ export default class BigNumber {
 	}
 
 	/**
-	 * Subtracts a number from this number.
-	 * @param n The other number.
+	 * Subtract a number from this number.
+	 * @param n - The other number.
 	 * @returns This number.
 	 */
-	public subtract(n: IntegerRepresentation | BigNumber): this {
+	public subtract(n: bigint | boolean | number | string | BigNumber): this {
 		if (n instanceof BigNumber) {
 			this.dividend = this.dividend * n.divisor - n.dividend * this.divisor;
 			this.divisor *= n.divisor;
@@ -88,11 +80,11 @@ export default class BigNumber {
 	}
 
 	/**
-	 * Multiplies this number by a number.
-	 * @param n The other number.
+	 * Multiply this number by a number.
+	 * @param n - The other number.
 	 * @returns This number.
 	 */
-	public multiply(n: IntegerRepresentation | BigNumber): this {
+	public multiply(n: bigint | boolean | number | string | BigNumber): this {
 		if (n instanceof BigNumber) {
 			this.dividend *= n.dividend;
 			this.divisor *= n.divisor;
@@ -105,11 +97,11 @@ export default class BigNumber {
 	}
 
 	/**
-	 * Divides this number by a number.
-	 * @param n The other number.
+	 * Divide this number by a number.
+	 * @param n - The other number.
 	 * @returns This number.
 	 */
-	public divide(n: IntegerRepresentation | BigNumber): this {
+	public divide(n: bigint | boolean | number | string | BigNumber): this {
 		if (n instanceof BigNumber) {
 			this.dividend *= n.divisor;
 			this.divisor *= n.dividend;
@@ -122,8 +114,7 @@ export default class BigNumber {
 	}
 
 	/**
-	 * Converts this number to a regular `number`. Might result in loss of
-	 * precision.
+	 * Convert this number to a regular `number`. Might result in loss of precision.
 	 * @returns This number as a `number`.
 	 */
 	public toNumber(): number {
@@ -134,10 +125,10 @@ export default class BigNumber {
 	}
 
 	/**
-	 * Converts this number to a string.
+	 * Convert this number to a string.
 	 * @returns A string representation of this number.
 	 */
-	public toString(): string {
-		return `${this.dividend}/${this.divisor}`;
+	public toString() {
+		return `${this.dividend.toLocaleString()}/${this.divisor.toLocaleString()}`;
 	}
 }

package/src/utility/MagnitudeError.ts

@@ -1,10 +1,10 @@
-/** An error resulting from using a vector that is too small. */
+/** An error resulting from using a vector that is too small or too large. */
 export default class MagnitudeError extends Error {
 	/**
-	 * Creates an error resulting from using a vector that is too small.
-	 * @param message The message of the error.
+	 * Create an error resulting from using a vector that is too small or too large.
+	 * @param message - The message of the error.
 	 */
-	public constructor(message = "The vector is too small.") {
+	public constructor(message = "The vector is too small or too large.") {
 		super(message);
 		this.name = "MagnitudeError";
 	}

package/src/utility/MatrixSizeError.ts

@@ -1,9 +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.
-	 * @param message The message of the error.
+	 * Create 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.") {
 		super(message);

package/src/utility/PartialMatrixError.ts

@@ -1,9 +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.
-	 * @param message The message of the error.
+	 * Create 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.") {
 		super(message);

package/src/utility/SingularMatrixError.ts

@@ -4,8 +4,8 @@
  */
 export default class SingularMatrixError extends Error {
 	/**
-	 * Creates an error resulting from trying to invert a singular matrix.
-	 * @param message The message of the error.
+	 * Create an error resulting from trying to invert a singular matrix.
+	 * @param message - The message of the error.
 	 */
 	public constructor(message = "The matrix cannot be inverted.") {
 		super(message);

package/src/utility/epsilon.ts

@@ -1,5 +1,2 @@
-/**
- * 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;

package/dist/types/IntegerRepresentation.d.ts

@@ -1,2 +0,0 @@
-export type IntegerRepresentation = string | number | bigint | boolean;
-//# sourceMappingURL=IntegerRepresentation.d.ts.map

package/dist/types/IntegerRepresentation.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"IntegerRepresentation.d.ts","sourceRoot":"","sources":["../../src/types/IntegerRepresentation.ts"],"names":[],"mappings":"AACA,MAAM,MAAM,qBAAqB,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC"}

package/dist/types/IntegerRepresentation.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=IntegerRepresentation.js.map

package/dist/types/IntegerRepresentation.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"IntegerRepresentation.js","sourceRoot":"","sources":["../../src/types/IntegerRepresentation.ts"],"names":[],"mappings":""}

package/src/types/IntegerRepresentation.ts

@@ -1,2 +0,0 @@
-/** A value that represents an integer. */
-export type IntegerRepresentation = string | number | bigint | boolean;