simple-squiggle/node_modules/mathjs/lib/cjs/expression/embeddedDocs/function/probability/pickRandom.js

15 lines
714 B
JavaScript
Raw Normal View History

"use strict";
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.pickRandomDocs = void 0;
var pickRandomDocs = {
name: 'pickRandom',
category: 'Probability',
syntax: ['pickRandom(array)', 'pickRandom(array, number)', 'pickRandom(array, weights)', 'pickRandom(array, number, weights)', 'pickRandom(array, weights, number)'],
description: 'Pick a random entry from a given array.',
examples: ['pickRandom(0:10)', 'pickRandom([1, 3, 1, 6])', 'pickRandom([1, 3, 1, 6], 2)', 'pickRandom([1, 3, 1, 6], [2, 3, 2, 1])', 'pickRandom([1, 3, 1, 6], 2, [2, 3, 2, 1])', 'pickRandom([1, 3, 1, 6], [2, 3, 2, 1], 2)'],
seealso: ['random', 'randomInt']
};
exports.pickRandomDocs = pickRandomDocs;