main.js (1267B)
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 pseudorandom number drawn from an Erlang distribution. 30 * 31 * @name erlang 32 * @type {PRNG} 33 * @param {PositiveInteger} k - shape parameter 34 * @param {PositiveNumber} lambda - rate parameter 35 * @returns {number} pseudorandom number 36 * 37 * @example 38 * var v = erlang( 2, 1.0 ); 39 * // returns <number> 40 * 41 * @example 42 * var v = erlang( NaN, 1.0 ); 43 * // returns NaN 44 * 45 * v = erlang( 2, NaN ); 46 * // returns NaN 47 * 48 * v = erlang( 3.14, 1.0 ); 49 * // returns NaN 50 * 51 * v = erlang( 3, 0.0 ); 52 * // returns NaN 53 */ 54 var erlang = factory(); 55 56 57 // EXPORTS // 58 59 module.exports = erlang;