@thi.ng/math 5.1.1 → 5.3.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2021-11-19T07:59:51Z
+- **Last updated**: 2022-03-11T12:13:49Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,22 @@ 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.3.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/math@5.3.0) (2022-03-11)
+
+#### 🚀 Features
+
+- add ldiv() ([35d1e97](https://github.com/thi-ng/umbrella/commit/35d1e97))
+
+## [5.2.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/math@5.2.0) (2021-12-13)
+
+#### 🚀 Features
+
+- add prime number fns ([f301256](https://github.com/thi-ng/umbrella/commit/f301256))
+  - add nearestPrime()
+  - add primesUntil()
+  - add tests
+  - update pkg
+
 ## [5.1.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/math@5.1.0) (2021-11-17)
 
 #### 🚀 Features

package/README.md

@@ -71,7 +71,7 @@ node --experimental-repl-await
 > const math = await import("@thi.ng/math");
 ```
 
-Package sizes (gzipped, pre-treeshake): ESM: 4.11 KB
+Package sizes (gzipped, pre-treeshake): ESM: 4.29 KB
 
 ## Dependencies
 
@@ -125,4 +125,4 @@ If this project contributes to an academic publication, please cite it as:
 
 ## License
 
-© 2013 - 2021 Karsten Schmidt // Apache Software License 2.0
+© 2013 - 2022 Karsten Schmidt // Apache Software License 2.0

package/api.d.ts

@@ -13,7 +13,7 @@ export declare const PHI: number;
 export declare const SQRT2: number;
 export declare const SQRT3: number;
 export declare const SQRT2_2: number;
-export declare const SQRT2_3: number;
+export declare const SQRT3_2: number;
 export declare const THIRD: number;
 export declare const TWO_THIRD: number;
 export declare const SIXTH: number;

package/api.js

@@ -13,7 +13,7 @@ export const PHI = (1 + Math.sqrt(5)) / 2;
 export const SQRT2 = Math.SQRT2;
 export const SQRT3 = Math.sqrt(3);
 export const SQRT2_2 = SQRT2 / 2;
-export const SQRT2_3 = SQRT3 / 2;
+export const SQRT3_2 = SQRT3 / 2;
 export const THIRD = 1 / 3;
 export const TWO_THIRD = 2 / 3;
 export const SIXTH = 1 / 6;

package/index.d.ts

@@ -11,6 +11,7 @@ export * from "./libc.js";
 export * from "./min-error.js";
 export * from "./mix.js";
 export * from "./prec.js";
+export * from "./prime.js";
 export * from "./ratio.js";
 export * from "./safe-div.js";
 export * from "./solve.js";

package/index.js

@@ -11,6 +11,7 @@ export * from "./libc.js";
 export * from "./min-error.js";
 export * from "./mix.js";
 export * from "./prec.js";
+export * from "./prime.js";
 export * from "./ratio.js";
 export * from "./safe-div.js";
 export * from "./solve.js";

package/interval.d.ts

@@ -10,25 +10,25 @@ export declare const clamp: FnN3;
 /**
  * Clamps value `x` to closed [0 .. ∞] interval.
  *
- * @param x
+ * @param x -
  */
 export declare const clamp0: FnN;
 /**
  * Clamps value `x` to closed [0 .. 1] interval.
  *
- * @param x
+ * @param x -
  */
 export declare const clamp01: FnN;
 /**
  * Clamps value `x` to closed [-1 .. 1] interval.
  *
- * @param x
+ * @param x -
  */
 export declare const clamp11: FnN;
 /**
  * Clamps value `x` to closed [0 .. 0.5] interval.
  *
- * @param x
+ * @param x -
  */
 export declare const clamp05: FnN;
 /**
@@ -71,16 +71,16 @@ export declare const max4id: FnN4;
 /**
  * Returns the non-zero minimum value of the given `a`, `b` args.
  *
- * @param a
- * @param b
+ * @param a -
+ * @param b -
  */
 export declare const minNonZero2: FnN2;
 /**
  * Returns the non-zero minimum value of the given `a`, `b`, `c` args.
  *
- * @param a
- * @param b
- * @param c
+ * @param a -
+ * @param b -
+ * @param c -
  */
 export declare const minNonZero3: FnN3;
 /**

package/interval.js

@@ -9,25 +9,25 @@ export const clamp = (x, min, max) => (x < min ? min : x > max ? max : x);
 /**
  * Clamps value `x` to closed [0 .. ∞] interval.
  *
- * @param x
+ * @param x -
  */
 export const clamp0 = (x) => (x > 0 ? x : 0);
 /**
  * Clamps value `x` to closed [0 .. 1] interval.
  *
- * @param x
+ * @param x -
  */
 export const clamp01 = (x) => (x < 0 ? 0 : x > 1 ? 1 : x);
 /**
  * Clamps value `x` to closed [-1 .. 1] interval.
  *
- * @param x
+ * @param x -
  */
 export const clamp11 = (x) => (x < -1 ? -1 : x > 1 ? 1 : x);
 /**
  * Clamps value `x` to closed [0 .. 0.5] interval.
  *
- * @param x
+ * @param x -
  */
 export const clamp05 = (x) => (x < 0 ? 0 : x > 0.5 ? 0.5 : x);
 /**
@@ -114,16 +114,16 @@ export const max4id = (a, b, c, d) => a >= b
 /**
  * Returns the non-zero minimum value of the given `a`, `b` args.
  *
- * @param a
- * @param b
+ * @param a -
+ * @param b -
  */
 export const minNonZero2 = (a, b) => a !== 0 ? (b !== 0 ? Math.min(a, b) : a) : b;
 /**
  * Returns the non-zero minimum value of the given `a`, `b`, `c` args.
  *
- * @param a
- * @param b
- * @param c
+ * @param a -
+ * @param b -
+ * @param c -
  */
 export const minNonZero3 = (a, b, c) => minNonZero2(minNonZero2(a, b), c);
 /**

package/libc.d.ts

@@ -1,31 +1,31 @@
-import type { FnN, FnN2, FnN3 } from "@thi.ng/api";
+import type { FnN, FnN2, FnN3, FnU2 } from "@thi.ng/api";
 /**
  * Returns a value with the magnitude of `x` and the sign of `y`.
  *
- * @param x
- * @param y
+ * @param x -
+ * @param y -
  */
 export declare const copysign: FnN2;
 /**
  * Returns `2^x`.
  *
- * @param x
+ * @param x -
  */
 export declare const exp2: FnN;
 /**
  * Returns the positive difference between `x` and `y`, i.e. `x - y` iff `x > y`,
  * otherwise zero.
  *
- * @param x
- * @param y
+ * @param x -
+ * @param y -
  */
 export declare const fdim: FnN2;
 /**
  * Returns `x * y + z`.
  *
- * @param x
- * @param y
- * @param z
+ * @param x -
+ * @param y -
+ * @param z -
  */
 export declare const fma: FnN3;
 /**
@@ -42,8 +42,8 @@ export declare const fma: FnN3;
  *
  * Reference: https://www.cplusplus.com/reference/cmath/fmod/
  *
- * @param x
- * @param y
+ * @param x -
+ * @param y -
  */
 export declare const fmod: FnN2;
 /**
@@ -59,14 +59,14 @@ export declare const fmod: FnN2;
  * Based on:
  * https://github.com/locutusjs/locutus/blob/master/src/c/math/frexp.js
  *
- * @param x
+ * @param x -
  */
 export declare const frexp: (x: number) => number[];
 /**
  * Inverse op of {@link frexp}. Returns `x * 2^exp`
  *
- * @param x
- * @param exp
+ * @param x -
+ * @param exp -
  */
 export declare const ldexp: FnN2;
 /**
@@ -75,8 +75,16 @@ export declare const ldexp: FnN2;
  * @remarks
  * https://www.cplusplus.com/reference/cmath/remainder/
  *
- * @param x
- * @param y
+ * @param x -
+ * @param y -
  */
 export declare const remainder: FnN2;
+/**
+ * Computes both the quotient and remainder of the integer division of the
+ * numerator `x` by the denominator `y`.
+ *
+ * @param x -
+ * @param y -
+ */
+export declare const ldiv: FnU2<number, [number, number]>;
 //# sourceMappingURL=libc.d.ts.map

package/libc.js

@@ -1,30 +1,30 @@
 /**
  * Returns a value with the magnitude of `x` and the sign of `y`.
  *
- * @param x
- * @param y
+ * @param x -
+ * @param y -
  */
 export const copysign = (x, y) => Math.sign(y) * Math.abs(x);
 /**
  * Returns `2^x`.
  *
- * @param x
+ * @param x -
  */
 export const exp2 = (x) => 2 ** x;
 /**
  * Returns the positive difference between `x` and `y`, i.e. `x - y` iff `x > y`,
  * otherwise zero.
  *
- * @param x
- * @param y
+ * @param x -
+ * @param y -
  */
 export const fdim = (x, y) => Math.max(x - y, 0);
 /**
  * Returns `x * y + z`.
  *
- * @param x
- * @param y
- * @param z
+ * @param x -
+ * @param y -
+ * @param z -
  */
 export const fma = (x, y, z) => x * y + z;
 /**
@@ -41,8 +41,8 @@ export const fma = (x, y, z) => x * y + z;
  *
  * Reference: https://www.cplusplus.com/reference/cmath/fmod/
  *
- * @param x
- * @param y
+ * @param x -
+ * @param y -
  */
 export const fmod = (x, y) => x % y;
 //export const fmod: FnN2 = (x, y) => x - y * Math.trunc(x / y);
@@ -59,7 +59,7 @@ export const fmod = (x, y) => x % y;
  * Based on:
  * https://github.com/locutusjs/locutus/blob/master/src/c/math/frexp.js
  *
- * @param x
+ * @param x -
  */
 export const frexp = (x) => {
     if (x === 0 || !isFinite(x))
@@ -80,8 +80,8 @@ export const frexp = (x) => {
 /**
  * Inverse op of {@link frexp}. Returns `x * 2^exp`
  *
- * @param x
- * @param exp
+ * @param x -
+ * @param exp -
  */
 export const ldexp = (x, exp) => x * 2 ** exp;
 /**
@@ -90,7 +90,20 @@ export const ldexp = (x, exp) => x * 2 ** exp;
  * @remarks
  * https://www.cplusplus.com/reference/cmath/remainder/
  *
- * @param x
- * @param y
+ * @param x -
+ * @param y -
  */
 export const remainder = (x, y) => x - y * Math.round(x / y);
+/**
+ * Computes both the quotient and remainder of the integer division of the
+ * numerator `x` by the denominator `y`.
+ *
+ * @param x -
+ * @param y -
+ */
+export const ldiv = (x, y) => {
+    x |= 0;
+    y |= 0;
+    const q = (x / y) | 0;
+    return [q, x - q * y];
+};

package/mix.d.ts

@@ -77,11 +77,11 @@ export declare const mixCubicHermite: FnN5;
  * spaced) and computes tangents automatically. Returns `b` iff `t=0` and `c`
  * iff `t=1.0`.
  *
- * @param a
- * @param b
- * @param c
- * @param d
- * @param t
+ * @param a -
+ * @param b -
+ * @param c -
+ * @param d -
+ * @param t -
  */
 export declare const mixCubicHermiteFromPoints: FnN5;
 /**
@@ -92,25 +92,24 @@ export declare const mixCubicHermiteFromPoints: FnN5;
  * Result will not be clamped and might fall outside the total range of the
  * input samples.
  *
- * @param s00
- * @param s01
- * @param s02
- * @param s03
- * @param s10
- * @param s11
- * @param s12
- * @param s13
- * @param s20
- * @param s21
- * @param s22
- * @param s23
- * @param s30
- * @param s31
- * @param s32
- * @param s33
- * @param u
- * @param v
- * @returns
+ * @param s00 -
+ * @param s01 -
+ * @param s02 -
+ * @param s03 -
+ * @param s10 -
+ * @param s11 -
+ * @param s12 -
+ * @param s13 -
+ * @param s20 -
+ * @param s21 -
+ * @param s22 -
+ * @param s23 -
+ * @param s30 -
+ * @param s31 -
+ * @param s32 -
+ * @param s33 -
+ * @param u -
+ * @param v -
  */
 export declare const mixBicubic: (s00: number, s01: number, s02: number, s03: number, s10: number, s11: number, s12: number, s13: number, s20: number, s21: number, s22: number, s23: number, s30: number, s31: number, s32: number, s33: number, u: number, v: number) => number;
 /**
@@ -235,8 +234,8 @@ export declare const cubicPulse: FnN3;
  * @remarks
  * https://en.wikipedia.org/wiki/Sinc_function
  *
- * @param k
- * @param t
+ * @param k -
+ * @param t -
  */
 export declare const sinc: FnN;
 /**
@@ -247,8 +246,8 @@ export declare const sinc: FnN;
  *
  * @see {@link sinc}
  *
- * @param k
- * @param t
+ * @param k -
+ * @param t -
  */
 export declare const sincNormalized: FnN2;
 /**
@@ -258,8 +257,8 @@ export declare const sincNormalized: FnN2;
  * @remarks
  * Interactive graph: https://www.desmos.com/calculator/pmypqgefle
  *
- * @param a
- * @param t
+ * @param a -
+ * @param t -
  */
 export declare const lanczos: FnN2;
 /**
@@ -306,9 +305,9 @@ export declare const schlick: FnN3;
  * `num` steps. I.e. multiplying `a` with the returned factor will yield
  * `b` after `num` steps. All args must be > 0.
  *
- * @param a
- * @param b
- * @param num
+ * @param a -
+ * @param b -
+ * @param num -
  */
 export declare const expFactor: FnN3;
 /**
@@ -317,9 +316,9 @@ export declare const expFactor: FnN3;
  * @remarks
  * Interactive graph: https://www.desmos.com/calculator/aq6hdzxprv
  *
- * @param bias
- * @param sigma
- * @param t
+ * @param bias -
+ * @param sigma -
+ * @param t -
  */
 export declare const gaussian: FnN3;
 //# sourceMappingURL=mix.d.ts.map

package/mix.js

@@ -102,11 +102,11 @@ export const mixCubicHermite = (a, ta, b, tb, t) => {
  * spaced) and computes tangents automatically. Returns `b` iff `t=0` and `c`
  * iff `t=1.0`.
  *
- * @param a
- * @param b
- * @param c
- * @param d
- * @param t
+ * @param a -
+ * @param b -
+ * @param c -
+ * @param d -
+ * @param t -
  */
 export const mixCubicHermiteFromPoints = (a, b, c, d, t) => {
     d *= 0.5;
@@ -125,25 +125,24 @@ export const mixCubicHermiteFromPoints = (a, b, c, d, t) => {
  * Result will not be clamped and might fall outside the total range of the
  * input samples.
  *
- * @param s00
- * @param s01
- * @param s02
- * @param s03
- * @param s10
- * @param s11
- * @param s12
- * @param s13
- * @param s20
- * @param s21
- * @param s22
- * @param s23
- * @param s30
- * @param s31
- * @param s32
- * @param s33
- * @param u
- * @param v
- * @returns
+ * @param s00 -
+ * @param s01 -
+ * @param s02 -
+ * @param s03 -
+ * @param s10 -
+ * @param s11 -
+ * @param s12 -
+ * @param s13 -
+ * @param s20 -
+ * @param s21 -
+ * @param s22 -
+ * @param s23 -
+ * @param s30 -
+ * @param s31 -
+ * @param s32 -
+ * @param s33 -
+ * @param u -
+ * @param v -
  */
 export const mixBicubic = (s00, s01, s02, s03, s10, s11, s12, s13, s20, s21, s22, s23, s30, s31, s32, s33, u, v) => mixCubicHermiteFromPoints(mixCubicHermiteFromPoints(s00, s01, s02, s03, u), mixCubicHermiteFromPoints(s10, s11, s12, s13, u), mixCubicHermiteFromPoints(s20, s21, s22, s23, u), mixCubicHermiteFromPoints(s30, s31, s32, s33, u), v);
 /**
@@ -285,8 +284,8 @@ export const cubicPulse = (w, c, t) => {
  * @remarks
  * https://en.wikipedia.org/wiki/Sinc_function
  *
- * @param k
- * @param t
+ * @param k -
+ * @param t -
  */
 export const sinc = (t) => (t !== 0 ? Math.sin(t) / t : 1);
 /**
@@ -297,8 +296,8 @@ export const sinc = (t) => (t !== 0 ? Math.sin(t) / t : 1);
  *
  * @see {@link sinc}
  *
- * @param k
- * @param t
+ * @param k -
+ * @param t -
  */
 export const sincNormalized = (k, t) => sinc(PI * k * t);
 /**
@@ -308,8 +307,8 @@ export const sincNormalized = (k, t) => sinc(PI * k * t);
  * @remarks
  * Interactive graph: https://www.desmos.com/calculator/pmypqgefle
  *
- * @param a
- * @param t
+ * @param a -
+ * @param t -
  */
 export const lanczos = (a, t) => t !== 0 ? (-a < t && t < a ? sinc(PI * t) * sinc((PI * t) / a) : 0) : 1;
 /**
@@ -358,9 +357,9 @@ export const schlick = (a, b, t) => t <= b
  * `num` steps. I.e. multiplying `a` with the returned factor will yield
  * `b` after `num` steps. All args must be > 0.
  *
- * @param a
- * @param b
- * @param num
+ * @param a -
+ * @param b -
+ * @param num -
  */
 export const expFactor = (a, b, num) => (b / a) ** (1 / num);
 /**
@@ -369,8 +368,8 @@ export const expFactor = (a, b, num) => (b / a) ** (1 / num);
  * @remarks
  * Interactive graph: https://www.desmos.com/calculator/aq6hdzxprv
  *
- * @param bias
- * @param sigma
- * @param t
+ * @param bias -
+ * @param sigma -
+ * @param t -
  */
 export const gaussian = (bias, sigma, t) => Math.exp(-((t - bias) ** 2) / (2 * sigma * sigma));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/math",
-  "version": "5.1.1",
+  "version": "5.3.0",
   "description": "Assorted common math functions & utilities",
   "type": "module",
   "module": "./index.js",
@@ -34,15 +34,15 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.3.1"
+    "@thi.ng/api": "^8.3.4"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.18.19",
-    "@thi.ng/testament": "^0.2.1",
+    "@microsoft/api-extractor": "^7.19.4",
+    "@thi.ng/testament": "^0.2.4",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
-    "typedoc": "^0.22.9",
-    "typescript": "^4.5.2"
+    "typedoc": "^0.22.13",
+    "typescript": "^4.6.2"
   },
   "keywords": [
     "animation",
@@ -52,6 +52,7 @@
     "interpolation",
     "interval",
     "math",
+    "prime",
     "quadratic",
     "smooth",
     "solver",
@@ -112,6 +113,9 @@
     "./prec": {
       "import": "./prec.js"
     },
+    "./prime": {
+      "import": "./prime.js"
+    },
     "./ratio": {
       "import": "./ratio.js"
     },
@@ -128,5 +132,5 @@
   "thi.ng": {
     "year": 2013
   },
-  "gitHead": "8bd27c8bde0b770e7c001943f11c951cd345d668\n"
+  "gitHead": "0fc692a3225c068aacafdc4cb6140cf603c67ad8\n"
 }

package/prime.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Returns iterator of all prime numbers ≤ given `x` using Sieve of
+ * Eratosthenes.
+ *
+ * @remarks
+ * Reference: https://en.wikipedia.org/wiki/Sieve_of_Eratosthenes
+ *
+ * @param x -
+ */
+export declare function primesUntil(x: number): Generator<number, void, unknown>;
+/**
+ * Returns largest prime number ≤ given `x` using Sieve of Eratosthenes. Returns
+ * -1 if x < 1.
+ *
+ * @remarks
+ * Reference: https://en.wikipedia.org/wiki/Sieve_of_Eratosthenes
+ *
+ * @param x -
+ */
+export declare const nearestPrime: (x: number) => number;
+//# sourceMappingURL=prime.d.ts.map

package/prime.js

@@ -0,0 +1,54 @@
+/**
+ * Returns iterator of all prime numbers ≤ given `x` using Sieve of
+ * Eratosthenes.
+ *
+ * @remarks
+ * Reference: https://en.wikipedia.org/wiki/Sieve_of_Eratosthenes
+ *
+ * @param x -
+ */
+export function* primesUntil(x) {
+    if (x < 1)
+        return;
+    yield 1;
+    const sieve = [];
+    const max = Math.sqrt(x) | 0;
+    for (let i = 2; i <= x; i++) {
+        if (!sieve[i]) {
+            yield i;
+            __updateSieve(sieve, i, x, max);
+        }
+    }
+}
+/**
+ * Returns largest prime number ≤ given `x` using Sieve of Eratosthenes. Returns
+ * -1 if x < 1.
+ *
+ * @remarks
+ * Reference: https://en.wikipedia.org/wiki/Sieve_of_Eratosthenes
+ *
+ * @param x -
+ */
+export const nearestPrime = (x) => {
+    if (x < 1)
+        return -1;
+    let prime = 1;
+    const sieve = [];
+    const max = Math.sqrt(x) | 0;
+    for (let i = 2; i <= x; i++) {
+        if (!sieve[i]) {
+            prime = i;
+            __updateSieve(sieve, i, x, max);
+        }
+    }
+    return prime;
+};
+/**
+ * @internal
+ */
+const __updateSieve = (sieve, i, x, max) => {
+    if (i <= max) {
+        for (let j = i * i; j <= x; j += i)
+            sieve[j] = true;
+    }
+};

package/safe-div.d.ts

@@ -2,8 +2,8 @@ import type { FnN2 } from "@thi.ng/api";
 /**
  * Returns `a` divided by `b` or zero if `b = 0`.
  *
- * @param a
- * @param b
+ * @param a -
+ * @param b -
  */
 export declare const safeDiv: FnN2;
 //# sourceMappingURL=safe-div.d.ts.map

package/safe-div.js

@@ -1,7 +1,7 @@
 /**
  * Returns `a` divided by `b` or zero if `b = 0`.
  *
- * @param a
- * @param b
+ * @param a -
+ * @param b -
  */
 export const safeDiv = (a, b) => (b !== 0 ? a / b : 0);