time-to-botec

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

index.js (1518B)

      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 * Geometric distributed pseudorandom numbers.
     23 *
     24 * @module @stdlib/random/base/geometric
     25 *
     26 * @example
     27 * var geometric = require( '@stdlib/random/base/geometric' );
     28 *
     29 * var v = geometric( 0.5 );
     30 * // returns <number>
     31 *
     32 * @example
     33 * var factory = require( '@stdlib/random/base/geometric' ).factory;
     34 *
     35 * var geometric = factory( 0.3, {
     36 *     'seed': 297
     37 * });
     38 *
     39 * var v = geometric();
     40 * // returns <number>
     41 *
     42 * @example
     43 * var factory = require( '@stdlib/random/base/geometric' ).factory;
     44 *
     45 * var geometric = factory({
     46 *     'seed': 297
     47 * });
     48 *
     49 * var v = geometric( 0.5 );
     50 * // returns <number>
     51 */
     52 
     53 // MODULES //
     54 
     55 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
     56 var geometric = require( './main.js' );
     57 var factory = require( './factory.js' );
     58 
     59 
     60 // MAIN //
     61 
     62 setReadOnly( geometric, 'factory', factory );
     63 
     64 
     65 // EXPORTS //
     66 
     67 module.exports = geometric;