mirror of
https://github.com/josdejong/mathjs.git
synced 2025-12-08 19:46:04 +00:00
31 lines
767 B
JavaScript
31 lines
767 B
JavaScript
'use strict';
|
|
|
|
function factory (type, config, load, typed) {
|
|
var distribution = load(require('./distribution'));
|
|
|
|
/**
|
|
* Random pick a value from a one dimensional array.
|
|
* Array element is picked using a random function with uniform distribution.
|
|
*
|
|
* Syntax:
|
|
*
|
|
* math.pickRandom(array)
|
|
*
|
|
* Examples:
|
|
*
|
|
* math.pickRandom([3, 6, 12, 2]); // returns one of the values in the array
|
|
*
|
|
* See also:
|
|
*
|
|
* random, randomInt
|
|
*
|
|
* @param {Array} array A one dimensional array
|
|
* @return {Number} One of the elements of the provided input array
|
|
*/
|
|
// TODO: rework pickRandom to a typed-function
|
|
return distribution('uniform').pickRandom;
|
|
}
|
|
|
|
exports.name = 'pickRandom';
|
|
exports.factory = factory;
|