pick-me-too 1.2.1 → 1.3.0

package/CHANGELOG.md

@@ -1,5 +1,7 @@
 # Changelog
 
+## v1.3.0 *2022-7-23*
+- made `rando` reseedable
 ## v1.2.1 *2022-4-30*
 - fixed typo in README
 ## v1.2.0 *2022-4-17*

package/README.md

@@ -194,6 +194,10 @@ const rng = rando(1)
 const ar: number[] = []
 for (let i = 0; i < 3; i++) ar.push(rng())
 // => [ 0.6270739405881613, 0.002735721180215478, 0.5274470399599522 ]
+
+// reseed the generator
+(rng as any)(Math.random())
+// => ??? the random number sequence is still deterministic, but at a completely different place
 ```
 
 ## Acknowledgements

package/lib/index.d.ts

@@ -82,6 +82,10 @@ export declare type Rng = () => number;
  * The implementation of `rando` is taken from https://stackoverflow.com/a/47593316/15060051.
  * It is the Mulberry32 algorithm.
  *
+ * Note, `rando` can be re-seeded by passing an optional number argument as the fresh seed (see
+ * example below). This can be useful if you are sharing a random number generator among
+ * several objects and you need to change random number sequences.
+ *
  * @example
  * ```ts
  * import { rando } from 'pick-me'
@@ -91,6 +95,16 @@ export declare type Rng = () => number;
  * const ar: number[] = []
  * for (let i = 0; i < 3; i++) ar.push(rng())
  * // => [ 0.6270739405881613, 0.002735721180215478, 0.5274470399599522 ]
+ *
+ * // the same seed will produce the same random number sequence
+ * rando(1)()
+ * // => 0.6270739405881613
+ * rando(1)()
+ * // => 0.6270739405881613
+ *
+ * // but you can provide a fresh seed to change the sequence
+ * (rando(1) as any)(2)
+ * // => 0.7342509443406016
  * ```
  *
  * @param {number} seed - the seed for a random number sequence

package/lib/index.js

@@ -47,7 +47,8 @@ exports.rando = exports.pickMeToo = exports.pickMe = void 0;
  * @returns {() => T} a picker of T's
  */
 function pickMe(frequencies, rando) {
-    return pickMeToo(frequencies)(rando !== null && rando !== void 0 ? rando : (() => Math.random()));
+    const rng = rando !== null && rando !== void 0 ? rando : (() => Math.random());
+    return pickMeToo(frequencies)(rng);
 }
 exports.pickMe = pickMe;
 /**
@@ -163,6 +164,10 @@ function portion(thresholds, start, end) {
  * The implementation of `rando` is taken from https://stackoverflow.com/a/47593316/15060051.
  * It is the Mulberry32 algorithm.
  *
+ * Note, `rando` can be re-seeded by passing an optional number argument as the fresh seed (see
+ * example below). This can be useful if you are sharing a random number generator among
+ * several objects and you need to change random number sequences.
+ *
  * @example
  * ```ts
  * import { rando } from 'pick-me'
