index.js (1288B)
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 /** 22 * Return a random permutation of elements from an array-like object. 23 * 24 * @module @stdlib/random/shuffle 25 * 26 * @example 27 * var shuffle = require( '@stdlib/random/shuffle' ); 28 * 29 * var data = [ 1, 2, 3 ]; 30 * var out = shuffle( data ); 31 * // e.g., returns [ 3, 1, 2 ] 32 * 33 * out = shuffle( data, { 34 * 'copy': 'none' 35 * }); 36 * 37 * var bool = ( data === out ); 38 * // returns true 39 */ 40 41 // MODULES // 42 43 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); 44 var shuffle = require( './shuffle.js' ); 45 var factory = require( './factory.js' ); 46 47 48 // MAIN // 49 50 setReadOnly( shuffle, 'factory', factory ); 51 52 53 // EXPORTS // 54 55 module.exports = shuffle;