mirror of
https://github.com/josdejong/mathjs.git
synced 2026-01-18 14:59:29 +00:00
42 lines
1.7 KiB
JavaScript
42 lines
1.7 KiB
JavaScript
'use strict'
|
|
|
|
import { factory } from '../../utils/factory'
|
|
|
|
const name = 'random'
|
|
const dependencies = ['distribution']
|
|
|
|
export const createRandom = factory(name, dependencies, ({ distribution }) => {
|
|
/**
|
|
* Return a random number larger or equal to `min` and smaller than `max`
|
|
* using a uniform distribution.
|
|
*
|
|
* Syntax:
|
|
*
|
|
* math.random() // generate a random number between 0 and 1
|
|
* math.random(max) // generate a random number between 0 and max
|
|
* math.random(min, max) // generate a random number between min and max
|
|
* math.random(size) // generate a matrix with random numbers between 0 and 1
|
|
* math.random(size, max) // generate a matrix with random numbers between 0 and max
|
|
* math.random(size, min, max) // generate a matrix with random numbers between min and max
|
|
*
|
|
* Examples:
|
|
*
|
|
* math.random() // returns a random number between 0 and 1
|
|
* math.random(100) // returns a random number between 0 and 100
|
|
* math.random(30, 40) // returns a random number between 30 and 40
|
|
* math.random([2, 3]) // returns a 2x3 matrix with random numbers between 0 and 1
|
|
*
|
|
* See also:
|
|
*
|
|
* randomInt, pickRandom
|
|
*
|
|
* @param {Array | Matrix} [size] If provided, an array or matrix with given
|
|
* size and filled with random values is returned
|
|
* @param {number} [min] Minimum boundary for the random value, included
|
|
* @param {number} [max] Maximum boundary for the random value, excluded
|
|
* @return {number | Array | Matrix} A random number
|
|
*/
|
|
// TODO: rework random to a typed-function
|
|
return distribution('uniform').random
|
|
})
|