HoshinoKoji/jsPsych
1
0
Fork 0
mirror of https://github.com/jspsych/jsPsych.git synced 2025-05-10 11:10:54 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

use string as seed

Browse Source
This commit is contained in:
Josh de Leeuw 2022-03-11 12:31:47 -05:00
parent f2f9a00ae0
commit 2cea5640f7
2 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/reference/jspsych-randomization.md
View File

@ -477,7 +477,7 @@ jsPsych.randomization.setSeed(seed)
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ----- | ------------------------------ | | --------- | ----- | ------------------------------ |
| seed | string or number | A seed for the random number generator | | seed | string | A seed for the random number generator |
### Return value ### Return value
@ -495,12 +495,19 @@ The seed value will be returned from the function call, allowing you to save it
### Examples ### Examples
#### Shuffle an array #### Use a random 32-bit seed and save to data
```javascript ```javascript
var myArray = [1,2,3,4,5]; const seed = jsPsych.setSeed();
var shuffledArray = jsPsych.randomization.shuffle(myArray); jsPsych.data.addProperties({
// output: shuffledArray = [3,2,4,1,5] rng_seed: seed
});
```
#### Use your own seed
```javascript
jsPsych.setSeed("jspsych");
``` ```
--- ---

4
packages/jspsych/src/modules/randomization.ts
View File

@ -7,10 +7,10 @@ import seedrandom from "seedrandom";
* @param seed An optional seed. If none is given, a random seed will be generated. * @param seed An optional seed. If none is given, a random seed will be generated.
* @returns The seed value. * @returns The seed value.
*/ */
export function setSeed(seed?) { export function setSeed(seed?: string) {
if (!seed) { if (!seed) {
const prng = seedrandom(); const prng = seedrandom();
seed = prng.int32(); seed = prng.int32().toString();
} }
seedrandom(seed, { global: true }); seedrandom(seed, { global: true });
return seed; return seed;