random.md (1612B)
1 <!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. --> 2 3 # Function random 4 5 Return a random number larger or equal to `min` and smaller than `max` 6 using a uniform distribution. 7 8 9 ## Syntax 10 11 ```js 12 math.random() // generate a random number between 0 and 1 13 math.random(max) // generate a random number between 0 and max 14 math.random(min, max) // generate a random number between min and max 15 math.random(size) // generate a matrix with random numbers between 0 and 1 16 math.random(size, max) // generate a matrix with random numbers between 0 and max 17 math.random(size, min, max) // generate a matrix with random numbers between min and max 18 ``` 19 20 ### Parameters 21 22 Parameter | Type | Description 23 --------- | ---- | ----------- 24 `size` | Array | Matrix | If provided, an array or matrix with given size and filled with random values is returned 25 `min` | number | Minimum boundary for the random value, included 26 `max` | number | Maximum boundary for the random value, excluded 27 28 ### Returns 29 30 Type | Description 31 ---- | ----------- 32 number | Array | Matrix | A random number 33 34 35 ### Throws 36 37 Type | Description 38 ---- | ----------- 39 40 41 ## Examples 42 43 ```js 44 math.random() // returns a random number between 0 and 1 45 math.random(100) // returns a random number between 0 and 100 46 math.random(30, 40) // returns a random number between 30 and 40 47 math.random([2, 3]) // returns a 2x3 matrix with random numbers between 0 and 1 48 ``` 49 50 51 ## See also 52 53 [randomInt](randomInt.md), 54 [pickRandom](pickRandom.md)