@thi.ng/random 3.5.2 → 3.6.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2023-08-10T12:16:43Z
+- **Last updated**: 2023-08-12T13:14:08Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,23 @@ 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.6.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/random@3.6.0) (2023-08-12)
+
+#### 🚀 Features
+
+- add IRandom.minmaxUint() ([6558eb1](https://github.com/thi-ng/umbrella/commit/6558eb1))
+  - clarify .minmaxInt() is for signed (i32)
+  - new .minmaxUint() is for unsigned (u32)
+  - add ARandom.minmaxUint()
+- add IRandom.probability() ([efdd49c](https://github.com/thi-ng/umbrella/commit/efdd49c))
+  - add impl for ARandom base class
+
+#### ⏱ Performance improvements
+
+- increase Crypto default size to 1KB ([a30075a](https://github.com/thi-ng/umbrella/commit/a30075a))
+- minor update randomBytesFrom() ([770dbe5](https://github.com/thi-ng/umbrella/commit/770dbe5))
+  - switch loop direction
+
 ## [3.5.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/random@3.5.0) (2023-07-14)
 
 #### 🚀 Features

package/api.d.ts

@@ -14,7 +14,7 @@ export interface INorm {
     norm(scale?: number): number;
     /**
      * Similar to {@link INorm.norm}, but returns values in either the
-     * `[min..max)` or in the `(-max...min]` interval (i.e. excluding values in
+     * `[min..max)` or in the `(-max...-min]` interval (i.e. excluding values in
      * the `(-min..min)` range). Both `min` and `max` MUST be >= 0.
      *
      * @remarks
@@ -42,6 +42,13 @@ export interface IRandom extends INorm {
      * @param max - default 1
      */
     float(max?: number): number;
+    /**
+     *  Calls {@link IRandom.float} and returns true iff result is < `p`
+     *  (assumed to be in [0..1] interval).
+     *
+     * @param p
+     */
+    probability(p: number): boolean;
     /**
      * Returns float in [min..max) interval.
      *
@@ -53,7 +60,7 @@ export interface IRandom extends INorm {
      */
     minmax(min: number, max: number): number;
     /**
-     * Returns int in [min..max) interval.
+     * Returns int in **signed** integer [min..max) interval.
      *
      * @remarks
      * See: https://github.com/thi-ng/umbrella/wiki/Glossary#interval
@@ -62,6 +69,16 @@ export interface IRandom extends INorm {
      * @param max -
      */
     minmaxInt(min: number, max: number): number;
+    /**
+     * Returns int in **unsigned** integer [min..max) interval.
+     *
+     * @remarks
+     * See: https://github.com/thi-ng/umbrella/wiki/Glossary#interval
+     *
+     * @param min -
+     * @param max -
+     */
+    minmaxUint(min: number, max: number): number;
 }
 export interface ISeedable<T> {
     /**

package/arandom.d.ts

@@ -2,9 +2,11 @@ import type { IRandom } from "./api.js";
 export declare abstract class ARandom implements IRandom {
     abstract int(): number;
     float(norm?: number): number;
+    probability(p: number): boolean;
     norm(norm?: number): number;
     normMinMax(min: number, max: number): number;
     minmax(min: number, max: number): number;
     minmaxInt(min: number, max: number): number;
+    minmaxUint(min: number, max: number): number;
 }
 //# sourceMappingURL=arandom.d.ts.map

package/arandom.js

@@ -3,6 +3,9 @@ export class ARandom {
     float(norm = 1) {
         return this.int() * INV_MAX * norm;
     }
+    probability(p) {
+        return this.float() < p;
+    }
     norm(norm = 1) {
         return (this.int() * INV_MAX - 0.5) * 2 * norm;
     }
@@ -15,7 +18,10 @@ export class ARandom {
     }
     minmaxInt(min, max) {
         min |= 0;
-        max |= 0;
-        return min + ((this.float() * (max - min)) | 0);
+        return min + (this.int() % ((max | 0) - min));
+    }
+    minmaxUint(min, max) {
+        min >>>= 0;
+        return min + (this.int() % ((max >>> 0) - min));
     }
 }

package/coin.d.ts

@@ -4,7 +4,7 @@ import type { IRandom } from "./api.js";
  * quality of given {@link IRandom}) PRNG.
  *
  * @remarks
- * Also see {@link fairCoin}.
+ * Also see {@link fairCoin} and {@link IRandom.probability}.
  *
  * @param rnd -
  */

package/coin.js

@@ -4,7 +4,7 @@ import { SYSTEM } from "./system.js";
  * quality of given {@link IRandom}) PRNG.
  *
  * @remarks
- * Also see {@link fairCoin}.
+ * Also see {@link fairCoin} and {@link IRandom.probability}.
  *
  * @param rnd -
  */

package/crypto.js

@@ -14,7 +14,7 @@ export class Crypto extends ARandom {
     /**
      * @param size - buffer size in bytes (will be rounded to next multiple of 4)
      */
-    constructor(size = 64) {
+    constructor(size = 1024) {
         super();
         this.buffer = new Uint8Array((size + 3) & ~3);
         this.u32 = new Uint32Array(this.buffer.buffer);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/random",
-  "version": "3.5.2",
+  "version": "3.6.0",
   "description": "Pseudo-random number generators w/ unified API, distributions, weighted choices, ID generation",
   "type": "module",
   "module": "./index.js",
@@ -34,14 +34,14 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.9.1",
-    "@thi.ng/checks": "^3.4.1",
-    "@thi.ng/errors": "^2.3.1",
-    "@thi.ng/hex": "^2.3.13"
+    "@thi.ng/api": "^8.9.3",
+    "@thi.ng/checks": "^3.4.3",
+    "@thi.ng/errors": "^2.3.3",
+    "@thi.ng/hex": "^2.3.15"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.36.3",
-    "@thi.ng/testament": "^0.3.19",
+    "@microsoft/api-extractor": "^7.36.4",
+    "@thi.ng/testament": "^0.3.21",
     "rimraf": "^5.0.1",
     "tools": "^0.0.1",
     "typedoc": "^0.24.8",
@@ -156,5 +156,5 @@
       "ksuid"
     ]
   },
-  "gitHead": "672fb5ede530598da51c9d1cee48fe58c23bad34\n"
+  "gitHead": "399f8c53d66b9b763d16c21bb59f145df5f59514\n"
 }

package/random-bytes.js

@@ -10,7 +10,7 @@ import { SYSTEM } from "./system.js";
  * @param end -
  */
 export const randomBytesFrom = (rnd, buf, start = 0, end = buf.length) => {
-    for (let i = end; --i >= start;) {
+    for (let i = start; i < end; i++) {
         buf[i] = rnd.int() & 0xff;
     }
     return buf;