All files factory.js

100% Statements 77/77
100% Branches 14/14
100% Functions 2/2
100% Lines 77/77

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 783x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 1014x 1014x 8x 8x 1014x 1x 1x 1005x 1005x 1005x 1005x 1005x 1005x 1005x 1005x 1005x 1005x 1005x 1005x 1005x 1005x 1007x 5x 5x 1002x 1007x 1014x 3x 3x 3x 3x 3x  
/**
* @license Apache-2.0
*
* Copyright (c) 2026 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
 
'use strict';
 
// MODULES //
 
var constantFunction = require( '@stdlib/utils/constant-function' );
var degenerate = require( '@stdlib/stats/base/dists/degenerate/quantile' ).factory;
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var bisect = require( './bisect.js' );
 
 
// MAIN //
 
/**
* Returns a function for evaluating the quantile function for a Wald distribution.
*
* @param {PositiveNumber} mu - mean
* @param {NonNegativeNumber} lambda - shape parameter
* @returns {Function} quantile function
*
* @example
* var quantile = factory( 1.0, 1.0 );
* var y = quantile( 0.8 );
* // returns ~1.448
*
* y = quantile( 0.5 );
* // returns ~0.676
*/
function factory( mu, lambda ) {
	if ( isnan( mu ) || isnan( lambda ) || mu <= 0.0 || lambda < 0.0 ) {
		return constantFunction( NaN );
	}
	if ( lambda === 0.0 ) {
		return degenerate( mu );
	}
	return quantile;
 
	/**
	* Evaluates the quantile function for a Wald distribution.
	*
	* @private
	* @param {Probability} p - input value
	* @returns {NonNegativeNumber} evaluated quantile function
	*
	* @example
	* var y = quantile( 0.3 );
	* // returns <number>
	*/
	function quantile( p ) {
		if ( isnan( p ) || p < 0.0 || p > 1.0 ) {
			return NaN;
		}
		return bisect( p, mu, lambda );
	}
}
 
 
// EXPORTS //
 
module.exports = factory;