@thi.ng/random 4.0.4 → 4.1.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-09-19T21:09:34Z
+- **Last updated**: 2024-10-05T12:12:32Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,14 @@ 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.
 
+## [4.1.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/random@4.1.0) (2024-10-05)
+
+#### 🚀 Features
+
+- add WrappedRandom, refactor SYSTEM ([73c863f](https://github.com/thi-ng/umbrella/commit/73c863f))
+  - replace `SystemRandom` with `WrappedRandom` class
+  - refactor `SYSTEM`
+
 # [4.0.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/random@4.0.0) (2024-07-22)
 
 #### 🛑 Breaking changes

package/README.md

@@ -39,12 +39,13 @@ Pseudo-random number generators w/ unified API, distributions, weighted choices,
 
 This package provides the `IRandom` interface and various (mostly seedable)
 pseudo-random number generator implementations, incl. `IRandom` wrappers for
-`Math.random()` and `window.crypto`:
+`Math.random()` (or other external PRNGs) and `window.crypto`:
 
 - [Crypto](https://github.com/thi-ng/umbrella/tree/develop/packages/random/src/crypto.ts)
 - [SFC32](https://github.com/thi-ng/umbrella/tree/develop/packages/random/src/sfc32.ts)
 - [Smush32](https://github.com/thi-ng/umbrella/tree/develop/packages/random/src/smush32.ts)
 - [System](https://github.com/thi-ng/umbrella/tree/develop/packages/random/src/system.ts)
+- [WrappedRandom](https://github.com/thi-ng/umbrella/tree/develop/packages/random/src/wrapped.ts)
 - [Xoshiro128](https://github.com/thi-ng/umbrella/tree/develop/packages/random/src/xoshiro128.ts)
 - [XorShift128](https://github.com/thi-ng/umbrella/tree/develop/packages/random/src/xorshift128.ts)
 - [XorWow](https://github.com/thi-ng/umbrella/tree/develop/packages/random/src/xorwow.ts)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/random",
-  "version": "4.0.4",
+  "version": "4.1.0",
   "description": "Pseudo-random number generators w/ unified API, distributions, weighted choices, ID generation",
   "type": "module",
   "module": "./index.js",
@@ -36,12 +36,12 @@
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.11.10",
-    "@thi.ng/errors": "^2.5.16"
+    "@thi.ng/api": "^8.11.11",
+    "@thi.ng/errors": "^2.5.17"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.47.9",
-    "esbuild": "^0.23.1",
+    "esbuild": "^0.24.0",
     "typedoc": "^0.26.7",
     "typescript": "^5.6.2"
   },
@@ -134,6 +134,9 @@
     "./weighted-random": {
       "default": "./weighted-random.js"
     },
+    "./wrapped": {
+      "default": "./wrapped.js"
+    },
     "./xorshift128": {
       "default": "./xorshift128.js"
     },
@@ -154,5 +157,5 @@
       "ksuid"
     ]
   },
-  "gitHead": "b52baa3750ddd1256892df966ab7ac9b4806a9ef\n"
+  "gitHead": "11ae480076e61a2263f5730ffb37dfddbf01c7d1\n"
 }

package/system.d.ts

@@ -1,16 +1,7 @@
-import { ARandom } from "./arandom.js";
+import { WrappedRandom } from "./wrapped.js";
 /**
- * A `Math.random()` based {@link IRandom} implementation. Also @see
- * {@link SYSTEM}.
+ * {@link IRandom} wrapper for `Math.random()`. Used as default PRNG throughout
+ * most other thi.ng projects, though usually is configurable.
  */
-export declare class SystemRandom extends ARandom {
-    int(): number;
-    float(norm?: number): number;
-    norm(norm?: number): number;
-}
-/**
- * Used as default PRNG throughout most other thi.ng projects, though usually is
- * configurable.
- */
-export declare const SYSTEM: SystemRandom;
+export declare const SYSTEM: WrappedRandom;
 //# sourceMappingURL=system.d.ts.map

package/system.js

@@ -1,18 +1,5 @@
-import { ARandom } from "./arandom.js";
-const random = Math.random;
-class SystemRandom extends ARandom {
-  int() {
-    return random() * 4294967296 >>> 0;
-  }
-  float(norm = 1) {
-    return random() * norm;
-  }
-  norm(norm = 1) {
-    return (random() - 0.5) * 2 * norm;
-  }
-}
-const SYSTEM = new SystemRandom();
+import { WrappedRandom } from "./wrapped.js";
+const SYSTEM = new WrappedRandom(Math.random);
 export {
-  SYSTEM,
-  SystemRandom
+  SYSTEM
 };

package/wrapped.d.ts

@@ -0,0 +1,14 @@
+import type { Fn0 } from "@thi.ng/api";
+import { ARandom } from "./arandom.js";
+/**
+ * {@link IRandom} implementation for external `Math.random()` compatible PRNG
+ * functions. Also see {@link SYSTEM}.
+ */
+export declare class WrappedRandom extends ARandom {
+    protected rnd: Fn0<number>;
+    constructor(rnd: Fn0<number>);
+    float(norm?: number): number;
+    norm(norm?: number): number;
+    int(): number;
+}
+//# sourceMappingURL=wrapped.d.ts.map

package/wrapped.js

@@ -0,0 +1,19 @@
+import { ARandom } from "./arandom.js";
+class WrappedRandom extends ARandom {
+  constructor(rnd) {
+    super();
+    this.rnd = rnd;
+  }
+  float(norm = 1) {
+    return this.rnd() * norm;
+  }
+  norm(norm = 1) {
+    return (this.rnd() - 0.5) * 2 * norm;
+  }
+  int() {
+    return this.rnd() * 4294967296 >>> 0;
+  }
+}
+export {
+  WrappedRandom
+};