mirror of
https://github.com/josdejong/mathjs.git
synced 2025-12-08 19:46:04 +00:00
50 lines
1.5 KiB
Markdown
50 lines
1.5 KiB
Markdown
# Function randomInt
|
|
|
|
Return a random integer number between `min` and `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` | Number | If provided, an array with `size` number of random values is returned
|
|
`min` | Number | Minimum boundary for the random value
|
|
`max` | Number | Maximum boundary for the random value
|
|
|
|
### Returns
|
|
|
|
Type | Description
|
|
---- | -----------
|
|
Number | Array | Matrix | A random integer value
|
|
|
|
|
|
## Examples
|
|
|
|
```js
|
|
math.randomInt(); // returns a random integer between 0 and 1
|
|
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
|
|
|
|
[randomInt](randomInt.md),
|
|
[pickRandom](pickRandom.md),
|
|
[distribution](distribution.md)
|
|
|
|
|
|
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|