@lakuna/umath 3.0.0 → 4.0.0

package/dist/utility/BigNumber.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BigNumber.d.ts","sourceRoot":"","sources":["../../src/utility/BigNumber.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,UAAU,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;AAE1D;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,GAAG,SAAS,CAAC;AAEnD;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,SAAS;IAC7B,qCAAqC;IAC9B,QAAQ,EAAE,MAAM,CAAC;IAExB,oCAAoC;IAC7B,OAAO,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;gBACgB,QAAQ,GAAE,aAAiB,EAAE,OAAO,GAAE,aAAiB;IAuB1E;;;;OAIG;IACI,GAAG,CAAC,CAAC,EAAE,aAAa,GAAG,IAAI;IAYlC;;;;OAIG;IACI,MAAM,CAAC,CAAC,EAAE,aAAa,GAAG,IAAI;IAYrC;;;;OAIG;IACI,QAAQ,CAAC,CAAC,EAAE,aAAa,GAAG,IAAI;IAYvC;;;;OAIG;IACI,QAAQ,CAAC,CAAC,EAAE,aAAa,GAAG,IAAI;IAYvC;;;OAGG;IACI,QAAQ,IAAI,MAAM;IAOzB;;;OAGG;IACI,QAAQ,IAAI,MAAM;CAsBzB"}
+{"version":3,"file":"BigNumber.d.ts","sourceRoot":"","sources":["../../src/utility/BigNumber.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,UAAU,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;AAE1D;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,GAAG,SAAS,CAAC;AAEnD;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,SAAS;IAC7B,qCAAqC;IAC9B,QAAQ,EAAE,MAAM,CAAC;IAExB,oCAAoC;IAC7B,OAAO,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;gBAEF,QAAQ,GAAE,QAAQ,CAAC,aAAa,CAAK,EACrC,OAAO,GAAE,QAAQ,CAAC,aAAa,CAAK;IAgCrC;;;;OAIG;IACI,GAAG,CAAC,CAAC,EAAE,QAAQ,CAAC,aAAa,CAAC,GAAG,IAAI;IAY5C;;;;OAIG;IACI,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,aAAa,CAAC,GAAG,IAAI;IAY/C;;;;OAIG;IACI,QAAQ,CAAC,CAAC,EAAE,QAAQ,CAAC,aAAa,CAAC,GAAG,IAAI;IAYjD;;;;OAIG;IACI,QAAQ,CAAC,CAAC,EAAE,QAAQ,CAAC,aAAa,CAAC,GAAG,IAAI;IAYjD;;;OAGG;IACI,QAAQ,IAAI,MAAM;IAOzB;;;OAGG;IACI,QAAQ,IAAI,MAAM;CAsBzB"}

package/dist/utility/BigNumber.js

@@ -17,14 +17,14 @@ export default class BigNumber {
         if (divisor === 0) {
             throw new Error("Cannot divide by zero.");
         }
-        if (dividend instanceof BigNumber) {
+        if (BigNumber.is(dividend)) {
             this.dividend = dividend.dividend;
             this.divisor = dividend.divisor;
             this.divide(divisor);
             return;
         }
         this.dividend = BigInt(dividend);
-        if (divisor instanceof BigNumber) {
+        if (BigNumber.is(divisor)) {
             this.divisor = 1n;
             this.divide(divisor);
             return;
@@ -32,13 +32,20 @@ export default class BigNumber {
         this.divisor = BigInt(divisor);
         this.simplify();
     }
+    /**
+     * Utility function for narrowing `Readonly<BigNumberLike>` to `Readonly<BigNumber>` or `BigIntLike`, since `Readonly` breaks the type narrowing for TypeScript.
+     * @internal
+     */
+    static is(value) {
+        return value instanceof BigNumber;
+    }
     /**
      * Add a number to this number.
      * @param n - The other number.
      * @returns This number.
      */
     add(n) {
-        if (n instanceof BigNumber) {
+        if (BigNumber.is(n)) {
             this.dividend = this.dividend * n.divisor + n.dividend * this.divisor;
             this.divisor *= n.divisor;
         }
@@ -54,7 +61,7 @@ export default class BigNumber {
      * @returns This number.
      */
     divide(n) {
-        if (n instanceof BigNumber) {
+        if (BigNumber.is(n)) {
             this.dividend *= n.divisor;
             this.divisor *= n.dividend;
         }
@@ -70,7 +77,7 @@ export default class BigNumber {
      * @returns This number.
      */
     multiply(n) {
-        if (n instanceof BigNumber) {
+        if (BigNumber.is(n)) {
             this.dividend *= n.dividend;
             this.divisor *= n.divisor;
         }
@@ -86,7 +93,7 @@ export default class BigNumber {
      * @returns This number.
      */
     subtract(n) {
-        if (n instanceof BigNumber) {
+        if (BigNumber.is(n)) {
             this.dividend = this.dividend * n.divisor - n.dividend * this.divisor;
             this.divisor *= n.divisor;
         }

package/dist/utility/BigNumber.js.map

@@ -1 +1 @@
-{"version":3,"file":"BigNumber.js","sourceRoot":"","sources":["../../src/utility/BigNumber.ts"],"names":[],"mappings":"AAAA,OAAO,qBAAqB,MAAM,wCAAwC,CAAC;AAc3E;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,SAAS;IAC7B,qCAAqC;IAC9B,QAAQ,CAAS;IAExB,oCAAoC;IAC7B,OAAO,CAAS;IAEvB;;;;OAIG;IACH,YAAmB,WAA0B,CAAC,EAAE,UAAyB,CAAC;QACzE,IAAI,OAAO,KAAK,CAAC,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC3C,CAAC;QAED,IAAI,QAAQ,YAAY,SAAS,EAAE,CAAC;YACnC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;YAClC,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC;YAChC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YACrB,OAAO;QACR,CAAC;QAED,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;QACjC,IAAI,OAAO,YAAY,SAAS,EAAE,CAAC;YAClC,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;YAClB,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YACrB,OAAO;QACR,CAAC;QAED,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;QAC/B,IAAI,CAAC,QAAQ,EAAE,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,GAAG,CAAC,CAAgB;QAC1B,IAAI,CAAC,YAAY,SAAS,EAAE,CAAC;YAC5B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC;YACtE,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,OAAO,CAAC;QAC3B,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,QAAQ,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC;QAC3C,CAAC;QAED,IAAI,CAAC,QAAQ,EAAE,CAAC;QAChB,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,CAAgB;QAC7B,IAAI,CAAC,YAAY,SAAS,EAAE,CAAC;YAC5B,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC,OAAO,CAAC;YAC3B,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,QAAQ,CAAC;QAC5B,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,OAAO,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC;QAC3B,CAAC;QAED,IAAI,CAAC,QAAQ,EAAE,CAAC;QAChB,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;OAIG;IACI,QAAQ,CAAC,CAAgB;QAC/B,IAAI,CAAC,YAAY,SAAS,EAAE,CAAC;YAC5B,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC,QAAQ,CAAC;YAC5B,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,OAAO,CAAC;QAC3B,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,QAAQ,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC;QAC5B,CAAC;QAED,IAAI,CAAC,QAAQ,EAAE,CAAC;QAChB,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;OAIG;IACI,QAAQ,CAAC,CAAgB;QAC/B,IAAI,CAAC,YAAY,SAAS,EAAE,CAAC;YAC5B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC;YACtE,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,OAAO,CAAC;QAC3B,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,QAAQ,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC;QAC3C,CAAC;QAED,IAAI,CAAC,QAAQ,EAAE,CAAC;QAChB,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;OAGG;IACI,QAAQ;QACd,OAAO,CACN,MAAM,CAAC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC;YACpC,MAAM,CAAC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAC3D,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,QAAQ;QACd,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,IAAI,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC;IAC7E,CAAC;IAED;;;OAGG;IACK,QAAQ;QACf,4DAA4D;QAC5D,IAAI,IAAI,CAAC,OAAO,GAAG,CAAC,EAAE,CAAC;YACtB,IAAI,CAAC,QAAQ,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC;YAC/B,IAAI,CAAC,OAAO,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC;QAC9B,CAAC;QAED,gDAAgD;QAChD,MAAM,GAAG,GAAG,qBAAqB,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/D,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC;YACb,IAAI,CAAC,QAAQ,IAAI,GAAG,CAAC;YACrB,IAAI,CAAC,OAAO,IAAI,GAAG,CAAC;QACrB,CAAC;IACF,CAAC;CACD"}
+{"version":3,"file":"BigNumber.js","sourceRoot":"","sources":["../../src/utility/BigNumber.ts"],"names":[],"mappings":"AAAA,OAAO,qBAAqB,MAAM,wCAAwC,CAAC;AAc3E;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,SAAS;IAC7B,qCAAqC;IAC9B,QAAQ,CAAS;IAExB,oCAAoC;IAC7B,OAAO,CAAS;IAEvB;;;;OAIG;IACH,YACC,WAAoC,CAAC,EACrC,UAAmC,CAAC;QAEpC,IAAI,OAAO,KAAK,CAAC,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC3C,CAAC;QAED,IAAI,SAAS,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;YAClC,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC;YAChC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YACrB,OAAO;QACR,CAAC;QAED,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;QACjC,IAAI,SAAS,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;YAC3B,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;YAClB,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YACrB,OAAO;QACR,CAAC;QAED,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;QAC/B,IAAI,CAAC,QAAQ,EAAE,CAAC;IACjB,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,EAAE,CAAC,KAAc;QAC/B,OAAO,KAAK,YAAY,SAAS,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACI,GAAG,CAAC,CAA0B;QACpC,IAAI,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACrB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC;YACtE,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,OAAO,CAAC;QAC3B,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,QAAQ,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC;QAC3C,CAAC;QAED,IAAI,CAAC,QAAQ,EAAE,CAAC;QAChB,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,CAA0B;QACvC,IAAI,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACrB,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC,OAAO,CAAC;YAC3B,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,QAAQ,CAAC;QAC5B,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,OAAO,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC;QAC3B,CAAC;QAED,IAAI,CAAC,QAAQ,EAAE,CAAC;QAChB,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;OAIG;IACI,QAAQ,CAAC,CAA0B;QACzC,IAAI,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACrB,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC,QAAQ,CAAC;YAC5B,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,OAAO,CAAC;QAC3B,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,QAAQ,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC;QAC5B,CAAC;QAED,IAAI,CAAC,QAAQ,EAAE,CAAC;QAChB,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;OAIG;IACI,QAAQ,CAAC,CAA0B;QACzC,IAAI,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACrB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC;YACtE,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,OAAO,CAAC;QAC3B,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,QAAQ,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC;QAC3C,CAAC;QAED,IAAI,CAAC,QAAQ,EAAE,CAAC;QAChB,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;OAGG;IACI,QAAQ;QACd,OAAO,CACN,MAAM,CAAC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC;YACpC,MAAM,CAAC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAC3D,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,QAAQ;QACd,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,IAAI,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC;IAC7E,CAAC;IAED;;;OAGG;IACK,QAAQ;QACf,4DAA4D;QAC5D,IAAI,IAAI,CAAC,OAAO,GAAG,CAAC,EAAE,CAAC;YACtB,IAAI,CAAC,QAAQ,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC;YAC/B,IAAI,CAAC,OAAO,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC;QAC9B,CAAC;QAED,gDAAgD;QAChD,MAAM,GAAG,GAAG,qBAAqB,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/D,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC;YACb,IAAI,CAAC,QAAQ,IAAI,GAAG,CAAC;YACrB,IAAI,CAAC,OAAO,IAAI,GAAG,CAAC;QACrB,CAAC;IACF,CAAC;CACD"}

package/package.json

@@ -1,53 +1,26 @@
 {
-	"name": "@lakuna/umath",
-	"version": "3.0.0",
-	"description": "A lightweight math library.",
-	"keywords": [
-		"math"
-	],
-	"homepage": "https://umath.lakuna.pw",
-	"bugs": {
-		"url": "https://github.com/Lakuna/umath/issues",
-		"email": "travis@lakuna.pw"
-	},
-	"license": "MIT",
 	"author": {
-		"name": "Travis Martin",
 		"email": "travis@lakuna.pw",
+		"name": "Travis Martin",
 		"url": "https://www.lakuna.pw/"
 	},
-	"funding": {
-		"type": "individual",
-		"url": "https://github.com/sponsors/Lakuna"
-	},
-	"files": [
-		"dist",
-		"src"
-	],
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/Lakuna/umath.git"
-	},
-	"scripts": {
-		"build": "tsc",
-		"lint": "eslint src",
-		"doc": "typedoc",
-		"test": "node --test",
-		"beautify": "prettier . --write"
+	"bugs": {
+		"email": "travis@lakuna.pw",
+		"url": "https://github.com/Lakuna/umath/issues"
 	},
+	"description": "A lightweight math library.",
 	"devDependencies": {
 		"@eslint/js": "^10.0.1",
 		"@types/eslint": "^9.6.1",
 		"@types/eslint-config-prettier": "^6.11.3",
 		"@types/node": "^25.5.0",
-		"eslint": "^10.0.3",
+		"eslint": "^10.1.0",
 		"eslint-config-prettier": "^10.1.8",
 		"eslint-plugin-perfectionist": "^5.7.0",
 		"eslint-plugin-prettier": "^5.5.5",
 		"eslint-plugin-tsdoc": "^0.5.2",
-		"globals": "^17.4.0",
 		"prettier": "^3.8.1",
-		"typedoc": "^0.28.17",
+		"typedoc": "^0.28.18",
 		"typescript": "^5.9.3",
 		"typescript-eslint": "^8.57.1"
 	},
@@ -62,7 +35,34 @@
 		"./Vector3": "./dist/linalg/Vector3.js",
 		"./Vector4": "./dist/linalg/Vector4.js"
 	},
-	"typings": "./dist/index.d.ts",
+	"files": [
+		"dist",
+		"src"
+	],
+	"funding": {
+		"type": "individual",
+		"url": "https://github.com/sponsors/Lakuna"
+	},
+	"homepage": "https://umath.lakuna.pw/",
+	"keywords": [
+		"math"
+	],
+	"license": "MIT",
+	"main": "./dist/index.js",
+	"name": "@lakuna/umath",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/Lakuna/umath.git"
+	},
+	"scripts": {
+		"build": "tsc",
+		"doc": "typedoc",
+		"fix": "eslint src --fix",
+		"lint": "eslint src",
+		"test": "node --test"
+	},
+	"sideEffects": false,
 	"type": "module",
-	"sideEffects": false
+	"typings": "./dist/index.d.ts",
+	"version": "4.0.0"
 }

package/src/algorithms/hypergeometricPmf.ts

@@ -11,7 +11,9 @@ import combinations from "./combinations.js";
  * @public
  */
 export default function hypergeometricPmf(
+	// eslint-disable-next-line @typescript-eslint/naming-convention
 	N: number,
+	// eslint-disable-next-line @typescript-eslint/naming-convention
 	K: number,
 	n: number,
 	k: number

package/src/algorithms/primeFactorization.ts

@@ -5,7 +5,7 @@
  * @see {@link https://en.wikipedia.org/wiki/Integer_factorization | Integer factorization}
  * @public
  */
-export default function primeFactorization(n: number): number[] {
+export default function primeFactorization(n: number): readonly number[] {
 	let m = n;
 	const out = [];
 	let divisor = 2;

package/src/index.ts

@@ -39,17 +39,12 @@ export { default as Vector3, type Vector3Like } from "./linalg/Vector3.js";
 export { default as Vector4, type Vector4Like } from "./linalg/Vector4.js";
 export type { default as Vector, VectorLike } from "./linalg/Vector.js";
 
-// Types
-export type { default as AxisAngle } from "./types/AxisAngle.js";
-export type { default as FieldOfView } from "./types/FieldOfView.js";
-
 // Utility
 export {
 	type BigIntLike,
 	default as BigNumber,
 	type BigNumberLike
 } from "./utility/BigNumber.js";
-export { default as createAxisAngleLike } from "./utility/createAxisAngleLike.js";
 export { default as epsilon } from "./utility/epsilon.js";
 export { default as MagnitudeError } from "./utility/MagnitudeError.js";
 export { default as MatrixSizeError } from "./utility/MatrixSizeError.js";

package/src/linalg/DualQuaternion.ts

@@ -114,7 +114,7 @@ export const fromValues = <T extends DualQuaternionLike>(
  * @public
  */
 export const copy = <T extends DualQuaternionLike>(
-	dualQuaternion: DualQuaternionLike,
+	dualQuaternion: Readonly<DualQuaternionLike>,
 	out: T
 ): T =>
 	fromValues(
@@ -138,8 +138,8 @@ export const copy = <T extends DualQuaternionLike>(
  * @public
  */
 export const fromRotationTranslation = <T extends DualQuaternionLike>(
-	quaternion: QuaternionLike,
-	translation: Vector3Like,
+	quaternion: Readonly<QuaternionLike>,
+	translation: Readonly<Vector3Like>,
 	out: T
 ): T => {
 	const x = quaternion[0];
@@ -172,7 +172,7 @@ export const fromRotationTranslation = <T extends DualQuaternionLike>(
  * @public
  */
 export const fromTranslation = <T extends DualQuaternionLike>(
-	translation: Vector3Like,
+	translation: Readonly<Vector3Like>,
 	out: T
 ): T =>
 	fromValues(
@@ -195,7 +195,7 @@ export const fromTranslation = <T extends DualQuaternionLike>(
  * @public
  */
 export const fromRotation = <T extends DualQuaternionLike>(
-	quaternion: QuaternionLike,
+	quaternion: Readonly<QuaternionLike>,
 	out: T
 ): T =>
 	fromValues(
@@ -221,7 +221,7 @@ const iv3 = createVector3Like();
  * @public
  */
 export const fromMatrix4 = <T extends DualQuaternionLike>(
-	matrix: Matrix4Like,
+	matrix: Readonly<Matrix4Like>,
 	out: T
 ): T => {
 	matrix4GetScaling(matrix, iv3);
@@ -310,7 +310,7 @@ export const identity = <T extends DualQuaternionLike>(out: T): T =>
  * @public
  */
 export const getReal: <T extends QuaternionLike>(
-	dualQuaternion: DualQuaternionLike,
+	dualQuaternion: Readonly<DualQuaternionLike>,
 	out: T
 ) => T = vector4Copy;
 
@@ -322,7 +322,7 @@ export const getReal: <T extends QuaternionLike>(
  * @public
  */
 export const getDual = <T extends QuaternionLike>(
-	dualQuaternion: DualQuaternionLike,
+	dualQuaternion: Readonly<DualQuaternionLike>,
 	out: T
 ): T =>
 	vector4FromValues(
@@ -341,7 +341,7 @@ export const getDual = <T extends QuaternionLike>(
  * @public
  */
 export const setReal: <T extends DualQuaternionLike>(
-	quaternion: QuaternionLike,
+	quaternion: Readonly<QuaternionLike>,
 	out: T
 ) => T = vector4Copy;
 
@@ -353,7 +353,7 @@ export const setReal: <T extends DualQuaternionLike>(
  * @public
  */
 export const setDual = <T extends DualQuaternionLike>(
-	quaternion: QuaternionLike,
+	quaternion: Readonly<QuaternionLike>,
 	out: T
 ): T => {
 	out[4] = quaternion[0];
@@ -371,7 +371,7 @@ export const setDual = <T extends DualQuaternionLike>(
  * @public
  */
 export const getTranslation = <T extends Vector3Like>(
-	dualQuaternion: DualQuaternionLike,
+	dualQuaternion: Readonly<DualQuaternionLike>,
 	out: T
 ): T => {
 	const ax = dualQuaternion[4];
@@ -400,8 +400,8 @@ export const getTranslation = <T extends Vector3Like>(
  * @public
  */
 export const translate = <T extends DualQuaternionLike>(
-	dualQuaternion: DualQuaternionLike,
-	vector: Vector3Like,
+	dualQuaternion: Readonly<DualQuaternionLike>,
+	vector: Readonly<Vector3Like>,
 	out: T
 ): T => {
 	const ax1 = dualQuaternion[0];
@@ -440,7 +440,7 @@ export const translate = <T extends DualQuaternionLike>(
  * @public
  */
 export const rotateX = <T extends DualQuaternionLike>(
-	dualQuaternion: DualQuaternionLike,
+	dualQuaternion: Readonly<DualQuaternionLike>,
 	radians: number,
 	out: T
 ): T => {
@@ -482,7 +482,7 @@ export const rotateX = <T extends DualQuaternionLike>(
  * @public
  */
 export const rotateY = <T extends DualQuaternionLike>(
-	dualQuaternion: DualQuaternionLike,
+	dualQuaternion: Readonly<DualQuaternionLike>,
 	radians: number,
 	out: T
 ): T => {
@@ -524,7 +524,7 @@ export const rotateY = <T extends DualQuaternionLike>(
  * @public
  */
 export const rotateZ = <T extends DualQuaternionLike>(
-	dualQuaternion: DualQuaternionLike,
+	dualQuaternion: Readonly<DualQuaternionLike>,
 	radians: number,
 	out: T
 ): T => {
@@ -566,8 +566,8 @@ export const rotateZ = <T extends DualQuaternionLike>(
  * @public
  */
 export const rotateByQuaternionAppend = <T extends DualQuaternionLike>(
-	dualQuaternion: DualQuaternionLike,
-	quaternion: QuaternionLike,
+	dualQuaternion: Readonly<DualQuaternionLike>,
+	quaternion: Readonly<QuaternionLike>,
 	out: T
 ): T => {
 	const qx = quaternion[0];
@@ -606,8 +606,8 @@ export const rotateByQuaternionAppend = <T extends DualQuaternionLike>(
  * @public
  */
 export const rotateByQuaternionPrepend = <T extends DualQuaternionLike>(
-	quaternion: QuaternionLike,
-	dualQuaternion: DualQuaternionLike,
+	quaternion: Readonly<QuaternionLike>,
+	dualQuaternion: Readonly<DualQuaternionLike>,
 	out: T
 ): T => {
 	const qx = quaternion[0];
@@ -647,8 +647,8 @@ export const rotateByQuaternionPrepend = <T extends DualQuaternionLike>(
  * @public
  */
 export const rotateAroundAxis = <T extends DualQuaternionLike>(
-	dualQuaternion: DualQuaternionLike,
-	axis: Vector3Like,
+	dualQuaternion: Readonly<DualQuaternionLike>,
+	axis: Readonly<Vector3Like>,
 	radians: number,
 	out: T
 ): T => {
@@ -701,8 +701,8 @@ export const rotateAroundAxis = <T extends DualQuaternionLike>(
  * @public
  */
 export const add = <T extends DualQuaternionLike>(
-	a: DualQuaternionLike,
-	b: DualQuaternionLike,
+	a: Readonly<DualQuaternionLike>,
+	b: Readonly<DualQuaternionLike>,
 	out: T
 ): T =>
 	fromValues(
@@ -726,8 +726,8 @@ export const add = <T extends DualQuaternionLike>(
  * @public
  */
 export const multiply = <T extends DualQuaternionLike>(
-	a: DualQuaternionLike,
-	b: DualQuaternionLike,
+	a: Readonly<DualQuaternionLike>,
+	b: Readonly<DualQuaternionLike>,
 	out: T
 ): T => {
 	const ax0 = a[0];
@@ -800,7 +800,7 @@ export const multiply = <T extends DualQuaternionLike>(
  * @public
  */
 export const scale = <T extends DualQuaternionLike>(
-	dualQuaternion: DualQuaternionLike,
+	dualQuaternion: Readonly<DualQuaternionLike>,
 	scalar: number,
 	out: T
 ): T =>
@@ -824,8 +824,10 @@ export const scale = <T extends DualQuaternionLike>(
  * @see {@link https://en.wikipedia.org/wiki/Dot_product | Dot product}
  * @public
  */
-export const dot: (a: DualQuaternionLike, b: DualQuaternionLike) => number =
-	vector4Dot;
+export const dot: (
+	a: Readonly<DualQuaternionLike>,
+	b: Readonly<DualQuaternionLike>
+) => number = vector4Dot;
 
 /**
  * Perform a linear interpolation between two dual quaternions.
@@ -837,8 +839,8 @@ export const dot: (a: DualQuaternionLike, b: DualQuaternionLike) => number =
  * @public
  */
 export const lerp = <T extends DualQuaternionLike>(
-	a: DualQuaternionLike,
-	b: DualQuaternionLike,
+	a: Readonly<DualQuaternionLike>,
+	b: Readonly<DualQuaternionLike>,
 	t: number,
 	out: T
 ): T => {
@@ -864,8 +866,9 @@ export const lerp = <T extends DualQuaternionLike>(
  * @returns The magnitude.
  * @public
  */
-export const getMagnitude: (dualQuaternion: DualQuaternionLike) => number =
-	vector4GetMagnitude;
+export const getMagnitude: (
+	dualQuaternion: Readonly<DualQuaternionLike>
+) => number = vector4GetMagnitude;
 
 /**
  * Calculate the squared magnitude (length) of a dual quaternion.
@@ -874,7 +877,7 @@ export const getMagnitude: (dualQuaternion: DualQuaternionLike) => number =
  * @public
  */
 export const getSquaredMagnitude: (
-	dualQuaternion: DualQuaternionLike
+	dualQuaternion: Readonly<DualQuaternionLike>
 ) => number = vector4GetSquaredMagnitude;
 
 /**
@@ -885,7 +888,7 @@ export const getSquaredMagnitude: (
  * @public
  */
 export const invert = <T extends DualQuaternionLike>(
-	dualQuaternion: DualQuaternionLike,
+	dualQuaternion: Readonly<DualQuaternionLike>,
 	out: T
 ): T => {
 	const sqm = getSquaredMagnitude(dualQuaternion);
@@ -911,7 +914,7 @@ export const invert = <T extends DualQuaternionLike>(
  * @public
  */
 export const conjugate = <T extends DualQuaternionLike>(
-	dualQuaternion: DualQuaternionLike,
+	dualQuaternion: Readonly<DualQuaternionLike>,
 	out: T
 ): T =>
 	fromValues(
@@ -934,7 +937,7 @@ export const conjugate = <T extends DualQuaternionLike>(
  * @public
  */
 export const normalize = <T extends DualQuaternionLike>(
-	dualQuaternion: DualQuaternionLike,
+	dualQuaternion: Readonly<DualQuaternionLike>,
 	out: T
 ): T => {
 	let magnitude = getSquaredMagnitude(dualQuaternion);
@@ -976,8 +979,8 @@ export const normalize = <T extends DualQuaternionLike>(
  * @public
  */
 export const exactEquals = (
-	a: DualQuaternionLike,
-	b: DualQuaternionLike
+	a: Readonly<DualQuaternionLike>,
+	b: Readonly<DualQuaternionLike>
 ): boolean =>
 	a[0] === b[0] &&
 	a[1] === b[1] &&
@@ -995,7 +998,10 @@ export const exactEquals = (
  * @returns Whether or not the dual quaternions are equivalent.
  * @public
  */
-export const equals = (a: DualQuaternionLike, b: DualQuaternionLike): boolean =>
+export const equals = (
+	a: Readonly<DualQuaternionLike>,
+	b: Readonly<DualQuaternionLike>
+): boolean =>
 	approxRelative(a[0], b[0]) &&
 	approxRelative(a[1], b[1]) &&
 	approxRelative(a[2], b[2]) &&
@@ -1070,7 +1076,7 @@ export default class DualQuaternion
 	 * @param matrix - The matrix.
 	 * @returns The dual quaternion.
 	 */
-	public static fromMatrix4(matrix: Matrix4Like): DualQuaternion {
+	public static fromMatrix4(matrix: Readonly<Matrix4Like>): DualQuaternion {
 		return fromMatrix4(matrix, new DualQuaternion());
 	}
 
@@ -1079,7 +1085,7 @@ export default class DualQuaternion
 	 * @param q - The rotation quaternion.
 	 * @returns The dual quaternion.
 	 */
-	public static fromRotation(q: QuaternionLike): DualQuaternion {
+	public static fromRotation(q: Readonly<QuaternionLike>): DualQuaternion {
 		return fromRotation(q, new DualQuaternion());
 	}
 
@@ -1090,8 +1096,8 @@ export default class DualQuaternion
 	 * @returns The dual quaternion.
 	 */
 	public static fromRotationTranslation(
-		q: QuaternionLike,
-		t: Vector3Like
+		q: Readonly<QuaternionLike>,
+		t: Readonly<Vector3Like>
 	): DualQuaternion {
 		return fromRotationTranslation(q, t, new DualQuaternion());
 	}
@@ -1101,7 +1107,7 @@ export default class DualQuaternion
 	 * @param t - The translation vector.
 	 * @returns The dual quaternion.
 	 */
-	public static fromTranslation(t: Vector3Like): DualQuaternion {
+	public static fromTranslation(t: Readonly<Vector3Like>): DualQuaternion {
 		return fromTranslation(t, new DualQuaternion());
 	}
 
@@ -1135,7 +1141,7 @@ export default class DualQuaternion
 	 * @param dq - The other dual quaternion.
 	 * @returns The sum.
 	 */
-	public add(dq: DualQuaternionLike): DualQuaternion {
+	public add(dq: Readonly<DualQuaternionLike>): DualQuaternion {
 		return add(this, dq, new DualQuaternion());
 	}
 
@@ -1160,7 +1166,7 @@ export default class DualQuaternion
 	 * @param dualQuaternion - The dual quaternion to copy.
 	 * @returns This dual quaternion.
 	 */
-	public copy(dualQuaternion: DualQuaternionLike): this {
+	public copy(dualQuaternion: Readonly<DualQuaternionLike>): this {
 		return copy(dualQuaternion, this);
 	}
 
@@ -1170,7 +1176,7 @@ export default class DualQuaternion
 	 * @returns The dot product.
 	 * @see {@link https://en.wikipedia.org/wiki/Dot_product | Dot product}
 	 */
-	public dot(dq: DualQuaternionLike): number {
+	public dot(dq: Readonly<DualQuaternionLike>): number {
 		return dot(this, dq);
 	}
 
@@ -1179,7 +1185,7 @@ export default class DualQuaternion
 	 * @param dq - The other dual quaternion.
 	 * @returns Whether or not the dual quaternions are equivalent.
 	 */
-	public equals(dq: DualQuaternionLike): boolean {
+	public equals(dq: Readonly<DualQuaternionLike>): boolean {
 		return equals(this, dq);
 	}
 
@@ -1188,7 +1194,7 @@ export default class DualQuaternion
 	 * @param dq - The other dual quaternion.
 	 * @returns Whether or not the dual quaternions are equivalent.
 	 */
-	public exactEquals(dq: DualQuaternionLike): boolean {
+	public exactEquals(dq: Readonly<DualQuaternionLike>): boolean {
 		return exactEquals(this, dq);
 	}
 
@@ -1238,7 +1244,7 @@ export default class DualQuaternion
 	 * @param t - The interpolation amount in `[0,1]`.
 	 * @returns The interpolated value.
 	 */
-	public lerp(dq: DualQuaternionLike, t: number): DualQuaternion {
+	public lerp(dq: Readonly<DualQuaternionLike>, t: number): DualQuaternion {
 		return lerp(this, dq, t, new DualQuaternion());
 	}
 
@@ -1247,7 +1253,7 @@ export default class DualQuaternion
 	 * @param dq - The other dual quaternion.
 	 * @returns The product.
 	 */
-	public multiply(dq: DualQuaternionLike): DualQuaternion {
+	public multiply(dq: Readonly<DualQuaternionLike>): DualQuaternion {
 		return multiply(this, dq, new DualQuaternion());
 	}
 
@@ -1265,7 +1271,10 @@ export default class DualQuaternion
 	 * @param r - The angle of the rotation in radians.
 	 * @returns A normalized dual quaternion.
 	 */
-	public rotateAroundAxis(axis: Vector3Like, r: number): DualQuaternion {
+	public rotateAroundAxis(
+		axis: Readonly<Vector3Like>,
+		r: number
+	): DualQuaternion {
 		return rotateAroundAxis(this, axis, r, new DualQuaternion());
 	}
 
@@ -1275,7 +1284,7 @@ export default class DualQuaternion
 	 * @returns The rotated dual quaternion.
 	 * @see {@link https://en.wikipedia.org/wiki/Quaternion | Quaternion}
 	 */
-	public rotateByQuaternionAppend(q: QuaternionLike): DualQuaternion {
+	public rotateByQuaternionAppend(q: Readonly<QuaternionLike>): DualQuaternion {
 		return rotateByQuaternionAppend(this, q, new DualQuaternion());
 	}
 
@@ -1285,7 +1294,9 @@ export default class DualQuaternion
 	 * @returns The rotated dual quaternion.
 	 * @see {@link https://en.wikipedia.org/wiki/Quaternion | Quaternion}
 	 */
-	public rotateByQuaternionPrepend(q: QuaternionLike): DualQuaternion {
+	public rotateByQuaternionPrepend(
+		q: Readonly<QuaternionLike>
+	): DualQuaternion {
 		return rotateByQuaternionPrepend(q, this, new DualQuaternion());
 	}
 
@@ -1329,7 +1340,7 @@ export default class DualQuaternion
 	 * Set the real part of this dual quaternion.
 	 * @param q - The quaternion.
 	 */
-	public setDual(q: QuaternionLike): void {
+	public setDual(q: Readonly<QuaternionLike>): void {
 		setDual(q, this);
 	}
 
@@ -1337,7 +1348,7 @@ export default class DualQuaternion
 	 * Set the real part of this dual quaternion.
 	 * @param q - The quaternion.
 	 */
-	public setReal(q: QuaternionLike): void {
+	public setReal(q: Readonly<QuaternionLike>): void {
 		setReal(q, this);
 	}
 
@@ -1346,7 +1357,7 @@ export default class DualQuaternion
 	 * @param v - The vector.
 	 * @returns The translated dual quaternion.
 	 */
-	public translate(v: Vector3Like): DualQuaternion {
+	public translate(v: Readonly<Vector3Like>): DualQuaternion {
 		return translate(this, v, new DualQuaternion());
 	}
 }