mode.js (1530B)
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 // MAIN // 22 23 /** 24 * Returns the mode of a beta prime distribution. 25 * 26 * @param {PositiveNumber} alpha - first shape parameter 27 * @param {PositiveNumber} beta - second shape parameter 28 * @returns {PositiveNumber} mode 29 * 30 * @example 31 * var v = mode( 1.0, 2.0 ); 32 * // returns 0.0 33 * 34 * @example 35 * var v = mode( 4.0, 12.0 ); 36 * // returns ~0.231 37 * 38 * @example 39 * var v = mode( 8.0, 2.0 ); 40 * // returns ~2.333 41 * 42 * @example 43 * var v = mode( 1.0, 1.0 ); 44 * // returns 0.0 45 * 46 * @example 47 * var v = mode( 1.0, -0.1 ); 48 * // returns NaN 49 * 50 * @example 51 * var v = mode( -0.1, 1.0 ); 52 * // returns NaN 53 * 54 * @example 55 * var v = mode( 2.0, NaN ); 56 * // returns NaN 57 * 58 * @example 59 * var v = mode( NaN, 2.0 ); 60 * // returns NaN 61 */ 62 function mode( alpha, beta ) { 63 if ( alpha <= 0.0 || beta <= 0.0 ) { 64 return NaN; 65 } 66 if ( alpha < 1.0 ) { 67 return 0.0; 68 } 69 return ( alpha - 1.0 ) / ( beta + 1.0 ); 70 } 71 72 73 // EXPORTS // 74 75 module.exports = mode;