@thi.ng/random 4.1.9 → 4.1.11

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2025-01-23T13:39:11Z
+- **Last updated**: 2025-02-13T16:03:11Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/README.md

@@ -7,7 +7,7 @@
 [![Mastodon Follow](https://img.shields.io/mastodon/follow/109331703950160316?domain=https%3A%2F%2Fmastodon.thi.ng&style=social)](https://mastodon.thi.ng/@toxi)
 
 > [!NOTE]
-> This is one of 200 standalone projects, maintained as part
+> This is one of 201 standalone projects, maintained as part
 > of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo
 > and anti-framework.
 >

package/api.d.ts

@@ -27,14 +27,14 @@ export interface INorm {
 }
 export interface IRandom extends INorm {
     /**
-     * Returns unsigned 32bit int in [0..0xffffffff] interval.
+     * 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.
+     * Returns float in `[0,max)` interval.
      *
      * @remarks
      * See: https://github.com/thi-ng/umbrella/wiki/Glossary#interval
@@ -43,14 +43,14 @@ export interface IRandom extends INorm {
      */
     float(max?: number): number;
     /**
-     *  Calls {@link IRandom.float} and returns true iff result is < `p`
-     *  (assumed to be in [0..1] interval).
+     * 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.
+     * Returns float in `[min,max)` interval.
      *
      * @remarks
      * See: https://github.com/thi-ng/umbrella/wiki/Glossary#interval
@@ -60,7 +60,7 @@ export interface IRandom extends INorm {
      */
     minmax(min: number, max: number): number;
     /**
-     * Returns int in **signed** integer [min..max) interval.
+     * Returns int in **signed** integer `[min,max)` interval.
      *
      * @remarks
      * See: https://github.com/thi-ng/umbrella/wiki/Glossary#interval
@@ -70,7 +70,7 @@ export interface IRandom extends INorm {
      */
     minmaxInt(min: number, max: number): number;
     /**
-     * Returns int in **unsigned** integer [min..max) interval.
+     * Returns int in **unsigned** integer `[min,max)` interval.
      *
      * @remarks
      * See: https://github.com/thi-ng/umbrella/wiki/Glossary#interval

package/distributions/gaussian.d.ts

@@ -5,7 +5,7 @@ import type { IRandom } from "../api.js";
  * (Central Limit Theorem).
  *
  * @remarks
- * The default configuration produces samples in the approx. [-0.5,0.5] range
+ * The default configuration produces samples in the approx. `[-0.5,0.5]` range
  * with a ~12% standard deviation.
  *
  * Reference: https://en.wikipedia.org/wiki/Central_limit_theorem

package/distributions/geometric.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/random",
-  "version": "4.1.9",
+  "version": "4.1.11",
   "description": "Pseudo-random number generators w/ unified API, distributions, weighted choices, ID generation",
   "type": "module",
   "module": "./index.js",
@@ -33,19 +33,18 @@
     "build:esbuild": "esbuild --format=esm --platform=neutral --target=es2022 --tsconfig=tsconfig.json --outdir=. src/**/*.ts",
     "clean": "bun ../../tools/src/clean-package.ts distributions",
     "doc": "typedoc --options ../../typedoc.json --out doc src/index.ts",
-    "doc:ae": "mkdir -p .ae/doc .ae/temp && api-extractor run --local --verbose",
     "doc:readme": "bun ../../tools/src/module-stats.ts && bun ../../tools/src/readme.ts",
     "pub": "yarn npm publish --access public",
     "test": "bun test",
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.11.18",
-    "@thi.ng/errors": "^2.5.24"
+    "@thi.ng/api": "^8.11.20",
+    "@thi.ng/errors": "^2.5.26"
   },
   "devDependencies": {
-    "esbuild": "^0.24.2",
-    "typedoc": "^0.27.6",
+    "esbuild": "^0.25.0",
+    "typedoc": "^0.27.7",
     "typescript": "^5.7.3"
   },
   "keywords": [
@@ -160,5 +159,5 @@
       "ksuid"
     ]
   },
-  "gitHead": "b92b48abda9941d608be8a2e1c83447e679a6f79\n"
+  "gitHead": "9a0b33253fef092aaf301decf6ecd54317874d4c\n"
 }

package/sfc32.d.ts

@@ -5,8 +5,8 @@ import { ARandom } from "./arandom.js";
  * Simple Fast Counter PRNG (32bit version)
  *
  * @remarks
- * References:
- * - http://pracrand.sourceforge.net/
+ * Reference:
+ * http://pracrand.sourceforge.net/
  */
 export declare class SFC32 extends ARandom implements IBuffered<Uint32Array>, ICopy<SFC32>, ISeedable<ArrayLike<number>> {
     buffer: Uint32Array;

package/smush32.d.ts

@@ -4,7 +4,7 @@ import { ARandom } from "./arandom.js";
 /**
  * @remarks
  * References:
- * -
+ *
  * - https://github.com/thi-ng/ct-head/blob/master/random.h
  * - https://gist.github.com/voidqk/d112165a26b45244a65298933c0349a4
  */

package/weighted-probability.d.ts

@@ -2,8 +2,8 @@ import type { FnN } from "@thi.ng/api";
 import type { IRandom } from "./api.js";
 /**
  * Takes a `weight` function and optional {@link IRandom} instance (default:
- * {@link SYSTEM}). The weight function accepts a number in [0,1) interval and
- * returns a number in [0,1]. Draws two random numbers `a` and `b` via
+ * {@link SYSTEM}). The weight function accepts a number in `[0,1)` interval and
+ * returns a number in `[0,1]`. Draws two random numbers `a` and `b` via
  * {@link IRandom.float} and returns a tuple of `[a, b < weight(a)]`.
  *
  * @example

package/xoshiro128.d.ts

@@ -4,6 +4,7 @@ import { ARandom } from "./arandom.js";
 /**
  * @remarks
  * References:
+ *
  * - http://prng.di.unimi.it/
  * - http://prng.di.unimi.it/xoshiro128plusplus.c
  */