time-to-botec

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

main.js (1662B)

      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 * Generates a binomially distributed random number.
     30 *
     31 * ## Method
     32 *
     33 * -   For \\(np < 10\\), the function generates Bernoulli random variates and returns their sum.
     34 * -   For \\(np \geq 10\\), the function uses the [BTRD algorithm][@hormann:1993a].
     35 *
     36 * ## References
     37 *
     38 * -   Hörmann, Wolfgang. 1993. "The generation of binomial random variates." _Journal of Statistical Computation and Simulation_ 46 (1-2): 101–10. doi:[10.1080/00949659308811496][@hormann:1993a].
     39 *
     40 * [@hormann:1993a]: http://dx.doi.org/10.1080/00949659308811496
     41 *
     42 * @name binomial
     43 * @type {PRNG}
     44 * @param {PositiveInteger} n - number of trials
     45 * @param {Probability} p - success probability
     46 * @throws {TypeError} `n` must be a positive integer
     47 * @throws {TypeError} `p` must be a probability
     48 * @returns {NonNegativeInteger} pseudorandom number
     49 *
     50 * @example
     51 * var r = binomial( 20, 0.8 );
     52 * // returns <number>
     53 */
     54 var binomial = factory();
     55 
     56 
     57 // EXPORTS //
     58 
     59 module.exports = binomial;