extra-rand 0.3.1 → 0.3.3

package/README.md

@@ -110,6 +110,12 @@ function randomByModel(model: IRandomModel): number
 function randomByModel(generator: IRandomNumberGenerator, model: IRandomModel): number
 ```
 
+### shuffle
+```ts
+function shuffle(arr: unknown[]): void
+function shuffle(generator: IRandomNumberGenerator, arr: unknown[]): void
+```
+
 ### mapToRange
 ```ts
 function mapToRange(

package/lib/index.d.ts

@@ -7,5 +7,6 @@ export * from './random-index-by-weight.js';
 export * from './random-weighted.js';
 export * from './random-by-weight-model.js';
 export * from './random-by-model.js';
+export * from './shuffle.js';
 export * from './map-to-range.js';
 export * from './map-to-index-by-weight.js';

package/lib/index.js

@@ -7,6 +7,7 @@ export * from './random-index-by-weight.js';
 export * from './random-weighted.js';
 export * from './random-by-weight-model.js';
 export * from './random-by-model.js';
+export * from './shuffle.js';
 export * from './map-to-range.js';
 export * from './map-to-index-by-weight.js';
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAE1B,cAAc,aAAa,CAAA;AAC3B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,2BAA2B,CAAA;AACzC,cAAc,kBAAkB,CAAA;AAChC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,sBAAsB,CAAA;AACpC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,sBAAsB,CAAA;AAEpC,cAAc,mBAAmB,CAAA;AACjC,cAAc,6BAA6B,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAE1B,cAAc,aAAa,CAAA;AAC3B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,2BAA2B,CAAA;AACzC,cAAc,kBAAkB,CAAA;AAChC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,sBAAsB,CAAA;AACpC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,sBAAsB,CAAA;AACpC,cAAc,cAAc,CAAA;AAE5B,cAAc,mBAAmB,CAAA;AACjC,cAAc,6BAA6B,CAAA"}

package/lib/map-to-range.js

@@ -1,6 +1,5 @@
+import { remap } from 'extra-utils';
 export function mapToRange(value, oldMin, oldMax, newMin, newMax) {
-    return (value - oldMin) / (oldMax - oldMin)
-        * (newMax - newMin)
-        + newMin;
+    return remap(value, [oldMin, oldMax], [newMin, newMax]);
 }
 //# sourceMappingURL=map-to-range.js.map

package/lib/map-to-range.js.map

@@ -1 +1 @@
-{"version":3,"file":"map-to-range.js","sourceRoot":"","sources":["../src/map-to-range.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,UAAU,CACxB,KAAa,EACb,MAAc,EAAE,MAAc,EAC9B,MAAc,EAAE,MAAc;IAE9B,OAAO,CAAC,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC;UACpC,CAAC,MAAM,GAAG,MAAM,CAAC;UACjB,MAAM,CAAA;AACf,CAAC"}
+{"version":3,"file":"map-to-range.js","sourceRoot":"","sources":["../src/map-to-range.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AAKnC,MAAM,UAAU,UAAU,CACxB,KAAa,EACb,MAAc,EAAE,MAAc,EAC9B,MAAc,EAAE,MAAc;IAE9B,OAAO,KAAK,CAAC,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;AACzD,CAAC"}

package/lib/native-random-number-generator.d.ts

@@ -1,2 +1,2 @@
 import { IRandomNumberGenerator } from './types.js';
-export declare const NativeRandomNumberGenerator: IRandomNumberGenerator;
+export declare const nativeRandomNumberGenerator: IRandomNumberGenerator;

package/lib/native-random-number-generator.js

@@ -1,4 +1,4 @@
-export const NativeRandomNumberGenerator = {
+export const nativeRandomNumberGenerator = {
     next: Math.random
 };
 //# sourceMappingURL=native-random-number-generator.js.map

package/lib/random-bool.js

@@ -1,10 +1,10 @@
-import { NativeRandomNumberGenerator } from './native-random-number-generator.js';
+import { nativeRandomNumberGenerator } from './native-random-number-generator.js';
 import { random } from './random.js';
 export function randomBool(...args) {
     let generator;
     let probabilityOfTrue;
     if (args.length === 1) {
-        generator = NativeRandomNumberGenerator;
+        generator = nativeRandomNumberGenerator;
         [probabilityOfTrue] = args;
     }
     else {

package/lib/random-by-model.js

@@ -3,7 +3,7 @@ import { randomByWeightModel } from './random-by-weight-model.js';
 import { random } from './random.js';
 import { randomInt } from './random-int.js';
 import { randomIntInclusive } from './random-int-inclusive.js';
-import { NativeRandomNumberGenerator } from './native-random-number-generator.js';
+import { nativeRandomNumberGenerator } from './native-random-number-generator.js';
 export var Type;
 (function (Type) {
     Type[Type["Float"] = 0] = "Float";
@@ -14,7 +14,7 @@ export function randomByModel(...args) {
     let generator;
     let model;
     if (args.length === 1) {
-        generator = NativeRandomNumberGenerator;
+        generator = nativeRandomNumberGenerator;
         [model] = args;
     }
     else {

package/lib/random-by-weight-model.js

@@ -1,10 +1,10 @@
 import { randomWeighted } from './random-weighted.js';
-import { NativeRandomNumberGenerator } from './native-random-number-generator.js';
+import { nativeRandomNumberGenerator } from './native-random-number-generator.js';
 export function randomByWeightModel(...args) {
     let generator;
     let model;
     if (args.length === 1) {
-        generator = NativeRandomNumberGenerator;
+        generator = nativeRandomNumberGenerator;
         [model] = args;
     }
     else {

package/lib/random-index-by-weight.js

@@ -1,10 +1,10 @@
 import { mapToIndexByWeight } from './map-to-index-by-weight.js';
-import { NativeRandomNumberGenerator } from './native-random-number-generator.js';
+import { nativeRandomNumberGenerator } from './native-random-number-generator.js';
 export function randomIndexByWeight(...args) {
     let generator;
     let weights;
     if (args.length === 1) {
-        generator = NativeRandomNumberGenerator;
+        generator = nativeRandomNumberGenerator;
         [weights] = args;
     }
     else {

package/lib/random-int-inclusive.js

@@ -1,11 +1,11 @@
 import { mapToRange } from './map-to-range.js';
-import { NativeRandomNumberGenerator } from './native-random-number-generator.js';
+import { nativeRandomNumberGenerator } from './native-random-number-generator.js';
 export function randomIntInclusive(...args) {
     let generator;
     let min;
     let max;
     if (args.length === 2) {
-        generator = NativeRandomNumberGenerator;
+        generator = nativeRandomNumberGenerator;
         [min, max] = args;
     }
     else {

package/lib/random-int.js

@@ -1,11 +1,11 @@
 import { mapToRange } from './map-to-range.js';
-import { NativeRandomNumberGenerator } from './native-random-number-generator.js';
+import { nativeRandomNumberGenerator } from './native-random-number-generator.js';
 export function randomInt(...args) {
     let generator;
     let min;
     let max;
     if (args.length === 2) {
-        generator = NativeRandomNumberGenerator;
+        generator = nativeRandomNumberGenerator;
         [min, max] = args;
     }
     else {

package/lib/random-weighted.js

@@ -1,10 +1,10 @@
 import { randomIndexByWeight } from './random-index-by-weight.js';
-import { NativeRandomNumberGenerator } from './native-random-number-generator.js';
+import { nativeRandomNumberGenerator } from './native-random-number-generator.js';
 export function randomWeighted(...args) {
     let generator;
     let values;
     if (args.length === 1) {
-        generator = NativeRandomNumberGenerator;
+        generator = nativeRandomNumberGenerator;
         [values] = args;
     }
     else {

package/lib/random.js

@@ -1,11 +1,11 @@
 import { mapToRange } from './map-to-range.js';
-import { NativeRandomNumberGenerator } from './native-random-number-generator.js';
+import { nativeRandomNumberGenerator } from './native-random-number-generator.js';
 export function random(...args) {
     let generator;
     let min;
     let max;
     if (args.length === 2) {
-        generator = NativeRandomNumberGenerator;
+        generator = nativeRandomNumberGenerator;
         [min, max] = args;
     }
     else {

package/lib/shuffle.d.ts

@@ -0,0 +1,3 @@
+import { IRandomNumberGenerator } from './types.js';
+export declare function shuffle(arr: unknown[]): void;
+export declare function shuffle(generator: IRandomNumberGenerator, arr: unknown[]): void;

package/lib/shuffle.js

@@ -0,0 +1,20 @@
+import { nativeRandomNumberGenerator } from './native-random-number-generator.js';
+import { randomInt } from './random-int.js';
+export function shuffle(...args) {
+    let generator;
+    let arr;
+    if (args.length === 1) {
+        generator = nativeRandomNumberGenerator;
+        [arr] = args;
+    }
+    else {
+        [generator, arr] = args;
+    }
+    for (let targetIndex = arr.length - 1; targetIndex > 1; targetIndex--) {
+        const index = randomInt(generator, 0, targetIndex);
+        const temp = arr[targetIndex];
+        arr[targetIndex] = arr[index];
+        arr[index] = temp;
+    }
+}
+//# sourceMappingURL=shuffle.js.map

package/lib/shuffle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shuffle.js","sourceRoot":"","sources":["../src/shuffle.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,2BAA2B,EAAE,MAAM,qCAAqC,CAAA;AACjF,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAI3C,MAAM,UAAU,OAAO,CAAC,GAAG,IAE0B;IAEnD,IAAI,SAAiC,CAAA;IACrC,IAAI,GAAc,CAAA;IAElB,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,SAAS,GAAG,2BAA2B,CACtC;QAAA,CAAC,GAAG,CAAC,GAAG,IAAI,CAAA;IACf,CAAC;SAAM,CAAC;QACN,CAAC,SAAS,EAAE,GAAG,CAAC,GAAG,IAAI,CAAA;IACzB,CAAC;IAED,KAAK,IAAI,WAAW,GAAG,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE,WAAW,GAAG,CAAC,EAAE,WAAW,EAAE,EAAE,CAAC;QACtE,MAAM,KAAK,GAAG,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,WAAW,CAAC,CAAA;QAClD,MAAM,IAAI,GAAG,GAAG,CAAC,WAAW,CAAC,CAAA;QAC7B,GAAG,CAAC,WAAW,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,CAAA;QAC7B,GAAG,CAAC,KAAK,CAAC,GAAG,IAAI,CAAA;IACnB,CAAC;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "extra-rand",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "description": "Yet another random library",
   "keywords": [
     "random"
@@ -54,7 +54,7 @@
   },
   "dependencies": {
     "@blackglory/errors": "^3.0.3",
-    "extra-utils": "^5.7.0",
+    "extra-utils": "^5.10.0",
     "justypes": "^4.2.1"
   }
 }

package/src/index.ts

@@ -8,6 +8,7 @@ export * from './random-index-by-weight.js'
 export * from './random-weighted.js'
 export * from './random-by-weight-model.js'
 export * from './random-by-model.js'
+export * from './shuffle.js'
 
 export * from './map-to-range.js'
 export * from './map-to-index-by-weight.js'

package/src/map-to-range.ts

@@ -1,9 +1,12 @@
+import { remap } from 'extra-utils'
+
+/**
+ * @deprecated use `remap` of `extra-utils` instead
+ */
 export function mapToRange(
   value: number
 , oldMin: number, oldMax: number
 , newMin: number, newMax: number
 ): number {
-  return (value - oldMin) / (oldMax - oldMin)
-       * (newMax - newMin)
-       + newMin
+  return remap(value, [oldMin, oldMax], [newMin, newMax])
 }

package/src/native-random-number-generator.ts

@@ -1,5 +1,5 @@
 import { IRandomNumberGenerator } from './types.js'
 
-export const NativeRandomNumberGenerator: IRandomNumberGenerator = {
+export const nativeRandomNumberGenerator: IRandomNumberGenerator = {
   next: Math.random
 }

package/src/random-bool.ts

@@ -1,5 +1,5 @@
 import { IRandomNumberGenerator } from './types.js'
-import { NativeRandomNumberGenerator } from './native-random-number-generator.js'
+import { nativeRandomNumberGenerator } from './native-random-number-generator.js'
 import { random } from './random.js'
 
 export function randomBool(probabilityOfTrue: number): boolean
@@ -15,7 +15,7 @@ export function randomBool(...args:
   let probabilityOfTrue: number
 
   if (args.length === 1) {
-    generator = NativeRandomNumberGenerator
+    generator = nativeRandomNumberGenerator
     ;[probabilityOfTrue] = args
   } else {
     [generator, probabilityOfTrue] = args

package/src/random-by-model.ts

@@ -5,7 +5,7 @@ import { random } from './random.js'
 import { randomInt } from './random-int.js'
 import { randomIntInclusive } from './random-int-inclusive.js'
 import { IRandomNumberGenerator } from './types.js'
-import { NativeRandomNumberGenerator } from './native-random-number-generator.js'
+import { nativeRandomNumberGenerator } from './native-random-number-generator.js'
 
 export enum Type {
   Float
@@ -39,7 +39,7 @@ export function randomByModel(...args:
   let model: IRandomModel
 
   if (args.length === 1) {
-    generator = NativeRandomNumberGenerator
+    generator = nativeRandomNumberGenerator
     ;[model] = args
   } else {
     [generator, model] = args

package/src/random-by-weight-model.ts

@@ -1,7 +1,7 @@
 import { NonEmptyArray } from 'justypes'
 import { randomWeighted } from './random-weighted.js'
 import { IRandomNumberGenerator } from './types.js'
-import { NativeRandomNumberGenerator } from './native-random-number-generator.js'
+import { nativeRandomNumberGenerator } from './native-random-number-generator.js'
 
 export type IWeightModel<T> = NonEmptyArray<{
   weight: number
@@ -21,7 +21,7 @@ export function randomByWeightModel<T>(...args:
   let model: IWeightModel<T>
 
   if (args.length === 1) {
-    generator = NativeRandomNumberGenerator
+    generator = nativeRandomNumberGenerator
     ;[model] = args
   } else {
     [generator, model] = args

package/src/random-index-by-weight.ts

@@ -1,7 +1,7 @@
 import { NonEmptyArray } from 'justypes'
 import { mapToIndexByWeight } from './map-to-index-by-weight.js'
 import { IRandomNumberGenerator } from './types.js'
-import { NativeRandomNumberGenerator } from './native-random-number-generator.js'
+import { nativeRandomNumberGenerator } from './native-random-number-generator.js'
 
 export function randomIndexByWeight(weights: NonEmptyArray<number>): number
 export function randomIndexByWeight(
@@ -16,7 +16,7 @@ export function randomIndexByWeight(...args:
   let weights: NonEmptyArray<number>
 
   if (args.length === 1) {
-    generator = NativeRandomNumberGenerator
+    generator = nativeRandomNumberGenerator
     ;[weights] = args
   } else {
     [generator, weights] = args

package/src/random-int-inclusive.ts

@@ -1,6 +1,6 @@
 import { mapToRange } from './map-to-range.js'
 import { IRandomNumberGenerator } from './types.js'
-import { NativeRandomNumberGenerator } from './native-random-number-generator.js'
+import { nativeRandomNumberGenerator } from './native-random-number-generator.js'
 
 export function randomIntInclusive(
   min: number
@@ -20,7 +20,7 @@ export function randomIntInclusive(...args:
   let max: number
 
   if (args.length === 2) {
-    generator = NativeRandomNumberGenerator
+    generator = nativeRandomNumberGenerator
     ;[min, max] = args
   } else {
     [generator, min, max] = args

package/src/random-int.ts

@@ -1,6 +1,6 @@
 import { mapToRange } from './map-to-range.js'
 import { IRandomNumberGenerator } from './types.js'
-import { NativeRandomNumberGenerator } from './native-random-number-generator.js'
+import { nativeRandomNumberGenerator } from './native-random-number-generator.js'
 
 export function randomInt(min: number, max: number): number
 export function randomInt(
@@ -17,7 +17,7 @@ export function randomInt(...args:
   let max: number
 
   if (args.length === 2) {
-    generator = NativeRandomNumberGenerator
+    generator = nativeRandomNumberGenerator
     ;[min, max] = args
   } else {
     [generator, min, max] = args

package/src/random-weighted.ts

@@ -1,7 +1,7 @@
 import { randomIndexByWeight } from './random-index-by-weight.js'
 import { NonEmptyArray } from 'justypes'
 import { IRandomNumberGenerator } from './types.js'
-import { NativeRandomNumberGenerator } from './native-random-number-generator.js'
+import { nativeRandomNumberGenerator } from './native-random-number-generator.js'
 
 export interface IWeighted {
   weight: number
@@ -20,7 +20,7 @@ export function randomWeighted<T extends IWeighted>(...args:
   let values: NonEmptyArray<T>
 
   if (args.length === 1) {
-    generator = NativeRandomNumberGenerator
+    generator = nativeRandomNumberGenerator
     ;[values] = args
   } else {
     [generator, values] = args

package/src/random.ts

@@ -1,6 +1,6 @@
 import { mapToRange } from './map-to-range.js'
 import { IRandomNumberGenerator } from './types.js'
-import { NativeRandomNumberGenerator } from './native-random-number-generator.js'
+import { nativeRandomNumberGenerator } from './native-random-number-generator.js'
 
 export function random(min: number, max: number): number
 export function random(
@@ -17,7 +17,7 @@ export function random(...args:
   let max: number
 
   if (args.length === 2) {
-    generator = NativeRandomNumberGenerator
+    generator = nativeRandomNumberGenerator
     ;[min, max] = args
   } else {
     [generator, min, max] = args

package/src/shuffle.ts

@@ -0,0 +1,27 @@
+import { IRandomNumberGenerator } from './types.js'
+import { nativeRandomNumberGenerator } from './native-random-number-generator.js'
+import { randomInt } from './random-int.js'
+
+export function shuffle(arr: unknown[]): void
+export function shuffle(generator: IRandomNumberGenerator, arr: unknown[]): void
+export function shuffle(...args:
+| [arr: unknown[]]
+| [generator: IRandomNumberGenerator, arr: unknown[]]
+) {
+  let generator: IRandomNumberGenerator
+  let arr: unknown[]
+
+  if (args.length === 1) {
+    generator = nativeRandomNumberGenerator
+    ;[arr] = args
+  } else {
+    [generator, arr] = args
+  }
+
+  for (let targetIndex = arr.length - 1; targetIndex > 1; targetIndex--) {
+    const index = randomInt(generator, 0, targetIndex)
+    const temp = arr[targetIndex]
+    arr[targetIndex] = arr[index]
+    arr[index] = temp
+  }
+}