All files main.js

100% Statements 103/103
100% Branches 15/15
100% Functions 1/1
100% Lines 103/103

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 1042x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 119x 119x 119x 119x 119x 119x 119x 108x 119x 12x 12x 119x 5x 5x 119x 2x 2x 100x 100x 119x 2x 2x 2x 2x 2x  
/**
* @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 isnan = require( '@stdlib/math/base/assert/is-nan' );
var ln = require( '@stdlib/math/base/special/ln' );
var LN_TWO_PI = require( '@stdlib/constants/float64/ln-two-pi' );
var PINF = require( '@stdlib/constants/float64/pinf' );
var NINF = require( '@stdlib/constants/float64/ninf' );
 
 
// MAIN //
 
/**
* Evaluates the natural logarithm of the probability density function (PDF) for a Wald distribution with mean `mu` and shape parameter `lambda` at a value `x`.
*
* @param {number} x - input value
* @param {PositiveNumber} mu - mean
* @param {NonNegativeNumber} lambda - shape parameter
* @returns {number} evaluated logPDF
*
* @example
* var y = logpdf( 2.0, 1.0, 1.0 );
* // returns ~-2.209
*
* @example
* var y = logpdf( 0.5, 2.0, 3.0 );
* // returns ~-1.017
*
* @example
* var y = logpdf( NaN, 1.0, 1.0 );
* // returns NaN
*
* @example
* var y = logpdf( 1.0, NaN, 1.0 );
* // returns NaN
*
* @example
* var y = logpdf( 1.0, 1.0, NaN );
* // returns NaN
*
* @example
* // Non-positive mean:
* var y = logpdf( 2.0, 0.0, 1.0 );
* // returns NaN
*
* @example
* // Negative shape parameter:
* var y = logpdf( 2.0, 1.0, -1.0 );
* // returns NaN
*
* @example
* // Zero shape parameter (degenerate distribution):
* var y = logpdf( 1.0, 1.0, 0.0 );
* // returns Infinity
*
* @example
* var y = logpdf( 0.0, 1.0, 1.0 );
* // returns -Infinity
*/
function logpdf( x, mu, lambda ) {
	var v;
	if (
		isnan( x ) ||
		isnan( mu ) ||
		isnan( lambda ) ||
		mu <= 0.0 ||
		lambda < 0.0
	) {
		return NaN;
	}
	if ( lambda === 0.0 ) {
		return ( x === mu ) ? PINF : NINF;
	}
	if ( x <= 0.0 || x === PINF ) {
		return NINF;
	}
	v = x - mu;
	return 0.5 * ( ln( lambda ) - ( LN_TWO_PI + ( 3.0 * ln( x ) ) ) - ( ( lambda * v * v ) / ( mu * mu * x ) ) );
}
 
 
// EXPORTS //
 
module.exports = logpdf;