shuffle.js (1485B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 // MODULES // 22 23 var factory = require( './factory.js' ); 24 25 26 // MAIN // 27 28 /** 29 * Returns a random permutation of elements in `arr`. 30 * 31 * @name shuffle 32 * @type {Function} 33 * @param {ArrayLike} arr - array-like object to shuffle 34 * @param {Options} [options] - function options 35 * @param {string} [options.copy="shallow"] - string indicating whether to return a copy (`deep`,`shallow` or `none`) 36 * @throws {TypeError} `options` must be an object 37 * @throws {TypeError} must provide valid options 38 * @returns {ArrayLike} the shuffled array-like object 39 * 40 * @example 41 * var data = [ 1, 2, 3 ]; 42 * var out = shuffle( data ); 43 * // e.g., returns [ 3, 1, 2 ] 44 * 45 * @example 46 * var data = [ 1, 2, 3 ]; 47 * var out = shuffle( data, { 48 * 'copy': 'none' 49 * }); 50 * var bool = ( data === out ); 51 * // returns true 52 */ 53 var shuffle = factory(); 54 55 56 // EXPORTS // 57 58 module.exports = shuffle;