UNPKG

1.54 kBMarkdownView Raw
1<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
2
3# Function randomInt
4
5Return a random integer number larger or equal to `min` and smaller than `max`
6using a uniform distribution.
7
8
9## Syntax
10
11```js
12math.randomInt() // generate a random integer between 0 and 1
13math.randomInt(max) // generate a random integer between 0 and max
14math.randomInt(min, max) // generate a random integer between min and max
15math.randomInt(size) // generate a matrix with random integer between 0 and 1
16math.randomInt(size, max) // generate a matrix with random integer between 0 and max
17math.randomInt(size, min, max) // generate a matrix with random integer between min and max
18```
19
20### Parameters
21
22Parameter | Type | Description
23--------- | ---- | -----------
24`size` | Array &#124; Matrix | If provided, an array or matrix with given size and filled with random values is returned
25`min` | number | Minimum boundary for the random value, included
26`max` | number | Maximum boundary for the random value, excluded
27
28### Returns
29
30Type | Description
31---- | -----------
32number &#124; Array &#124; Matrix | A random integer value
33
34
35## Examples
36
37```js
38math.randomInt(100) // returns a random integer between 0 and 100
39math.randomInt(30, 40) // returns a random integer between 30 and 40
40math.randomInt([2, 3]) // returns a 2x3 matrix with random integers between 0 and 1
41```
42
43
44## See also
45
46[random](random.md),
47[pickRandom](pickRandom.md)