module.exports = function (math) { /** * Return a random integer number between `min` and `max` using a uniform distribution. * * Syntax: * * 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 * * Examples: * * var math = mathjs(); * * 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, pickRandom, distribution * * @param {Number} [size] If provided, an array with `size` number of random values is returned * @param {Number} [min] Minimum boundary for the random value * @param {Number} [max] Maximum boundary for the random value * @return {Number | Array | Matrix} A random integer value */ math.randomInt = math.distribution('uniform').randomInt; };