simple-squiggle/node_modules/mathjs/docs/reference/functions/randomInt.md

54 lines
1.6 KiB
Markdown

<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
# Function randomInt
Return a random integer number larger or equal to `min` and smaller than `max`
using a uniform distribution.
## Syntax
```js
math.randomInt() // generate a random integer between 0 and 1
math.randomInt(max) // generate a random integer between 0 and max
math.randomInt(min, max) // generate a random integer between min and max
math.randomInt(size) // generate a matrix with random integer between 0 and 1
math.randomInt(size, max) // generate a matrix with random integer between 0 and max
math.randomInt(size, min, max) // generate a matrix with random integer between min and max
```
### Parameters
Parameter | Type | Description
--------- | ---- | -----------
`size` | Array &#124; Matrix | If provided, an array or matrix with given size and filled with random values is returned
`min` | number | Minimum boundary for the random value, included
`max` | number | Maximum boundary for the random value, excluded
### Returns
Type | Description
---- | -----------
number &#124; Array &#124; Matrix | A random integer value
### Throws
Type | Description
---- | -----------
## Examples
```js
math.randomInt(100) // returns a random integer between 0 and 100
math.randomInt(30, 40) // returns a random integer between 30 and 40
math.randomInt([2, 3]) // returns a 2x3 matrix with random integers between 0 and 1
```
## See also
[random](random.md),
[pickRandom](pickRandom.md)