extra-rand 0.4.1 → 0.5.1

package/README.md

@@ -29,7 +29,7 @@ function randomInt(min: number, max: number): number
 function randomInt(generator: IRandomNumberGenerator, min: number, max: number): number
 ```
 
-The function returns an integer in the range `[Math.ceil(min), Math.floor(max))`.
+The function returns an integer in the range `[min, max)`.
 
 ### randomIntInclusive
 ```ts
@@ -41,7 +41,7 @@ function randomIntInclusive(
 ): number
 ```
 
-The function returns an integer in the range `[Math.ceil(min), Math.floor(max)]`.
+The function returns an integer in the range `[min, max]`.
 
 ### randomNumber
 ```ts
@@ -111,7 +111,7 @@ function randomPickIndex(
 ): number
 ```
 
-The function returns an integer in the range `[0, items.length]`.
+The function returns an integer in the range `[0, items.length - 1]`.
 
 ### randomPickWeightedIndex
 ```ts
@@ -122,7 +122,7 @@ function randomPickWeightedIndex(
 ): number
 ```
 
-The function returns an integer in the range `[0, weights.length]`.
+The function returns an integer in the range `[0, weights.length - 1]`.
 
 ### shuffle
 ```ts

package/lib/random-int-inclusive.js

@@ -1,5 +1,6 @@
 import { remap } from 'extra-utils';
 import { nativeRandomNumberGenerator } from './native-random-number-generator.js';
