index.js (1233B)
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 /** 22 * Evaluate the incomplete gamma function. 23 * 24 * @module @stdlib/math/base/special/gammainc 25 * 26 * @example 27 * var gammainc = require( '@stdlib/math/base/special/gammainc' ); 28 * 29 * var v = gammainc( 6.0, 2.0 ); 30 * // returns ~0.9826 31 * 32 * v = gammainc( 1.0, 2.0, true, true ); 33 * // returns ~0.7358 34 * 35 * v = gammainc( 7.0, 5.0 ); 36 * // returns ~0.8270 37 * 38 * v = gammainc( 7.0, 5.0, false ); 39 * // returns ~19.8482 40 * 41 * v = gammainc( NaN, 2.0 ); 42 * // returns NaN 43 * 44 * v = gammainc( 6.0, NaN ); 45 * // returns NaN 46 */ 47 48 // MODULES // 49 50 var gammainc = require( './gammainc.js' ); 51 52 53 // EXPORTS // 54 55 module.exports = gammainc;