main.js (1161B)
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 beta prime distributed random number. 30 * 31 * @name betaprime 32 * @type {PRNG} 33 * @param {PositiveNumber} alpha - first shape parameter 34 * @param {PositiveNumber} beta - second shape parameter 35 * @returns {PositiveNumber} pseudorandom number 36 * 37 * @example 38 * var r = betaprime( 2.0, 5.0 ); 39 * // returns <number> 40 * 41 * @example 42 * var r = betaprime( -2.0, 5.0 ); 43 * // returns NaN 44 */ 45 var betaprime = factory(); 46 47 48 // EXPORTS // 49 50 module.exports = betaprime;