@@ -172,13 +177,25 @@ function portion(thresholds, start, end) {
  * const ar: number[] = []
  * for (let i = 0; i < 3; i++) ar.push(rng())
  * // => [ 0.6270739405881613, 0.002735721180215478, 0.5274470399599522 ]
+ *
+ * // the same seed will produce the same random number sequence
+ * rando(1)()
+ * // => 0.6270739405881613
+ * rando(1)()
+ * // => 0.6270739405881613
+ *
+ * // but you can provide a fresh seed to change the sequence
+ * (rando(1) as any)(2)
+ * // => 0.7342509443406016
  * ```
  *
  * @param {number} seed - the seed for a random number sequence
  * @returns {Rng} a generator of random numbers
  */
 function rando(seed) {
-    return () => {
+    return (reseed) => {
+        if (reseed !== undefined)
+            seed = reseed;
         let t = (seed += 0x6d2b79f5);
         t = Math.imul(t ^ (t >>> 15), t | 1);
         t ^= t + Math.imul(t ^ (t >>> 7), t | 61);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pick-me-too",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "description": "Generate a function that returns random items from a list with specified frequencies.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

package/src/__tests__/documentation.test.ts

@@ -87,7 +87,7 @@ describe('README', () => {
       rng,
     )
     const clause = () => {
-      let s = []
+      let s: string[] = []
       for (let i = 0, lim = clauseLength(); i < lim; i++) s.push(word())
       return s.join(' ')
     }
@@ -127,5 +127,7 @@ describe('index.ts', () => {
     test('rando', () => {
       expect(ar).toEqual([0.6270739405881613, 0.002735721180215478, 0.5274470399599522])
     })
+    test('rando(1)()', () => expect(rando(1)()).toEqual(0.6270739405881613))
+    test('(rando(1) as any)(2)', () => expect((rando(1) as any)(2)).toEqual(0.7342509443406016))
   })
 })

package/src/__tests__/functionality.test.ts

@@ -16,6 +16,19 @@ describe('rando', () => {
   for (let i = 0; i < bins.length; i++) {
     test('even distribution', () => expect(Math.round(bins[i] / 1000)).toEqual(1))
   }
+  for (let i = 0; i < 10; i++) {
+    const seed = Math.random()
+    const rng1 = rando(seed),
+      rng2 = rando(seed)
+    const ar1: number[] = [],
+      ar2: number[] = []
+    for (let j = 0; j < 10; j++) {
+      ar1.push(rng1())
+      ar2.push(rng2())
+    }
+    test(`two randos with seed ${seed} produce the same sequence of random values`, () => expect(ar1).toEqual(ar2))
+    test(`randos can be reseeded`, () => expect(rng1()).not.toEqual((rng2 as any)(Math.random())))
+  }
 })
 
 describe('pickMe', () => {

package/src/index.ts

@@ -44,7 +44,8 @@
  * @returns {() => T} a picker of T's
  */
 export function pickMe<T>(frequencies: [T, number][] | T[], rando?: Rng): () => T {
-  return pickMeToo(frequencies)(rando ?? (() => Math.random()))
+  const rng = rando ?? (() => Math.random())
+  return pickMeToo(frequencies)(rng)
 }
 
 /**
@@ -171,6 +172,10 @@ function portion(thresholds: number[], start: number, end: number): string {
  *
  * The implementation of `rando` is taken from https://stackoverflow.com/a/47593316/15060051.
  * It is the Mulberry32 algorithm.
+ * 
+ * Note, `rando` can be re-seeded by passing an optional number argument as the fresh seed (see
+ * example below). This can be useful if you are sharing a random number generator among
+ * several objects and you need to change random number sequences.
  *
  * @example
  * ```ts
@@ -181,13 +186,24 @@ function portion(thresholds: number[], start: number, end: number): string {
  * const ar: number[] = []
  * for (let i = 0; i < 3; i++) ar.push(rng())
  * // => [ 0.6270739405881613, 0.002735721180215478, 0.5274470399599522 ]
+ * 
+ * // the same seed will produce the same random number sequence
+ * rando(1)()
+ * // => 0.6270739405881613
+ * rando(1)()
+ * // => 0.6270739405881613
+ * 
+ * // but you can provide a fresh seed to change the sequence
+ * (rando(1) as any)(2)
+ * // => 0.7342509443406016
  * ```
  *
  * @param {number} seed - the seed for a random number sequence
  * @returns {Rng} a generator of random numbers
  */
 export function rando(seed: number): Rng {
-  return () => {
+  return (reseed?: number) => {
+    if (reseed !== undefined) seed = reseed
     let t = (seed += 0x6d2b79f5)
     t = Math.imul(t ^ (t >>> 15), t | 1)
     t ^= t + Math.imul(t ^ (t >>> 7), t | 61)