@thi.ng/random 3.3.29 → 3.4.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2023-04-08T11:09:50Z
+- **Last updated**: 2023-04-19T09:28:07Z
 - **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.4.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/random@3.4.0) (2023-04-19)
+
+#### 🚀 Features
+
+- add INorm.normMinMax(), update ARandom ([89c6b76](https://github.com/thi-ng/umbrella/commit/89c6b76))
+
 ## [3.3.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/random@3.3.0) (2022-05-22)
 
 #### 🚀 Features

package/README.md

@@ -93,7 +93,7 @@ For Node.js REPL:
 const random = await import("@thi.ng/random");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 1.83 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 1.85 KB
 
 ## Dependencies
 

package/api.d.ts

@@ -1,30 +1,53 @@
 import type { ICopy } from "@thi.ng/api";
 export interface INorm {
     /**
-     * Returns float in [-scale..scale) interval.
+     * Returns float in `[-scale..scale)` interval.
      *
      * @remarks
      * Not to be confused with the {@link normal} distribution function. The
      * name here refers to "normalized".
      *
+     * Also see: https://github.com/thi-ng/umbrella/wiki/Glossary#interval
+     *
      * @param scale - default 1
      */
     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
+     * the `(-min..min)` range). Both `min` and `max` MUST be >= 0.
+     *
+     * @remarks
+     * See: https://github.com/thi-ng/umbrella/wiki/Glossary#interval
+     *
+     * @param min
+     * @param max
+     */
+    normMinMax(min: number, max: number): number;
 }
 export interface IRandom extends INorm {
     /**
-     * Returns unsigned 32bit int [0..0xffffffff]
+     * Returns unsigned 32bit int in [0..0xffffffff] interval.
+     *
+     * @remarks
+     * See: https://github.com/thi-ng/umbrella/wiki/Glossary#interval
      */
     int(): number;
     /**
      * Returns float in [0..max) interval.
      *
+     * @remarks
+     * See: https://github.com/thi-ng/umbrella/wiki/Glossary#interval
+     *
      * @param max - default 1
      */
     float(max?: number): number;
     /**
      * Returns float in [min..max) interval.
      *
+     * @remarks
+     * See: https://github.com/thi-ng/umbrella/wiki/Glossary#interval
+     *
      * @param min -
      * @param max -
      */
@@ -32,12 +55,20 @@ export interface IRandom extends INorm {
     /**
      * Returns int in [min..max) interval.
      *
+     * @remarks
+     * See: https://github.com/thi-ng/umbrella/wiki/Glossary#interval
+     *
      * @param min -
      * @param max -
      */
     minmaxInt(min: number, max: number): number;
 }
 export interface ISeedable<T> {
+    /**
+     * (Re)seeds this PRNG instance with given value(s).
+     *
+     * @param n
+     */
     seed(n: T): this;
 }
 export type ISeedableRandom<T> = IRandom & ISeedable<T> & ICopy<IRandom>;

package/arandom.d.ts

@@ -3,6 +3,7 @@ export declare abstract class ARandom implements IRandom {
     abstract int(): number;
     float(norm?: number): number;
     norm(norm?: number): number;
+    normMinMax(min: number, max: number): number;
     minmax(min: number, max: number): number;
     minmaxInt(min: number, max: number): number;
 }

package/arandom.js

@@ -6,6 +6,10 @@ export class ARandom {
     norm(norm = 1) {
         return (this.int() * INV_MAX - 0.5) * 2 * norm;
     }
+    normMinMax(min, max) {
+        const x = this.minmax(min, max);
+        return this.float() < 0.5 ? x : -x;
+    }
     minmax(min, max) {
         return this.float() * (max - min) + min;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/random",
-  "version": "3.3.29",
+  "version": "3.4.0",
   "description": "Pseudo-random number generators w/ unified API, distributions, weighted choices, ID generation",
   "type": "module",
   "module": "./index.js",
@@ -34,7 +34,7 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.7.6",
+    "@thi.ng/api": "^8.8.0",
     "@thi.ng/checks": "^3.3.12",
     "@thi.ng/errors": "^2.2.15",
     "@thi.ng/hex": "^2.3.9"
@@ -156,5 +156,5 @@
       "ksuid"
     ]
   },
-  "gitHead": "abcedd9e4e06a4b631f363610eec572f79b571c1\n"
+  "gitHead": "3a56bc490f1e68754762a503d06327b5b34ff7eb\n"
 }