@thi.ng/math 5.3.18 → 5.4.1

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2022-12-22T21:47:07Z
+- **Last updated**: 2023-02-05T14:42:22Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,12 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+## [5.4.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/math@5.4.0) (2023-01-10)
+
+#### 🚀 Features
+
+- add factorial. permutation/combination fns ([965af0d](https://github.com/thi-ng/umbrella/commit/965af0d))
+
 ## [5.3.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/math@5.3.0) (2022-03-11)
 
 #### 🚀 Features

package/README.md

@@ -66,7 +66,7 @@ For Node.js REPL:
 const math = await import("@thi.ng/math");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 3.91 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 4.03 KB
 
 ## Dependencies
 
@@ -116,4 +116,4 @@ If this project contributes to an academic publication, please cite it as:
 
 ## License
 
-© 2013 - 2022 Karsten Schmidt // Apache License 2.0
+© 2013 - 2023 Karsten Schmidt // Apache License 2.0

package/index.d.ts

@@ -10,6 +10,7 @@ export * from "./interval.js";
 export * from "./libc.js";
 export * from "./min-error.js";
 export * from "./mix.js";
+export * from "./permutations.js";
 export * from "./prec.js";
 export * from "./prime.js";
 export * from "./ratio.js";

package/index.js

@@ -10,6 +10,7 @@ export * from "./interval.js";
 export * from "./libc.js";
 export * from "./min-error.js";
 export * from "./mix.js";
+export * from "./permutations.js";
 export * from "./prec.js";
 export * from "./prime.js";
 export * from "./ratio.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/math",
-  "version": "5.3.18",
+  "version": "5.4.1",
   "description": "Assorted common math functions & utilities",
   "type": "module",
   "module": "./index.js",
@@ -37,15 +37,15 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.6.2"
+    "@thi.ng/api": "^8.7.0"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.33.7",
-    "@thi.ng/testament": "^0.3.8",
-    "rimraf": "^3.0.2",
+    "@microsoft/api-extractor": "^7.34.2",
+    "@thi.ng/testament": "^0.3.10",
+    "rimraf": "^4.1.2",
     "tools": "^0.0.1",
-    "typedoc": "^0.23.22",
-    "typescript": "^4.9.4"
+    "typedoc": "^0.23.24",
+    "typescript": "^4.9.5"
   },
   "keywords": [
     "animation",
@@ -113,6 +113,9 @@
     "./mix": {
       "default": "./mix.js"
     },
+    "./permutations": {
+      "default": "./permutations.js"
+    },
     "./prec": {
       "default": "./prec.js"
     },
@@ -135,5 +138,5 @@
   "thi.ng": {
     "year": 2013
   },
-  "gitHead": "bc6f7f5e2765bb96fe64db804eaf4b2443b47fc6\n"
+  "gitHead": "50ba9c87676fac60c46d2bc0e4d2c7711a374a68\n"
 }

package/permutations.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Computes factorial for `n`. Throws an error if `n < 0`.
+ *
+ * @param n
+ */
+export declare const factorial: (n: number) => number;
+/**
+ * Computes `n ** k`
+ *
+ * @param n number of choices
+ * @param k number of selected
+ */
+export declare const permutationsWithRep: (n: number, k: number) => number;
+/**
+ * Computes `n! / (n - k)!`
+ *
+ * @remarks
+ * Reference:
+ * https://en.wikipedia.org/wiki/Permutation#k-permutations_of_n
+ *
+ * @param n number of choices
+ * @param k number of selected
+ */
+export declare const permutationsWithoutRep: (n: number, k: number) => number;
+/**
+ * Computes `(n + k - 1)! / (k! * (n - 1)!)`
+ *
+ * @param n number of choices
+ * @param k number of selected
+ */
+export declare const combinationsWithRep: (n: number, k: number) => number;
+/**
+ * Computes `n! / (k! * (n - k)!)`
+ *
+ * @remarks
+ * https://en.wikipedia.org/wiki/Combination#Number_of_k-combinations
+ *
+ * @param n number of choices
+ * @param k number of selected
+ */
+export declare const combinationsWithoutRep: (n: number, k: number) => number;
+//# sourceMappingURL=permutations.d.ts.map

package/permutations.js

@@ -0,0 +1,48 @@
+/**
+ * Computes factorial for `n`. Throws an error if `n < 0`.
+ *
+ * @param n
+ */
+export const factorial = (n) => {
+    if (n < 0)
+        throw new Error(`illegal argument: ${n}`);
+    let res = 1;
+    for (let i = 1; i <= n; i++)
+        res *= i;
+    return res;
+};
+/**
+ * Computes `n ** k`
+ *
+ * @param n number of choices
+ * @param k number of selected
+ */
+export const permutationsWithRep = (n, k) => n ** k;
+/**
+ * Computes `n! / (n - k)!`
+ *
+ * @remarks
+ * Reference:
+ * https://en.wikipedia.org/wiki/Permutation#k-permutations_of_n
+ *
+ * @param n number of choices
+ * @param k number of selected
+ */
+export const permutationsWithoutRep = (n, k) => factorial(n) / factorial(n - k);
+/**
+ * Computes `(n + k - 1)! / (k! * (n - 1)!)`
+ *
+ * @param n number of choices
+ * @param k number of selected
+ */
+export const combinationsWithRep = (n, k) => factorial(n + k - 1) / (factorial(k) * factorial(n - 1));
+/**
+ * Computes `n! / (k! * (n - k)!)`
+ *
+ * @remarks
+ * https://en.wikipedia.org/wiki/Combination#Number_of_k-combinations
+ *
+ * @param n number of choices
+ * @param k number of selected
+ */
+export const combinationsWithoutRep = (n, k) => factorial(n) / (factorial(k) * factorial(n - k));