All files factory.js

100% Statements 109/109
100% Branches 16/16
100% Functions 2/2
100% Lines 109/109

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 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 1103x 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 3x 3x 3x 3x 3x 3x 119x 119x 119x 119x 119x 108x 119x 12x 12x 119x 3x 3x 104x 104x 104x 104x 104x 104x 104x 104x 104x 104x 104x 104x 104x 104x 103x 103x 103x 103x 103x 103x 103x 1x 1x 103x 1x 1x 103x 1x 1x 100x 100x 100x 100x 100x 100x 100x 100x 100x 100x 103x 119x 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/logcdf' ).factory;
var erfcx = require( '@stdlib/math/base/special/erfcx' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var sqrt = require( '@stdlib/math/base/special/sqrt' );
var erfc = require( '@stdlib/math/base/special/erfc' );
var exp = require( '@stdlib/math/base/special/exp' );
var ln = require( '@stdlib/math/base/special/ln' );
var PINF = require( '@stdlib/constants/float64/pinf' );
var NINF = require( '@stdlib/constants/float64/ninf' );
 
 
// MAIN //
 
/**
* Returns a function for evaluating the natural logarithm of the cumulative distribution function (CDF) for a Wald distribution.
*
* @param {PositiveNumber} mu - mean
* @param {NonNegativeNumber} lambda - shape parameter
* @returns {Function} function to evaluate the natural logarithm of the cumulative distribution function
*
* @example
* var logcdf = factory( 1.0, 1.0 );
* var y = logcdf( 2.0 );
* // returns ~-0.122
*
* y = logcdf( 0.5 );
* // returns ~-1.008
*/
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 logcdf;
 
	/**
	* Evaluates the natural logarithm of the cumulative distribution function (CDF) of a Wald distribution.
	*
	* @private
	* @param {number} x - input value
	* @returns {number} evaluated logCDF
	*
	* @example
	* var y = logcdf( 2.0 );
	* // returns <number>
	*/
	function logcdf( x ) {
		var t1;
		var t2;
		var a;
		var b;
		var z;
 
		if ( isnan( x ) ) {
			return NaN;
		}
		if ( x <= 0.0 ) {
			return NINF;
		}
		if ( x === PINF ) {
			return 0.0;
		}
		z = sqrt( lambda / x );
		a = ( z * ( ( x / mu ) - 1.0 ) ) / sqrt( 2.0 );
		b = ( z * ( ( x / mu ) + 1.0 ) ) / sqrt( 2.0 );
 
		// Φ(a) = 0.5 * erfc( -a / √2 )
		t1 = 0.5 * erfc( -a );
 
		// exp( 2λ/μ ) * erfc( b ) = erfcx( b ) * exp( -a² ), as b² - a² = 2λ/μ; computing via `erfcx` avoids overflow of the exponential term for large `λ/μ`:
		t2 = 0.5 * erfcx( b ) * exp( -a * a );
		return ln( t1 + t2 );
	}
}
 
 
// EXPORTS //
 
module.exports = factory;