@lakuna/umath 0.0.1 → 0.0.3

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2023 Travis Martin
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2023 Travis Martin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,2 +1,9 @@
-# umath
-A lightweight math library.
+[![npm bundle size](https://img.shields.io/bundlephobia/minzip/@lakuna/umath?style=for-the-badge)](https://bundlephobia.com/package/@lakuna/umath)
+
+# μMath
+
+A lightweight math library.
+
+Documentation is automatically generated and uploaded to [the website](https://umath.lakuna.pw/).
+
+The source code can be found on [the GitHub repository](https://github.com/Lakuna/umath).

package/dist/algorithms/greatestCommonDivisor.d.ts

@@ -0,0 +1,3 @@
+export default function greatestCommonDivisor(a: bigint, b: bigint): bigint;
+export default function greatestCommonDivisor(a: number, b: number): number;
+//# sourceMappingURL=greatestCommonDivisor.d.ts.map

package/dist/algorithms/greatestCommonDivisor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"greatestCommonDivisor.d.ts","sourceRoot":"","sources":["../../src/algorithms/greatestCommonDivisor.ts"],"names":[],"mappings":"AAOA,MAAM,CAAC,OAAO,UAAU,qBAAqB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;AAS5E,MAAM,CAAC,OAAO,UAAU,qBAAqB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC"}

package/dist/algorithms/greatestCommonDivisor.js

@@ -0,0 +1,13 @@
+export default function greatestCommonDivisor(a, b) {
+    if (a < 0) {
+        a = -a;
+    }
+    if (b < 0) {
+        b = -b;
+    }
+    while (b) {
+        [a, b] = [b, a % b];
+    }
+    return a;
+}
+//# sourceMappingURL=greatestCommonDivisor.js.map

package/dist/algorithms/greatestCommonDivisor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"greatestCommonDivisor.js","sourceRoot":"","sources":["../../src/algorithms/greatestCommonDivisor.ts"],"names":[],"mappings":"AAkBA,MAAM,CAAC,OAAO,UAAU,qBAAqB,CAAC,CAAkB,EAAE,CAAkB;IAEnF,IAAI,CAAC,GAAG,CAAC,EAAE;QAAE,CAAC,GAAG,CAAC,CAAC,CAAC;KAAE;IACtB,IAAI,CAAC,GAAG,CAAC,EAAE;QAAE,CAAC,GAAG,CAAC,CAAC,CAAC;KAAE;IAGtB,OAAO,CAAC,EAAE;QACT,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,EAAG,CAAY,GAAI,CAAY,CAAC,CAAC;KAC5C;IAED,OAAO,CAAC,CAAC;AACV,CAAC"}

package/dist/algorithms/summation.d.ts

@@ -0,0 +1,2 @@
+export default function summation(min: number, max: number, term: (i: number) => number): number;
+//# sourceMappingURL=summation.d.ts.map

package/dist/algorithms/summation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"summation.d.ts","sourceRoot":"","sources":["../../src/algorithms/summation.ts"],"names":[],"mappings":"AAiBA,MAAM,CAAC,OAAO,UAAU,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,GAAG,MAAM,CAE/F"}

package/dist/algorithms/summation.js

@@ -0,0 +1,7 @@
+function summationInternal(i, max, term) {
+    return term(i) + (i < max ? summationInternal(i + 1, max, term) : 0);
+}
+export default function summation(min, max, term) {
+    return summationInternal(min, max, term);
+}
+//# sourceMappingURL=summation.js.map

package/dist/algorithms/summation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"summation.js","sourceRoot":"","sources":["../../src/algorithms/summation.ts"],"names":[],"mappings":"AAMA,SAAS,iBAAiB,CAAC,CAAS,EAAE,GAAW,EAAE,IAA2B;IAC7E,OAAO,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACtE,CAAC;AASD,MAAM,CAAC,OAAO,UAAU,SAAS,CAAC,GAAW,EAAE,GAAW,EAAE,IAA2B;IACtF,OAAO,iBAAiB,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;AAC1C,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export { default as greatestCommonDivisor } from "./algorithms/greatestCommonDivisor.js";
+export { default as summation } from "./algorithms/summation.js";
+export type { IntegerRepresentation } from "./types/IntegerRepresentation.js";
+export { default as BigNumber } from "./utility/BigNumber.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AACzF,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACjE,YAAY,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAC;AAC9E,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,wBAAwB,CAAC"}

