mathjs/docs/reference/functions/randomInt.md

layout
default

Function randomInt #

Return a random integer number larger or equal to min and smaller than max using a uniform distribution.

Syntax #

math.randomInt()                // generate either 0 or 1, randomly
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 | 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 | Array | Matrix	A random integer value

Throws #

Type	Description

Examples #

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, pickRandom