main.js (1605B)
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 compute = require( './assign.js' ); 24 25 26 // MAIN // 27 28 /** 29 * Evaluates the incomplete beta function and its first derivative. 30 * 31 * @param {Probability} x - function input 32 * @param {NonNegativeNumber} a - function parameter 33 * @param {NonNegativeNumber} b - function parameter 34 * @param {boolean} regularized - boolean indicating if the function should evaluate the regularized boolean beta function 35 * @param {boolean} upper - boolean indicating if the function should return the upper tail of the incomplete beta function instead 36 * @returns {Array} function value and first derivative 37 * 38 * @example 39 * var out = kernelBetainc( 0.5, 2.0, 2.0, false, false ); 40 * // returns [ ~0.083, ~1.5 ] 41 * 42 * @example 43 * var out = kernelBetainc( 0.2, 1.0, 2.0, true, false ); 44 * // returns [ 0.36, 1.6 ] 45 */ 46 function kernelBetainc( x, a, b, regularized, upper ) { 47 return compute( x, a, b, regularized, upper, [ 0.0, 0.0 ], 1, 0 ); 48 } 49 50 51 // EXPORTS // 52 53 module.exports = kernelBetainc;