package/dist/index.js

@@ -0,0 +1,4 @@
+export { default as greatestCommonDivisor } from "./algorithms/greatestCommonDivisor.js";
+export { default as summation } from "./algorithms/summation.js";
+export { default as BigNumber } from "./utility/BigNumber.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AACzF,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAEjE,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,wBAAwB,CAAC"}

package/dist/types/IntegerRepresentation.d.ts

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

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

@@ -0,0 +1 @@
+{"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

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

package/dist/types/IntegerRepresentation.js.map

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

package/dist/utility/BigNumber.d.ts

@@ -0,0 +1,15 @@
+import { type IntegerRepresentation } from "../index.js";
+export default class BigNumber {
+    constructor(source?: IntegerRepresentation);
+    constructor(dividend?: IntegerRepresentation, divisor?: IntegerRepresentation);
+    dividend: bigint;
+    divisor: bigint;
+    private simplify;
+    add(n: IntegerRepresentation | BigNumber): this;
+    subtract(n: IntegerRepresentation | BigNumber): this;
+    multiply(n: IntegerRepresentation | BigNumber): this;
+    divide(n: IntegerRepresentation | BigNumber): this;
+    toNumber(): number;
+    toString(): string;
+}
+//# sourceMappingURL=BigNumber.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BigNumber.d.ts","sourceRoot":"","sources":["../../src/utility/BigNumber.ts"],"names":[],"mappings":"AAAA,OAAO,EAAyB,KAAK,qBAAqB,EAAE,MAAM,aAAa,CAAC;AAGhF,MAAM,CAAC,OAAO,OAAO,SAAS;gBAKV,MAAM,CAAC,EAAE,qBAAqB;gBAO9B,QAAQ,CAAC,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,qBAAqB;IAS7E,QAAQ,EAAE,MAAM,CAAC;IAGjB,OAAO,EAAE,MAAM,CAAC;IAGvB,OAAO,CAAC,QAAQ;IAoBT,GAAG,CAAC,CAAC,EAAE,qBAAqB,GAAG,SAAS,GAAG,IAAI;IAiB/C,QAAQ,CAAC,CAAC,EAAE,qBAAqB,GAAG,SAAS,GAAG,IAAI;IAiBpD,QAAQ,CAAC,CAAC,EAAE,qBAAqB,GAAG,SAAS,GAAG,IAAI;IAiBpD,MAAM,CAAC,CAAC,EAAE,qBAAqB,GAAG,SAAS,GAAG,IAAI;IAgBlD,QAAQ,IAAI,MAAM;IAQlB,QAAQ,IAAI,MAAM;CAGzB"}

package/dist/utility/BigNumber.js

@@ -0,0 +1,72 @@
+import { greatestCommonDivisor } from "../index.js";
+export default class BigNumber {
+    constructor(dividend = 0, divisor = 1) {
+        this.dividend = BigInt(dividend);
+        this.divisor = BigInt(divisor);
+        this.simplify();
+    }
+    dividend;
+    divisor;
+    simplify() {
+        if (this.divisor < 0) {
+            this.dividend = -this.dividend;
+            this.divisor = -this.divisor;
+        }
+        const gcd = greatestCommonDivisor(this.dividend, this.divisor);
+        if (gcd > 1) {
+            this.dividend /= gcd;
+            this.divisor /= gcd;
+        }
+    }
+    add(n) {
+        if (n instanceof BigNumber) {
+            this.dividend = this.dividend * n.divisor + n.dividend * this.divisor;
+            this.divisor *= n.divisor;
+        }
+        else {
+            this.dividend += BigInt(n) * this.divisor;
+        }
+        this.simplify();
+        return this;
+    }
+    subtract(n) {
+        if (n instanceof BigNumber) {
+            this.dividend = this.dividend * n.divisor - n.dividend * this.divisor;
+            this.divisor *= n.divisor;
+        }
+        else {
+            this.dividend -= BigInt(n) * this.divisor;
+        }
+        this.simplify();
+        return this;
+    }
+    multiply(n) {
+        if (n instanceof BigNumber) {
+            this.dividend *= n.dividend;
+            this.divisor *= n.divisor;
+        }
+        else {
+            this.dividend *= BigInt(n);
+        }
+        this.simplify();
+        return this;
+    }
+    divide(n) {
+        if (n instanceof BigNumber) {
+            this.dividend *= n.divisor;
+            this.divisor *= n.dividend;
+        }
+        else {
+            this.divisor *= BigInt(n);
+        }
+        this.simplify();
+        return this;
+    }
+    toNumber() {
+        return Number(this.dividend / this.divisor) + (Number(this.dividend % this.divisor) / Number(this.divisor));
+    }
+    toString() {
+        return `${this.dividend}/${this.divisor}`;
+    }
+}
+//# sourceMappingURL=BigNumber.js.map

package/dist/utility/BigNumber.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BigNumber.js","sourceRoot":"","sources":["../../src/utility/BigNumber.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAA8B,MAAM,aAAa,CAAC;AAGhF,MAAM,CAAC,OAAO,OAAO,SAAS;IAc7B,YAAmB,WAAkC,CAAC,EAAE,UAAiC,CAAC;QACzF,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;QACjC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;QAC/B,IAAI,CAAC,QAAQ,EAAE,CAAC;IACjB,CAAC;IAGM,QAAQ,CAAS;IAGjB,OAAO,CAAS;IAGf,QAAQ;QAEf,IAAI,IAAI,CAAC,OAAO,GAAG,CAAC,EAAE;YACrB,IAAI,CAAC,QAAQ,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC;YAC/B,IAAI,CAAC,OAAO,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC;SAC7B;QAGD,MAAM,GAAG,GAAW,qBAAqB,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACvE,IAAI,GAAG,GAAG,CAAC,EAAE;YACZ,IAAI,CAAC,QAAQ,IAAI,GAAG,CAAC;YACrB,IAAI,CAAC,OAAO,IAAI,GAAG,CAAC;SACpB;IACF,CAAC;IAOM,GAAG,CAAC,CAAoC;QAC9C,IAAI,CAAC,YAAY,SAAS,EAAE;YAC3B,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;SAC1B;aAAM;YACN,IAAI,CAAC,QAAQ,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC;SAC1C;QAED,IAAI,CAAC,QAAQ,EAAE,CAAC;QAChB,OAAO,IAAI,CAAC;IACb,CAAC;IAOM,QAAQ,CAAC,CAAoC;QACnD,IAAI,CAAC,YAAY,SAAS,EAAE;YAC3B,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;SAC1B;aAAM;YACN,IAAI,CAAC,QAAQ,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC;SAC1C;QAED,IAAI,CAAC,QAAQ,EAAE,CAAC;QAChB,OAAO,IAAI,CAAC;IACb,CAAC;IAOM,QAAQ,CAAC,CAAoC;QACnD,IAAI,CAAC,YAAY,SAAS,EAAE;YAC3B,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC,QAAQ,CAAC;YAC5B,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,OAAO,CAAC;SAC1B;aAAM;YACN,IAAI,CAAC,QAAQ,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC;SAC3B;QAED,IAAI,CAAC,QAAQ,EAAE,CAAC;QAChB,OAAO,IAAI,CAAC;IACb,CAAC;IAOM,MAAM,CAAC,CAAoC;QACjD,IAAI,CAAC,YAAY,SAAS,EAAE;YAC3B,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC,OAAO,CAAC;YAC3B,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,QAAQ,CAAC;SAC3B;aAAM;YACN,IAAI,CAAC,OAAO,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC;SAC1B;QAED,IAAI,CAAC,QAAQ,EAAE,CAAC;QAChB,OAAO,IAAI,CAAC;IACb,CAAC;IAMM,QAAQ;QACd,OAAO,MAAM,CAAC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAC7G,CAAC;IAMM,QAAQ;QACd,OAAO,GAAG,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;IAC3C,CAAC;CACD"}

package/package.json

@@ -1,51 +1,51 @@
-{
-	"name": "@lakuna/umath",
-	"version": "0.0.1",
-	"description": "A lightweight math library.",
-	"keywords": [
-		"math"
-	],
-	"homepage": "https://umath.lakuna.pw",
-	"bugs": {
-		"url": "https://github.com/Lakuna/umath/issues",
-		"email": "tjmartin2003@gmail.com"
-	},
-	"license": "MIT",
-	"author": {
-		"name": "Travis Martin",
-		"email": "tjmartin2003@gmail.com",
-		"url": "https://www.lakuna.pw/"
-	},
-	"funding": {
-		"type": "individual",
-		"url": "https://github.com/sponsors/Lakuna"
-	},
-	"files": [
-		"./dist/*",
-		"./src/*"
-	],
-	"main": "./dist/index.js",
-	"browser": "./dist/index.js",
-	"exports": {
-		".": "./dist/index.js"
-	},
-	"types": "./dist/index.d.ts",
-	"repository": {
-		"type": "git",
-		"url": "github:Lakuna/umath"
-	},
-	"scripts": {
-		"build": "tsc",
-		"lint": "eslint src",
-		"doc": "typedoc src"
-	},
-	"type": "module",
-	"sideEffects": false,
-	"devDependencies": {
-		"@typescript-eslint/eslint-plugin": "^5.59.1",
-		"@typescript-eslint/parser": "^5.59.1",
-		"eslint": "^8.39.0",
-		"typedoc": "^0.24.6",
-		"typescript": "^5.0.4"
-	}
-}
+{
+	"name": "@lakuna/umath",
+	"version": "0.0.3",
+	"description": "A lightweight math library.",
+	"keywords": [
+		"math"
+	],
+	"homepage": "https://umath.lakuna.pw",
+	"bugs": {
+		"url": "https://github.com/Lakuna/umath/issues",
+		"email": "tjmartin2003@gmail.com"
+	},
+	"license": "MIT",
+	"author": {
+		"name": "Travis Martin",
+		"email": "tjmartin2003@gmail.com",
+		"url": "https://www.lakuna.pw/"
+	},
+	"funding": {
+		"type": "individual",
+		"url": "https://github.com/sponsors/Lakuna"
+	},
+	"files": [
+		"dist/*",
+		"src/*"
+	],
+	"main": "./dist/index.js",
+	"browser": "./dist/index.js",
+	"exports": {
+		".": "./dist/index.js"
+	},
+	"types": "./dist/index.d.ts",
+	"repository": {
+		"type": "git",
+		"url": "github:Lakuna/umath"
+	},
+	"scripts": {
+		"build": "tsc",
+		"lint": "eslint src",
+		"doc": "typedoc src"
+	},
+	"type": "module",
+	"sideEffects": false,
+	"devDependencies": {
+		"@typescript-eslint/eslint-plugin": "^5.59.1",
+		"@typescript-eslint/parser": "^5.59.1",
+		"eslint": "^8.39.0",
+		"typedoc": "^0.24.6",
+		"typescript": "^5.0.4"
+	}
+}

package/src/algorithms/greatestCommonDivisor.ts

@@ -0,0 +1,30 @@
+/**
+ * Determines the greatest common divisor of two integers.
+ * @param a The first integer.
+ * @param b The second integer.
+ * @returns The greatest common divisor of the integers.
+ * @see [Wikipedia](https://en.wikipedia.org/wiki/Greatest_common_divisor)
+ */
+export default function greatestCommonDivisor(a: bigint, b: bigint): bigint;
+
+/**
+ * Determines the greatest common divisor of two integers.
+ * @param a The first integer.
+ * @param b The second integer.
+ * @returns The greatest common divisor of the integers.
+ * @see [Wikipedia](https://en.wikipedia.org/wiki/Greatest_common_divisor)
+ */
+export default function greatestCommonDivisor(a: number, b: number): number;
+
+export default function greatestCommonDivisor(a: bigint | number, b: bigint | number): bigint | number {
+	// Ensure that all of the integers are positive.
+	if (a < 0) { a = -a; }
+	if (b < 0) { b = -b; }
+
+	// Apply the Euclidean algorithm.
+	while (b) {
+		[a, b] = [b, (a as number) % (b as number)];
+	}
+
+	return a;
+}

package/src/algorithms/summation.ts

@@ -0,0 +1,20 @@
+/**
+ * Recursively sums up the results of the given function.
+ * @param i The index of summation.
+ * @param max The upper bound of the index of summation.
+ * @param term The function used to generate each term.
+ */
+function summationInternal(i: number, max: number, term: (i: number) => number): number {
+	return term(i) + (i < max ? summationInternal(i + 1, max, term) : 0);
+}
+
+/**
+ * Performs a summation.
+ * @param min The lower bound (inclusive) of the index of summation.
+ * @param max The upper bound (inclusive) of the index of summation.
+ * @param term The function used to generate each term.
+ * @returns The summation.
+ */
+export default function summation(min: number, max: number, term: (i: number) => number): number {
+	return summationInternal(min, max, term);
+}

package/src/index.ts

@@ -1 +1,4 @@
-export const foo = "bar";
+export { default as greatestCommonDivisor } from "./algorithms/greatestCommonDivisor.js";
+export { default as summation } from "./algorithms/summation.js";
+export type { IntegerRepresentation } from "./types/IntegerRepresentation.js";
+export { default as BigNumber } from "./utility/BigNumber.js";

package/src/types/IntegerRepresentation.ts

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

package/src/utility/BigNumber.ts

@@ -0,0 +1,129 @@
+import { greatestCommonDivisor, type IntegerRepresentation } from "../index.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.
+	 */
+	public constructor(dividend?: IntegerRepresentation, divisor?: IntegerRepresentation);
+
+	public constructor(dividend: IntegerRepresentation = 0, divisor: IntegerRepresentation = 1) {
+		this.dividend = BigInt(dividend);
+		this.divisor = BigInt(divisor);
+		this.simplify();
+	}
+
+	/** The dividend of this fraction. */
+	public dividend: bigint;
+
+	/** The divisor of this fraction. */
+	public divisor: bigint;
+
+	/** Simplifies this fraction. */
+	private simplify(): void {
+		// Switches 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);
+		if (gcd > 1) {
+			this.dividend /= gcd;
+			this.divisor /= gcd;
+		}
+	}
+
+	/**
+	 * Adds a number to this number.
+	 * @param n The other number.
+	 * @returns This number.
+	 */
+	public add(n: IntegerRepresentation | BigNumber): this {
+		if (n instanceof BigNumber) {
+			this.dividend = this.dividend * n.divisor + n.dividend * this.divisor;
+			this.divisor *= n.divisor;
+		} else {
+			this.dividend += BigInt(n) * this.divisor;
+		}
+
+		this.simplify();
+		return this;
+	}
+
+	/**
+	 * Subtracts a number from this number.
+	 * @param n The other number.
+	 * @returns This number.
+	 */
+	public subtract(n: IntegerRepresentation | BigNumber): this {
+		if (n instanceof BigNumber) {
+			this.dividend = this.dividend * n.divisor - n.dividend * this.divisor;
+			this.divisor *= n.divisor;
+		} else {
+			this.dividend -= BigInt(n) * this.divisor;
+		}
+
+		this.simplify();
+		return this;
+	}
+
+	/**
+	 * Multiplies this number by a number.
+	 * @param n The other number.
+	 * @returns This number.
+	 */
+	public multiply(n: IntegerRepresentation | BigNumber): this {
+		if (n instanceof BigNumber) {
+			this.dividend *= n.dividend;
+			this.divisor *= n.divisor;
+		} else {
+			this.dividend *= BigInt(n);
+		}
+
+		this.simplify();
+		return this;
+	}
+
+	/**
+	 * Divides this number by a number.
+	 * @param n The other number.
+	 * @returns This number.
+	 */
+	public divide(n: IntegerRepresentation | BigNumber): this {
+		if (n instanceof BigNumber) {
+			this.dividend *= n.divisor;
+			this.divisor *= n.dividend;
+		} else {
+			this.divisor *= BigInt(n);
+		}
+
+		this.simplify();
+		return this;
+	}
+
+	/**
+	 * Converts this number to a regular `number`. Might result in loss of precision.
+	 * @returns This number as a `number`.
+	 */
+	public toNumber(): number {
+		return Number(this.dividend / this.divisor) + (Number(this.dividend % this.divisor) / Number(this.divisor));
+	}
+
+	/**
+	 * Converts this number to a string.
+	 * @returns A string representation of this number.
+	 */
+	public toString(): string {
+		return `${this.dividend}/${this.divisor}`;
+	}
+}