@lakuna/umath 1.3.5 → 1.3.7

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Travis Martin
+Copyright (c) 2024 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

package/dist/algorithms/combinations.d.ts

@@ -1,2 +1,9 @@
+/**
+ * Calculate the number of combinations.
+ * @param n - The total number of units.
+ * @param r - The number of units taken at a time.
+ * @returns The number of combinations.
+ * @see [Combination](https://en.wikipedia.org/wiki/Combination)
+ */
 export default function combinations(n: number, r: number): number;
 //# sourceMappingURL=combinations.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"combinations.d.ts","sourceRoot":"","sources":["../../src/algorithms/combinations.ts"],"names":[],"mappings":"AASA,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,UAExD"}
+{"version":3,"file":"combinations.d.ts","sourceRoot":"","sources":["../../src/algorithms/combinations.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAEjE"}

package/dist/algorithms/combinations.js

@@ -1,4 +1,11 @@
 import factorial from "./factorial.js";
+/**
+ * Calculate the number of combinations.
+ * @param n - The total number of units.
+ * @param r - The number of units taken at a time.
+ * @returns The number of combinations.
+ * @see [Combination](https://en.wikipedia.org/wiki/Combination)
+ */
 export default function combinations(n, r) {
     return factorial(n) / (factorial(r) * factorial(n - r));
 }

package/dist/algorithms/combinations.js.map

@@ -1 +1 @@
-{"version":3,"file":"combinations.js","sourceRoot":"","sources":["../../src/algorithms/combinations.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,gBAAgB,CAAC;AASvC,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,CAAS,EAAE,CAAS;IACxD,OAAO,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AACzD,CAAC"}
+{"version":3,"file":"combinations.js","sourceRoot":"","sources":["../../src/algorithms/combinations.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,gBAAgB,CAAC;AAEvC;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,CAAS,EAAE,CAAS;IACxD,OAAO,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AACzD,CAAC"}

package/dist/algorithms/degreesToRadians.d.ts

@@ -1,2 +1,9 @@
+/**
+ * Convert a number of degrees to an equivalent number of radians.
+ * @param degrees - The number of degrees.
+ * @returns A number of radians.
+ * @see [Degree](https://en.wikipedia.org/wiki/Degree_(angle))
+ * @see [Radian](https://en.wikipedia.org/wiki/Radian)
+ */
 export default function degreesToRadians(degrees: number): number;
 //# sourceMappingURL=degreesToRadians.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"degreesToRadians.d.ts","sourceRoot":"","sources":["../../src/algorithms/degreesToRadians.ts"],"names":[],"mappings":"AAOA,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,OAAO,EAAE,MAAM,UAEvD"}
+{"version":3,"file":"degreesToRadians.d.ts","sourceRoot":"","sources":["../../src/algorithms/degreesToRadians.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAEhE"}

package/dist/algorithms/degreesToRadians.js

@@ -1,3 +1,10 @@
+/**
+ * Convert a number of degrees to an equivalent number of radians.
+ * @param degrees - The number of degrees.
+ * @returns A number of radians.
+ * @see [Degree](https://en.wikipedia.org/wiki/Degree_(angle))
+ * @see [Radian](https://en.wikipedia.org/wiki/Radian)
+ */
 export default function degreesToRadians(degrees) {
     return (degrees * Math.PI) / 180;
 }

package/dist/algorithms/degreesToRadians.js.map

@@ -1 +1 @@
-{"version":3,"file":"degreesToRadians.js","sourceRoot":"","sources":["../../src/algorithms/degreesToRadians.ts"],"names":[],"mappings":"AAOA,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,OAAe;IACvD,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC;AAClC,CAAC"}
+{"version":3,"file":"degreesToRadians.js","sourceRoot":"","sources":["../../src/algorithms/degreesToRadians.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,OAAe;IACvD,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC;AAClC,CAAC"}

package/dist/algorithms/factorial.d.ts

@@ -1,2 +1,8 @@
+/**
+ * Calculate the factorial of a number.
+ * @param n - The number.
+ * @returns The factorial.
+ * @see [Factorial](https://en.wikipedia.org/wiki/Factorial)
+ */
 export default function factorial(n: number): number;
 //# sourceMappingURL=factorial.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"factorial.d.ts","sourceRoot":"","sources":["../../src/algorithms/factorial.ts"],"names":[],"mappings":"AAMA,MAAM,CAAC,OAAO,UAAU,SAAS,CAAC,CAAC,EAAE,MAAM,UAW1C"}
+{"version":3,"file":"factorial.d.ts","sourceRoot":"","sources":["../../src/algorithms/factorial.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,SAAS,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAWnD"}

package/dist/algorithms/factorial.js

@@ -1,7 +1,14 @@
+/**
+ * Calculate the factorial of a number.
+ * @param n - The number.
+ * @returns The factorial.
+ * @see [Factorial](https://en.wikipedia.org/wiki/Factorial)
+ */
 export default function factorial(n) {
     if (n < 0) {
-        return n % 2 ? Infinity : -Infinity;
+        return n % 2 ? Infinity : -Infinity; // Division by zero returns `Infinity` in JavaScript.
     }
+    // Not recursive in order to avoid exceeding the maximum call stack size.
     let out = 1;
     for (let i = 2; i <= n; i++) {
         out *= i;

package/dist/algorithms/factorial.js.map

@@ -1 +1 @@
-{"version":3,"file":"factorial.js","sourceRoot":"","sources":["../../src/algorithms/factorial.ts"],"names":[],"mappings":"AAMA,MAAM,CAAC,OAAO,UAAU,SAAS,CAAC,CAAS;IAC1C,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACX,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;IACrC,CAAC;IAGD,IAAI,GAAG,GAAG,CAAC,CAAC;IACZ,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QAC7B,GAAG,IAAI,CAAC,CAAC;IACV,CAAC;IACD,OAAO,GAAG,CAAC;AACZ,CAAC"}
+{"version":3,"file":"factorial.js","sourceRoot":"","sources":["../../src/algorithms/factorial.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,SAAS,CAAC,CAAS;IAC1C,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACX,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,qDAAqD;IAC3F,CAAC;IAED,yEAAyE;IACzE,IAAI,GAAG,GAAG,CAAC,CAAC;IACZ,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QAC7B,GAAG,IAAI,CAAC,CAAC;IACV,CAAC;IACD,OAAO,GAAG,CAAC;AACZ,CAAC"}

package/dist/algorithms/fibonacci.d.ts

@@ -1,2 +1,7 @@
-export default function fibonacci(): Generator<number, void, unknown>;
+/**
+ * Calculate numbers in the Fibonacci sequence.
+ * @returns The next value in the Fibonacci sequence.
+ * @see [Fibonacci sequence](https://en.wikipedia.org/wiki/Fibonacci_sequence)
+ */
+export default function fibonacci(): Generator<number, void>;
 //# sourceMappingURL=fibonacci.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"fibonacci.d.ts","sourceRoot":"","sources":["../../src/algorithms/fibonacci.ts"],"names":[],"mappings":"AAKA,MAAM,CAAC,OAAO,UAAW,SAAS,qCAQjC"}
+{"version":3,"file":"fibonacci.d.ts","sourceRoot":"","sources":["../../src/algorithms/fibonacci.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAW,SAAS,IAAI,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,CAQ5D"}

package/dist/algorithms/fibonacci.js

@@ -1,3 +1,8 @@
+/**
+ * Calculate numbers in the Fibonacci sequence.
+ * @returns The next value in the Fibonacci sequence.
+ * @see [Fibonacci sequence](https://en.wikipedia.org/wiki/Fibonacci_sequence)
+ */
 export default function* fibonacci() {
     let a = 0;
     let b = 1;

package/dist/algorithms/fibonacci.js.map

@@ -1 +1 @@
-{"version":3,"file":"fibonacci.js","sourceRoot":"","sources":["../../src/algorithms/fibonacci.ts"],"names":[],"mappings":"AAKA,MAAM,CAAC,OAAO,SAAS,CAAC,CAAC,SAAS;IACjC,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,IAAI,CAAC,GAAG,CAAC,CAAC;IAEV,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACf,MAAM,CAAC,CAAC;QACR,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACrB,CAAC;AACF,CAAC"}
+{"version":3,"file":"fibonacci.js","sourceRoot":"","sources":["../../src/algorithms/fibonacci.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,CAAC,OAAO,SAAS,CAAC,CAAC,SAAS;IACjC,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,IAAI,CAAC,GAAG,CAAC,CAAC;IAEV,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACf,MAAM,CAAC,CAAC;QACR,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACrB,CAAC;AACF,CAAC"}

package/dist/algorithms/greatestCommonDivisor.d.ts

@@ -1,3 +1,17 @@
+/**
+ * Determine the greatest common divisor of two integers.
+ * @param a - The first integer.
+ * @param b - The second integer.
+ * @returns The greatest common divisor.
+ * @see [Greatest common divisor](https://en.wikipedia.org/wiki/Greatest_common_divisor)
+ */
 export default function greatestCommonDivisor(a: bigint, b: bigint): bigint;
+/**
+ * Determine the greatest common divisor of two integers.
+ * @param a - The first integer.
+ * @param b - The second integer.
+ * @returns The greatest common divisor.
+ * @see [Greatest common divisor](https://en.wikipedia.org/wiki/Greatest_common_divisor)
+ */
 export default function greatestCommonDivisor(a: number, b: number): number;
 //# sourceMappingURL=greatestCommonDivisor.d.ts.map

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

@@ -1 +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"}
+{"version":3,"file":"greatestCommonDivisor.d.ts","sourceRoot":"","sources":["../../src/algorithms/greatestCommonDivisor.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,qBAAqB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;AAE5E;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,qBAAqB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC"}

package/dist/algorithms/greatestCommonDivisor.js

@@ -1,6 +1,8 @@
 export default function greatestCommonDivisor(a, b) {
+    // Ensure that both of the integers are positive.
     let c = a < 0 ? -a : a;
     let d = b < 0 ? -b : b;
+    // Apply the Euclidean algorithm.
     while (d) {
         [c, d] = [d, c % d];
     }

package/dist/algorithms/greatestCommonDivisor.js.map

@@ -1 +1 @@
-{"version":3,"file":"greatestCommonDivisor.js","sourceRoot":"","sources":["../../src/algorithms/greatestCommonDivisor.ts"],"names":[],"mappings":"AAkBA,MAAM,CAAC,OAAO,UAAU,qBAAqB,CAC5C,CAAkB,EAClB,CAAkB;IAGlB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACvB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAGvB,OAAO,CAAC,EAAE,CAAC;QACV,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,EAAG,CAAY,GAAI,CAAY,CAAC,CAAC;IAC7C,CAAC;IAED,OAAO,CAAC,CAAC;AACV,CAAC"}
+{"version":3,"file":"greatestCommonDivisor.js","sourceRoot":"","sources":["../../src/algorithms/greatestCommonDivisor.ts"],"names":[],"mappings":"AAkBA,MAAM,CAAC,OAAO,UAAU,qBAAqB,CAC5C,CAAkB,EAClB,CAAkB;IAElB,iDAAiD;IACjD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACvB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAEvB,iCAAiC;IACjC,OAAO,CAAC,EAAE,CAAC;QACV,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,EAAG,CAAY,GAAI,CAAY,CAAC,CAAC;IAC7C,CAAC;IAED,OAAO,CAAC,CAAC;AACV,CAAC"}

package/dist/algorithms/hypergeometricPmf.d.ts

@@ -1,2 +1,11 @@
+/**
+ * The probability mass function for the hypergeometric distribution.
+ * @param N - The size of the finite population.
+ * @param K - The number of objects with the desired feature in the finite population.
+ * @param n - The number of draws without replacement.
+ * @param k - The desired number of successes.
+ * @see [Hypergeometric distribution](https://en.wikipedia.org/wiki/Hypergeometric_distribution)
+ * @see [Probability mass function](https://en.wikipedia.org/wiki/Probability_mass_function)
+ */
 export default function hypergeometricPmf(N: number, K: number, n: number, k: number): number;
 //# sourceMappingURL=hypergeometricPmf.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"hypergeometricPmf.d.ts","sourceRoot":"","sources":["../../src/algorithms/hypergeometricPmf.ts"],"names":[],"mappings":"AAWA,MAAM,CAAC,OAAO,UAAU,iBAAiB,CACxC,CAAC,EAAE,MAAM,EACT,CAAC,EAAE,MAAM,EACT,CAAC,EAAE,MAAM,EACT,CAAC,EAAE,MAAM,UAGT"}
+{"version":3,"file":"hypergeometricPmf.d.ts","sourceRoot":"","sources":["../../src/algorithms/hypergeometricPmf.ts"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AACH,MAAM,CAAC,OAAO,UAAU,iBAAiB,CACxC,CAAC,EAAE,MAAM,EACT,CAAC,EAAE,MAAM,EACT,CAAC,EAAE,MAAM,EACT,CAAC,EAAE,MAAM,GACP,MAAM,CAER"}

package/dist/algorithms/hypergeometricPmf.js

@@ -1,4 +1,13 @@
 import combinations from "./combinations.js";
+/**
+ * The probability mass function for the hypergeometric distribution.
+ * @param N - The size of the finite population.
+ * @param K - The number of objects with the desired feature in the finite population.
+ * @param n - The number of draws without replacement.
+ * @param k - The desired number of successes.
+ * @see [Hypergeometric distribution](https://en.wikipedia.org/wiki/Hypergeometric_distribution)
+ * @see [Probability mass function](https://en.wikipedia.org/wiki/Probability_mass_function)
+ */
 export default function hypergeometricPmf(N, K, n, k) {
     return (combinations(K, k) * combinations(N - K, n - k)) / combinations(N, n);
 }

package/dist/algorithms/hypergeometricPmf.js.map

@@ -1 +1 @@
-{"version":3,"file":"hypergeometricPmf.js","sourceRoot":"","sources":["../../src/algorithms/hypergeometricPmf.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,mBAAmB,CAAC;AAW7C,MAAM,CAAC,OAAO,UAAU,iBAAiB,CACxC,CAAS,EACT,CAAS,EACT,CAAS,EACT,CAAS;IAET,OAAO,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAC/E,CAAC"}
+{"version":3,"file":"hypergeometricPmf.js","sourceRoot":"","sources":["../../src/algorithms/hypergeometricPmf.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,mBAAmB,CAAC;AAE7C;;;;;;;;GAQG;AACH,MAAM,CAAC,OAAO,UAAU,iBAAiB,CACxC,CAAS,EACT,CAAS,EACT,CAAS,EACT,CAAS;IAET,OAAO,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAC/E,CAAC"}

package/dist/algorithms/isPrime.d.ts

@@ -1,2 +1,8 @@
+/**
+ * Returns whether or not a number is prime.
+ * @param n - The number.
+ * @returns Whether or not the number is prime.
+ * @see [Prime number](https://en.wikipedia.org/wiki/Prime_number)
+ */
 export default function isPrime(n: number): boolean;
 //# sourceMappingURL=isPrime.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"isPrime.d.ts","sourceRoot":"","sources":["../../src/algorithms/isPrime.ts"],"names":[],"mappings":"AAMA,MAAM,CAAC,OAAO,UAAU,OAAO,CAAC,CAAC,EAAE,MAAM,WAaxC"}
+{"version":3,"file":"isPrime.d.ts","sourceRoot":"","sources":["../../src/algorithms/isPrime.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,OAAO,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAalD"}

package/dist/algorithms/isPrime.js

@@ -1,4 +1,11 @@
+/**
+ * Returns whether or not a number is prime.
+ * @param n - The number.
+ * @returns Whether or not the number is prime.
+ * @see [Prime number](https://en.wikipedia.org/wiki/Prime_number)
+ */
 export default function isPrime(n) {
+    // Negatives, zero, and one can't be prime.
     if (n < 2) {
         return false;
     }

package/dist/algorithms/isPrime.js.map

@@ -1 +1 @@
-{"version":3,"file":"isPrime.js","sourceRoot":"","sources":["../../src/algorithms/isPrime.ts"],"names":[],"mappings":"AAMA,MAAM,CAAC,OAAO,UAAU,OAAO,CAAC,CAAS;IAExC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACX,OAAO,KAAK,CAAC;IACd,CAAC;IAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QACjC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YACjB,OAAO,KAAK,CAAC;QACd,CAAC;IACF,CAAC;IAED,OAAO,IAAI,CAAC;AACb,CAAC"}
+{"version":3,"file":"isPrime.js","sourceRoot":"","sources":["../../src/algorithms/isPrime.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,OAAO,CAAC,CAAS;IACxC,2CAA2C;IAC3C,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACX,OAAO,KAAK,CAAC;IACd,CAAC;IAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QACjC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YACjB,OAAO,KAAK,CAAC;QACd,CAAC;IACF,CAAC;IAED,OAAO,IAAI,CAAC;AACb,CAAC"}

package/dist/algorithms/permutations.d.ts

@@ -1,2 +1,9 @@
+/**
+ * Calculate the number of permutations.
+ * @param n - The total number of units.
+ * @param r - The number of units taken at a time.
+ * @returns The number of permutations.
+ * @see [Permutation](https://en.wikipedia.org/wiki/Permutation)
+ */
 export default function permutations(n: number, r: number): number;
 //# sourceMappingURL=permutations.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"permutations.d.ts","sourceRoot":"","sources":["../../src/algorithms/permutations.ts"],"names":[],"mappings":"AASA,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,UAExD"}
+{"version":3,"file":"permutations.d.ts","sourceRoot":"","sources":["../../src/algorithms/permutations.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAEjE"}

package/dist/algorithms/permutations.js

@@ -1,4 +1,11 @@
 import factorial from "./factorial.js";
+/**
+ * Calculate the number of permutations.
+ * @param n - The total number of units.
+ * @param r - The number of units taken at a time.
+ * @returns The number of permutations.
+ * @see [Permutation](https://en.wikipedia.org/wiki/Permutation)
+ */
 export default function permutations(n, r) {
     return factorial(n) / factorial(n - r);
 }

package/dist/algorithms/permutations.js.map

@@ -1 +1 @@
-{"version":3,"file":"permutations.js","sourceRoot":"","sources":["../../src/algorithms/permutations.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,gBAAgB,CAAC;AASvC,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,CAAS,EAAE,CAAS;IACxD,OAAO,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;AACxC,CAAC"}
+{"version":3,"file":"permutations.js","sourceRoot":"","sources":["../../src/algorithms/permutations.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,gBAAgB,CAAC;AAEvC;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,CAAS,EAAE,CAAS;IACxD,OAAO,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;AACxC,CAAC"}

package/dist/algorithms/primeFactorization.d.ts

@@ -1,2 +1,8 @@
+/**
+ * Factor a number into a list of prime numbers.
+ * @param n - The number to factor.
+ * @returns A list of prime number factors of the number.
+ * @see [Integer factorization](https://en.wikipedia.org/wiki/Integer_factorization)
+ */
 export default function primeFactorization(n: number): number[];
 //# sourceMappingURL=primeFactorization.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"primeFactorization.d.ts","sourceRoot":"","sources":["../../src/algorithms/primeFactorization.ts"],"names":[],"mappings":"AAMA,MAAM,CAAC,OAAO,UAAU,kBAAkB,CAAC,CAAC,EAAE,MAAM,YAcnD"}
+{"version":3,"file":"primeFactorization.d.ts","sourceRoot":"","sources":["../../src/algorithms/primeFactorization.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,kBAAkB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAc9D"}

package/dist/algorithms/primeFactorization.js

@@ -1,3 +1,9 @@
+/**
+ * Factor a number into a list of prime numbers.
+ * @param n - The number to factor.
+ * @returns A list of prime number factors of the number.
+ * @see [Integer factorization](https://en.wikipedia.org/wiki/Integer_factorization)
+ */
 export default function primeFactorization(n) {
     let m = n;
     const out = [];

package/dist/algorithms/primeFactorization.js.map

@@ -1 +1 @@
-{"version":3,"file":"primeFactorization.js","sourceRoot":"","sources":["../../src/algorithms/primeFactorization.ts"],"names":[],"mappings":"AAMA,MAAM,CAAC,OAAO,UAAU,kBAAkB,CAAC,CAAS;IACnD,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,MAAM,GAAG,GAAG,EAAE,CAAC;IACf,IAAI,OAAO,GAAG,CAAC,CAAC;IAChB,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACf,IAAI,CAAC,GAAG,OAAO,KAAK,CAAC,EAAE,CAAC;YACvB,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAClB,CAAC,IAAI,OAAO,CAAC;QACd,CAAC;aAAM,CAAC;YACP,OAAO,EAAE,CAAC;QACX,CAAC;IACF,CAAC;IAED,OAAO,GAAG,CAAC;AACZ,CAAC"}
+{"version":3,"file":"primeFactorization.js","sourceRoot":"","sources":["../../src/algorithms/primeFactorization.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,kBAAkB,CAAC,CAAS;IACnD,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,MAAM,GAAG,GAAG,EAAE,CAAC;IACf,IAAI,OAAO,GAAG,CAAC,CAAC;IAChB,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACf,IAAI,CAAC,GAAG,OAAO,KAAK,CAAC,EAAE,CAAC;YACvB,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAClB,CAAC,IAAI,OAAO,CAAC;QACd,CAAC;aAAM,CAAC;YACP,OAAO,EAAE,CAAC;QACX,CAAC;IACF,CAAC;IAED,OAAO,GAAG,CAAC;AACZ,CAAC"}

package/dist/algorithms/radiansToDegrees.d.ts

@@ -1,2 +1,9 @@
+/**
+ * Convert a number of radians to an equivalent number of degrees.
+ * @param radians - The number of radians.
+ * @returns A number of degrees.
+ * @see [Degree](https://en.wikipedia.org/wiki/Degree_(angle))
+ * @see [Radian](https://en.wikipedia.org/wiki/Radian)
+ */
 export default function radiansToDegrees(radians: number): number;
 //# sourceMappingURL=radiansToDegrees.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"radiansToDegrees.d.ts","sourceRoot":"","sources":["../../src/algorithms/radiansToDegrees.ts"],"names":[],"mappings":"AAOA,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,OAAO,EAAE,MAAM,UAEvD"}
+{"version":3,"file":"radiansToDegrees.d.ts","sourceRoot":"","sources":["../../src/algorithms/radiansToDegrees.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAEhE"}

package/dist/algorithms/radiansToDegrees.js

@@ -1,3 +1,10 @@
+/**
+ * Convert a number of radians to an equivalent number of degrees.
+ * @param radians - The number of radians.
+ * @returns A number of degrees.
+ * @see [Degree](https://en.wikipedia.org/wiki/Degree_(angle))
+ * @see [Radian](https://en.wikipedia.org/wiki/Radian)
+ */
 export default function radiansToDegrees(radians) {
     return (radians * 180) / Math.PI;
 }

package/dist/algorithms/radiansToDegrees.js.map

@@ -1 +1 @@
-{"version":3,"file":"radiansToDegrees.js","sourceRoot":"","sources":["../../src/algorithms/radiansToDegrees.ts"],"names":[],"mappings":"AAOA,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,OAAe;IACvD,OAAO,CAAC,OAAO,GAAG,GAAG,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC;AAClC,CAAC"}
+{"version":3,"file":"radiansToDegrees.js","sourceRoot":"","sources":["../../src/algorithms/radiansToDegrees.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,OAAe;IACvD,OAAO,CAAC,OAAO,GAAG,GAAG,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC;AAClC,CAAC"}

package/dist/algorithms/summation.d.ts

@@ -1,2 +1,10 @@
+/**
+ * Perform 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 sum.
+ * @see [Summation](https://en.wikipedia.org/wiki/Summation)
+ */
 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

@@ -1 +1 @@
-{"version":3,"file":"summation.d.ts","sourceRoot":"","sources":["../../src/algorithms/summation.ts"],"names":[],"mappings":"AAQA,MAAM,CAAC,OAAO,UAAU,SAAS,CAChC,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,UAS3B"}
+{"version":3,"file":"summation.d.ts","sourceRoot":"","sources":["../../src/algorithms/summation.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,UAAU,SAAS,CAChC,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,GACzB,MAAM,CAQR"}

package/dist/algorithms/summation.js

@@ -1,4 +1,13 @@
+/**
+ * Perform 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 sum.
+ * @see [Summation](https://en.wikipedia.org/wiki/Summation)
+ */
 export default function summation(min, max, term) {
+    // Not recursive in order to avoid exceeding the maximum call stack size.
     let out = 0;
     for (let i = min; i <= max; i++) {
         out += term(i);

package/dist/algorithms/summation.js.map

@@ -1 +1 @@
-{"version":3,"file":"summation.js","sourceRoot":"","sources":["../../src/algorithms/summation.ts"],"names":[],"mappings":"AAQA,MAAM,CAAC,OAAO,UAAU,SAAS,CAChC,GAAW,EACX,GAAW,EACX,IAA2B;IAG3B,IAAI,GAAG,GAAG,CAAC,CAAC;IACZ,KAAK,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC,IAAI,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACjC,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;IAChB,CAAC;IAED,OAAO,GAAG,CAAC;AACZ,CAAC"}
+{"version":3,"file":"summation.js","sourceRoot":"","sources":["../../src/algorithms/summation.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,UAAU,SAAS,CAChC,GAAW,EACX,GAAW,EACX,IAA2B;IAE3B,yEAAyE;IACzE,IAAI,GAAG,GAAG,CAAC,CAAC;IACZ,KAAK,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC,IAAI,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACjC,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;IAChB,CAAC;IAED,OAAO,GAAG,CAAC;AACZ,CAAC"}