diff --git a/lib/node_modules/@stdlib/math/base/special/gammaincinv/lib/main.js b/lib/node_modules/@stdlib/math/base/special/gammaincinv/lib/main.js index be35fea57f4a..73011deb4d0b 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaincinv/lib/main.js +++ b/lib/node_modules/@stdlib/math/base/special/gammaincinv/lib/main.js @@ -59,8 +59,32 @@ var compute = require( './compute.js' ); * * @param {Probability} p - probability value * @param {number} a - scale parameter -* @param {boolean} [upper=false] - boolean indicating if the function should invert the upper tail of the incomplete gamma function instead; i.e., compute `xr` such that `Q(a,xr) = p`. +* @param {boolean} [upper=false] - boolean indicating if the function should invert the upper tail of the incomplete gamma function instead (i.e., compute `xr` such that `Q(a,xr) = p`) * @returns {number} function value of the inverse +* +* @example +* var y = gammaincinv( 0.5, 2.0 ); +* // returns ~1.678 +* +* @example +* var y = gammaincinv( 0.1, 10.0 ); +* // returns ~6.221 +* +* @example +* var y = gammaincinv( 0.75, 3.0 ); +* // returns ~3.92 +* +* @example +* var y = gammaincinv( 0.75, 3.0, true ); +* // returns ~1.727 +* +* @example +* var y = gammaincinv( 0.75, NaN ); +* // returns NaN +* +* @example +* var y = gammaincinv( NaN, 3.0 ); +* // returns NaN */ function gammaincinv( p, a, upper ) { if ( isnan( p ) || isnan( a ) ) {