time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

index.js (1487B)

      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 * Sample elements from an array-like object.
     23 *
     24 * @module @stdlib/random/sample
     25 *
     26 * @example
     27 * var sample = require( '@stdlib/random/sample' );
     28 *
     29 * var out = sample( 'abc' );
     30 * // e.g., returns [ 'a', 'a', 'b' ]
     31 *
     32 * out = sample( [ 3, 6, 9 ] );
     33 * // e.g., returns [ 3, 9, 6 ]
     34 *
     35 * var bool = ( out.length === 3 );
     36 * // returns true
     37 *
     38 * @example
     39 * var sample = require( '@stdlib/random/sample' );
     40 *
     41 * var mysample = sample.factory({
     42 *     'seed': 323
     43 * });
     44 * var out = mysample( [ 3, 6, 9 ], {
     45 *     'size': 10
     46 * });
     47 * // e.g., returns [ 3, 9, 3, 3, 3, 6, 3, 3, 3, 6 ]
     48 */
     49 
     50 // MODULES //
     51 
     52 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
     53 var sample = require( './sample.js' );
     54 var factory = require( './factory.js' );
     55 
     56 
     57 // MAIN //
     58 
     59 setReadOnly( sample, 'factory', factory );
     60 
     61 
     62 // EXPORTS //
     63 
     64 module.exports = sample;