@thi.ng/random 3.2.1 → 3.2.4

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,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.
 
+### [3.2.2](https://github.com/thi-ng/umbrella/tree/@thi.ng/random@3.2.2) (2021-11-21)
+
+#### 🩹 Bug fixes
+
+- off-by-one error in ARandom ([0bf9828](https://github.com/thi-ng/umbrella/commit/0bf9828))
+
 ## [3.2.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/random@3.2.0) (2021-11-17)
 
 #### 🚀 Features

package/README.md

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

package/api.d.ts

@@ -13,7 +13,7 @@ export interface INorm {
 }
 export interface IRandom extends INorm {
     /**
-     * Returns unsigned 32bit int
+     * Returns unsigned 32bit int [0..0xffffffff]
      */
     int(): number;
     /**

package/arandom.js

@@ -1,4 +1,4 @@
-const INV_MAX = 1 / 0xffffffff;
+const INV_MAX = 1 / (2 ** 32);
 export class ARandom {
     float(norm = 1) {
         return this.int() * INV_MAX * norm;

package/coin.d.ts

@@ -6,7 +6,7 @@ import type { IRandom } from "./api.js";
  * @remarks
  * Also see {@link fairCoin}.
  *
- * @param rnd
+ * @param rnd -
  */
 export declare const coin: (rnd?: IRandom) => boolean;
 /**
@@ -18,7 +18,7 @@ export declare const coin: (rnd?: IRandom) => boolean;
  * Reference:
  * https://en.m.wikipedia.org/wiki/Fair_coin#Fair_results_from_a_biased_coin
  *
- * @param rnd
+ * @param rnd -
  */
 export declare const fairCoin: (rnd?: IRandom) => boolean;
 //# sourceMappingURL=coin.d.ts.map

package/coin.js

@@ -6,7 +6,7 @@ import { SYSTEM } from "./system.js";
  * @remarks
  * Also see {@link fairCoin}.
  *
- * @param rnd
+ * @param rnd -
  */
 export const coin = (rnd = SYSTEM) => rnd.float() < 0.5;
 /**
@@ -18,7 +18,7 @@ export const coin = (rnd = SYSTEM) => rnd.float() < 0.5;
  * Reference:
  * https://en.m.wikipedia.org/wiki/Fair_coin#Fair_results_from_a_biased_coin
  *
- * @param rnd
+ * @param rnd -
  */
 export const fairCoin = (rnd = SYSTEM) => {
     let a, b;

package/distributions/exponential.d.ts

@@ -6,7 +6,7 @@ import type { IRandom } from "../api.js";
  * @remarks
  * https://en.wikipedia.org/wiki/Exponential_distribution
  *
- * @param rnd
+ * @param rnd -
  * @param lambda - event interval [0,Inf)
  */
 export declare const exponential: (rnd?: IRandom, lambda?: number) => () => number;

package/distributions/exponential.js

@@ -6,7 +6,7 @@ import { SYSTEM } from "../system.js";
  * @remarks
  * https://en.wikipedia.org/wiki/Exponential_distribution
  *
- * @param rnd
+ * @param rnd -
  * @param lambda - event interval [0,Inf)
  */
 export const exponential = (rnd = SYSTEM, lambda = 10) => lambda === 0 ? () => Infinity : () => -Math.log(1 - rnd.float(1)) / lambda;

package/distributions/geometric.d.ts

@@ -9,7 +9,7 @@ import type { IRandom } from "../api.js";
  *
  * Reference: https://en.wikipedia.org/wiki/Geometric_distribution
  *
- * @param rnd
+ * @param rnd -
  * @param p - probability (0,1]
  */
 export declare const geometric: (rnd?: IRandom, p?: number) => () => number;

package/distributions/geometric.js

@@ -9,7 +9,7 @@ import { SYSTEM } from "../system.js";
  *
  * Reference: https://en.wikipedia.org/wiki/Geometric_distribution
  *
- * @param rnd
+ * @param rnd -
  * @param p - probability (0,1]
  */
 export const geometric = (rnd = SYSTEM, p = 0.5) => p <= 0

package/distributions/normal.d.ts

@@ -6,9 +6,9 @@ import type { IRandom } from "../api.js";
  * @remarks
  * Also see {@link gaussian} for alternative implementation.
  *
- * @param rnd
- * @param bias
- * @param sigma
+ * @param rnd -
+ * @param bias -
+ * @param sigma -
  */
 export declare const normal: (rnd?: IRandom, bias?: number, sigma?: number) => () => number;
 //# sourceMappingURL=normal.d.ts.map

package/distributions/normal.js

@@ -6,9 +6,9 @@ import { SYSTEM } from "../system.js";
  * @remarks
  * Also see {@link gaussian} for alternative implementation.
  *
- * @param rnd
- * @param bias
- * @param sigma
+ * @param rnd -
+ * @param bias -
+ * @param sigma -
  */
 export const normal = (rnd = SYSTEM, bias = 0, sigma = 1) => {
     let a;

package/distributions/uniform.d.ts

@@ -6,9 +6,9 @@ import type { IRandom } from "../api.js";
  * @remarks
  * This function is syntax sugar for `rnd.minmax()`.
  *
- * @param rnd
- * @param min
- * @param max
+ * @param rnd -
+ * @param min -
+ * @param max -
  */
 export declare const uniform: (rnd?: IRandom, min?: number, max?: number) => () => number;
 //# sourceMappingURL=uniform.d.ts.map

package/distributions/uniform.js

@@ -6,8 +6,8 @@ import { SYSTEM } from "../system.js";
  * @remarks
  * This function is syntax sugar for `rnd.minmax()`.
  *
- * @param rnd
- * @param min
- * @param max
+ * @param rnd -
+ * @param min -
+ * @param max -
  */
 export const uniform = (rnd = SYSTEM, min = 0, max = 1) => () => rnd.minmax(min, max);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/random",
-  "version": "3.2.1",
+  "version": "3.2.4",
   "description": "Pseudo-random number generators w/ unified API, distributions, weighted choices, ID generation",
   "type": "module",
   "module": "./index.js",
@@ -34,18 +34,18 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.3.1",
-    "@thi.ng/checks": "^3.1.1",
-    "@thi.ng/errors": "^2.1.1",
-    "@thi.ng/hex": "^2.1.1"
+    "@thi.ng/api": "^8.3.4",
+    "@thi.ng/checks": "^3.1.4",
+    "@thi.ng/errors": "^2.1.4",
+    "@thi.ng/hex": "^2.1.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": [
     "binary",
@@ -153,5 +153,5 @@
       "ksuid"
     ]
   },
-  "gitHead": "8bd27c8bde0b770e7c001943f11c951cd345d668\n"
+  "gitHead": "0fc692a3225c068aacafdc4cb6140cf603c67ad8\n"
 }

package/pick-random.d.ts

@@ -3,10 +3,10 @@
  * (default: {@link SYSTEM}). The index selection will be constrained to the
  * `[start,end)` interval (default: entire array).
  *
- * @param src
- * @param rnd
- * @param start
- * @param end
+ * @param src -
+ * @param rnd -
+ * @param start -
+ * @param end -
  */
 export declare const pickRandom: <T>(src: ArrayLike<T>, rnd?: import("./system.js").SystemRandom, start?: number, end?: number) => T;
 //# sourceMappingURL=pick-random.d.ts.map

package/pick-random.js

@@ -4,9 +4,9 @@ import { SYSTEM } from "./system.js";
  * (default: {@link SYSTEM}). The index selection will be constrained to the
  * `[start,end)` interval (default: entire array).
  *
- * @param src
- * @param rnd
- * @param start
- * @param end
+ * @param src -
+ * @param rnd -
+ * @param start -
+ * @param end -
  */
 export const pickRandom = (src, rnd = SYSTEM, start = 0, end = src.length) => src[rnd.minmax(start, end) | 0];

package/unique-indices.d.ts

@@ -6,10 +6,10 @@ import type { IRandom } from "./api.js";
  * samples (or creates a new one). Returns the array. Gives up after
  * `maxTrials`.
  *
- * @param k
- * @param fn
- * @param existing
- * @param maxTrials
+ * @param k -
+ * @param fn -
+ * @param existing -
+ * @param maxTrials -
  */
 export declare const uniqueValuesFrom: (k: number, fn: Fn0<number>, existing?: number[], maxTrials?: number) => number[];
 /**
@@ -22,11 +22,11 @@ export declare const uniqueValuesFrom: (k: number, fn: Fn0<number>, existing?: n
  * Candidates are drawn from the provided `rnd` {@link IRandom} (default:
  * {@link SYSTEM}) and only `maxTrials` are attempted before giving up.
  *
- * @param k
- * @param max
- * @param existing
- * @param maxTrials
- * @param rnd
+ * @param k -
+ * @param max -
+ * @param existing -
+ * @param maxTrials -
+ * @param rnd -
  */
 export declare const uniqueIndices: (k: number, max: number, existing?: number[] | undefined, maxTrials?: number, rnd?: IRandom) => number[];
 //# sourceMappingURL=unique-indices.d.ts.map

package/unique-indices.js

@@ -6,10 +6,10 @@ import { SYSTEM } from "./system.js";
  * samples (or creates a new one). Returns the array. Gives up after
  * `maxTrials`.
  *
- * @param k
- * @param fn
- * @param existing
- * @param maxTrials
+ * @param k -
+ * @param fn -
+ * @param existing -
+ * @param maxTrials -
  */
 export const uniqueValuesFrom = (k, fn, existing = [], maxTrials = 100) => {
     let n = 0;
@@ -36,11 +36,11 @@ export const uniqueValuesFrom = (k, fn, existing = [], maxTrials = 100) => {
  * Candidates are drawn from the provided `rnd` {@link IRandom} (default:
  * {@link SYSTEM}) and only `maxTrials` are attempted before giving up.
  *
- * @param k
- * @param max
- * @param existing
- * @param maxTrials
- * @param rnd
+ * @param k -
+ * @param max -
+ * @param existing -
+ * @param maxTrials -
+ * @param rnd -
  */
 export const uniqueIndices = (k, max, existing, maxTrials = max, rnd = SYSTEM) => {
     assert(k >= 0 && k <= max, `k must be in [0, ${max}] interval`);