+import { assert } from '@blackglory/prelude';
 export function randomIntInclusive(...args) {
     let generator;
     let min;
@@ -11,6 +12,9 @@ export function randomIntInclusive(...args) {
     else {
         [generator, min, max] = args;
     }
-    return Math.floor(remap(generator.next(), [0, 1], [Math.ceil(min), Math.floor(max) + 1]));
+    assert(Number.isInteger(min), 'The parameter min must be an integer');
+    assert(Number.isInteger(max), 'The parameter max must be an integer');
+    assert(min <= max, 'The parameter min must be less than or equal to the parameter max');
+    return Math.floor(remap(generator.next(), [0, 1], [min, max + 1]));
 }
 //# sourceMappingURL=random-int-inclusive.js.map

package/lib/random-int-inclusive.js.map

@@ -1 +1 @@
-{"version":3,"file":"random-int-inclusive.js","sourceRoot":"","sources":["../src/random-int-inclusive.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AAEnC,OAAO,EAAE,2BAA2B,EAAE,MAAM,qCAAqC,CAAA;AAWjF,MAAM,UAAU,kBAAkB,CAAC,GAAG,IAEyB;IAE7D,IAAI,SAAiC,CAAA;IACrC,IAAI,GAAW,CAAA;IACf,IAAI,GAAW,CAAA;IAEf,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,SAAS,GAAG,2BAA2B,CACtC;QAAA,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,IAAI,CAAA;IACpB,CAAC;SAAM,CAAC;QACN,CAAC,SAAS,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,IAAI,CAAA;IAC9B,CAAC;IAED,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CACrB,SAAS,CAAC,IAAI,EAAE,EAChB,CAAC,CAAC,EAAE,CAAC,CAAC,EACN,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CACtC,CAAC,CAAA;AACJ,CAAC"}
+{"version":3,"file":"random-int-inclusive.js","sourceRoot":"","sources":["../src/random-int-inclusive.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AAEnC,OAAO,EAAE,2BAA2B,EAAE,MAAM,qCAAqC,CAAA;AACjF,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AAW5C,MAAM,UAAU,kBAAkB,CAAC,GAAG,IAEyB;IAE7D,IAAI,SAAiC,CAAA;IACrC,IAAI,GAAW,CAAA;IACf,IAAI,GAAW,CAAA;IAEf,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,SAAS,GAAG,2BAA2B,CACtC;QAAA,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,IAAI,CAAA;IACpB,CAAC;SAAM,CAAC;QACN,CAAC,SAAS,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,IAAI,CAAA;IAC9B,CAAC;IACD,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,sCAAsC,CAAC,CAAA;IACrE,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,sCAAsC,CAAC,CAAA;IACrE,MAAM,CAAC,GAAG,IAAI,GAAG,EAAE,mEAAmE,CAAC,CAAA;IAEvF,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CACrB,SAAS,CAAC,IAAI,EAAE,EAChB,CAAC,CAAC,EAAE,CAAC,CAAC,EACN,CAAC,GAAG,EAAE,GAAG,GAAG,CAAC,CAAC,CACf,CAAC,CAAA;AACJ,CAAC"}

package/lib/random-int.js

@@ -1,5 +1,6 @@
 import { remap } from 'extra-utils';
 import { nativeRandomNumberGenerator } from './native-random-number-generator.js';
+import { assert } from '@blackglory/prelude';
 export function randomInt(...args) {
     let generator;
     let min;
@@ -11,6 +12,9 @@ export function randomInt(...args) {
     else {
         [generator, min, max] = args;
     }
-    return Math.floor(remap(generator.next(), [0, 1], [Math.ceil(min), Math.floor(max)]));
+    assert(Number.isInteger(min), 'The parameter min must be an integer');
+    assert(Number.isInteger(max), 'The parameter max must be an integer');
+    assert(min < max, 'The parameter min must be less than the parameter max');
+    return Math.floor(remap(generator.next(), [0, 1], [min, max]));
 }
 //# sourceMappingURL=random-int.js.map

package/lib/random-int.js.map

@@ -1 +1 @@
-{"version":3,"file":"random-int.js","sourceRoot":"","sources":["../src/random-int.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AAEnC,OAAO,EAAE,2BAA2B,EAAE,MAAM,qCAAqC,CAAA;AAQjF,MAAM,UAAU,SAAS,CAAC,GAAG,IAEkC;IAE7D,IAAI,SAAiC,CAAA;IACrC,IAAI,GAAW,CAAA;IACf,IAAI,GAAW,CAAA;IAEf,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,SAAS,GAAG,2BAA2B,CACtC;QAAA,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,IAAI,CAAA;IACpB,CAAC;SAAM,CAAC;QACN,CAAC,SAAS,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,IAAI,CAAA;IAC9B,CAAC;IAED,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CACrB,SAAS,CAAC,IAAI,EAAE,EAChB,CAAC,CAAC,EAAE,CAAC,CAAC,EACN,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAClC,CAAC,CAAA;AACJ,CAAC"}
+{"version":3,"file":"random-int.js","sourceRoot":"","sources":["../src/random-int.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AAEnC,OAAO,EAAE,2BAA2B,EAAE,MAAM,qCAAqC,CAAA;AACjF,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AAQ5C,MAAM,UAAU,SAAS,CAAC,GAAG,IAEkC;IAE7D,IAAI,SAAiC,CAAA;IACrC,IAAI,GAAW,CAAA;IACf,IAAI,GAAW,CAAA;IAEf,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,SAAS,GAAG,2BAA2B,CACtC;QAAA,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,IAAI,CAAA;IACpB,CAAC;SAAM,CAAC;QACN,CAAC,SAAS,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,IAAI,CAAA;IAC9B,CAAC;IACD,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,sCAAsC,CAAC,CAAA;IACrE,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,sCAAsC,CAAC,CAAA;IACrE,MAAM,CAAC,GAAG,GAAG,GAAG,EAAE,uDAAuD,CAAC,CAAA;IAE1E,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CACrB,SAAS,CAAC,IAAI,EAAE,EAChB,CAAC,CAAC,EAAE,CAAC,CAAC,EACN,CAAC,GAAG,EAAE,GAAG,CAAC,CACX,CAAC,CAAA;AACJ,CAAC"}

package/lib/random-number.d.ts

@@ -1,4 +1,4 @@
-import { Getter, NonEmptyArray } from 'justypes';
+import { Getter, NonEmptyArray } from '@blackglory/prelude';
 import { IRandomNumberGenerator } from './types.js';
 export declare enum NumberType {
     Float = 0,

package/lib/random-pick-index.d.ts

@@ -1,4 +1,4 @@
-import { NonEmptyArray } from 'justypes';
+import { NonEmptyArray } from '@blackglory/prelude';
 import { IRandomNumberGenerator } from './types.js';
 export declare function randomPickIndex(items: NonEmptyArray<unknown>): number;
 export declare function randomPickIndex(generator: IRandomNumberGenerator, items: NonEmptyArray<unknown>): number;

package/lib/random-pick-item.d.ts

@@ -1,4 +1,4 @@
-import { NonEmptyArray } from 'justypes';
+import { NonEmptyArray } from '@blackglory/prelude';
 import { IRandomNumberGenerator } from './types.js';
 export declare function randomPickItem<T>(items: NonEmptyArray<T>): T;
 export declare function randomPickItem<T>(generator: IRandomNumberGenerator, items: NonEmptyArray<T>): T;

package/lib/random-pick-weighted-index.d.ts

@@ -1,4 +1,4 @@
-import { NonEmptyArray } from 'justypes';
+import { NonEmptyArray } from '@blackglory/prelude';
 import { IRandomNumberGenerator } from './types.js';
 export declare function randomPickWeightedIndex(weights: NonEmptyArray<number>): number;
 export declare function randomPickWeightedIndex(generator: IRandomNumberGenerator, weights: NonEmptyArray<number>): number;

package/lib/random-pick-weighted-item.d.ts

@@ -1,4 +1,4 @@
-import { NonEmptyArray } from 'justypes';
+import { NonEmptyArray } from '@blackglory/prelude';
 import { IRandomNumberGenerator } from './types.js';
 export interface IWeightedItem {
     weight: number;

package/lib/shuffle.js

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

package/lib/shuffle.js.map

@@ -1 +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"}
+{"version":3,"file":"shuffle.js","sourceRoot":"","sources":["../src/shuffle.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,2BAA2B,EAAE,MAAM,qCAAqC,CAAA;AACjF,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAA;AAI9D,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;IAGD,KAAK,IAAI,WAAW,GAAG,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE,WAAW,IAAI,CAAC,EAAE,WAAW,EAAE,EAAE,CAAC;QACvE,MAAM,KAAK,GAAG,kBAAkB,CAAC,SAAS,EAAE,CAAC,EAAE,WAAW,CAAC,CAAA;QAC3D,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.4.1",
+  "version": "0.5.1",
   "description": "Yet another random library",
   "keywords": [
     "random"
@@ -14,7 +14,7 @@
   "sideEffects": false,
   "type": "module",
   "engines": {
-    "node": ">=18.17.0"
+    "node": ">=22"
   },
   "repository": "git@github.com:BlackGlory/extra-rand.git",
   "author": "BlackGlory <woshenmedoubuzhidao@blackglory.me>",
@@ -39,6 +39,7 @@
     "@commitlint/config-conventional": "^19.2.2",
     "@eslint/js": "^9.0.0",
     "eslint": "^9.0.0",
+    "extra-generator": "^0.7.1",
     "husky": "^4.3.8",
     "npm-run-all": "^4.1.5",
     "rimraf": "^5.0.5",
@@ -53,8 +54,7 @@
     "vitest": "^1.5.0"
   },
   "dependencies": {
-    "@blackglory/errors": "^3.0.3",
-    "extra-utils": "^5.15.0",
-    "justypes": "^4.2.1"
+    "@blackglory/prelude": "^0.4.0",
+    "extra-utils": "^5.21.0"
   }
 }

package/src/random-int-inclusive.ts

@@ -1,6 +1,7 @@
 import { remap } from 'extra-utils'
 import { IRandomNumberGenerator } from './types.js'
 import { nativeRandomNumberGenerator } from './native-random-number-generator.js'
+import { assert } from '@blackglory/prelude'
 
 export function randomIntInclusive(
   min: number
@@ -25,10 +26,13 @@ export function randomIntInclusive(...args:
   } else {
     [generator, min, max] = args
   }
+  assert(Number.isInteger(min), 'The parameter min must be an integer')
+  assert(Number.isInteger(max), 'The parameter max must be an integer')
+  assert(min <= max, 'The parameter min must be less than or equal to the parameter max')
 
   return Math.floor(remap(
     generator.next()
   , [0, 1]
-  , [Math.ceil(min), Math.floor(max) + 1]
+  , [min, max + 1]
   ))
 }

package/src/random-int.ts

@@ -1,6 +1,7 @@
 import { remap } from 'extra-utils'
 import { IRandomNumberGenerator } from './types.js'
 import { nativeRandomNumberGenerator } from './native-random-number-generator.js'
+import { assert } from '@blackglory/prelude'
 
 export function randomInt(min: number, max: number): number
 export function randomInt(
@@ -22,10 +23,13 @@ export function randomInt(...args:
   } else {
     [generator, min, max] = args
   }
+  assert(Number.isInteger(min), 'The parameter min must be an integer')
+  assert(Number.isInteger(max), 'The parameter max must be an integer')
+  assert(min < max, 'The parameter min must be less than the parameter max')
 
   return Math.floor(remap(
     generator.next()
   , [0, 1]
-  , [Math.ceil(min), Math.floor(max)]
+  , [min, max]
   ))
 }

package/src/random-number.ts

@@ -1,4 +1,4 @@
-import { Getter, NonEmptyArray } from 'justypes'
+import { Getter, NonEmptyArray } from '@blackglory/prelude'
 import { isArray, isFunction, isNumber } from 'extra-utils'
 import { randomFloat } from './random-float.js'
 import { randomInt } from './random-int.js'

package/src/random-pick-index.ts

@@ -1,4 +1,4 @@
-import { NonEmptyArray } from 'justypes'
+import { NonEmptyArray } from '@blackglory/prelude'
 import { IRandomNumberGenerator } from './types.js'
 import { nativeRandomNumberGenerator } from './native-random-number-generator.js'
 import { randomInt } from './random-int.js'

package/src/random-pick-item.ts

@@ -1,4 +1,4 @@
-import { NonEmptyArray } from 'justypes'
+import { NonEmptyArray } from '@blackglory/prelude'
 import { IRandomNumberGenerator } from './types.js'
 import { nativeRandomNumberGenerator } from './native-random-number-generator.js'
 import { randomPickIndex } from './random-pick-index.js'

package/src/random-pick-weighted-index.ts

@@ -1,4 +1,4 @@
-import { NonEmptyArray } from 'justypes'
+import { NonEmptyArray } from '@blackglory/prelude'
 import { remapToWeightedIndex } from 'extra-utils'
 import { IRandomNumberGenerator } from './types.js'
 import { nativeRandomNumberGenerator } from './native-random-number-generator.js'

package/src/random-pick-weighted-item.ts

@@ -1,5 +1,5 @@
 import { randomPickWeightedIndex } from './random-pick-weighted-index.js'
-import { NonEmptyArray } from 'justypes'
+import { NonEmptyArray } from '@blackglory/prelude'
 import { IRandomNumberGenerator } from './types.js'
 import { nativeRandomNumberGenerator } from './native-random-number-generator.js'
 import { isArray } from 'extra-utils'

package/src/shuffle.ts

@@ -1,6 +1,6 @@
 import { IRandomNumberGenerator } from './types.js'
 import { nativeRandomNumberGenerator } from './native-random-number-generator.js'
-import { randomInt } from './random-int.js'
+import { randomIntInclusive } from './random-int-inclusive.js'
 
 export function shuffle(arr: unknown[]): void
 export function shuffle(generator: IRandomNumberGenerator, arr: unknown[]): void
@@ -18,8 +18,9 @@ export function shuffle(...args:
     [generator, arr] = args
   }
 
-  for (let targetIndex = arr.length - 1; targetIndex > 1; targetIndex--) {
-    const index = randomInt(generator, 0, targetIndex)
+  // https://en.wikipedia.org/wiki/Fisher%E2%80%93Yates_shuffle#The_modern_algorithm
+  for (let targetIndex = arr.length - 1; targetIndex >= 1; targetIndex--) {
+    const index = randomIntInclusive(generator, 0, targetIndex)
     const temp = arr[targetIndex]
     arr[targetIndex] = arr[index]
     arr[index] = temp