All files factory.js

100% Statements 83/83
100% Branches 8/8
100% Functions 2/2
100% Lines 83/83

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 843x 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 18x 18x 18x 16x 18x 5x 5x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 12x 12x 1x 1x 11x 11x 11x 12x 18x 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 isnan = require( '@stdlib/math/base/assert/is-nan' );
var ln = require( '@stdlib/math/base/special/ln' );
var erf = require( '@stdlib/math/base/special/erf' );
var NINF = require( '@stdlib/constants/float64/ninf' );
var SQRT2 = require( '@stdlib/constants/float64/sqrt-two' );
 
 
// VARIABLES //
 
var INV_SQRT_TWO = 1.0 / SQRT2;
 
 
// MAIN //
 
/**
* Returns a function for evaluating the natural logarithm of the cumulative distribution function (CDF) for a half-normal distribution.
*
* @param {PositiveNumber} sigma - scale parameter
* @returns {Function} logcdf
*
* @example
* var logcdf = factory( 2.0 );
* var y = logcdf( 1.0 );
* // returns ~-0.960
*
* y = logcdf( -1.0 );
* // returns -Infinity
*/
function factory( sigma ) {
	if (
		isnan( sigma ) ||
		sigma <= 0.0
	) {
		return constantFunction( NaN );
	}
 
	return logcdf;
 
	/**
	* Evaluate the natural logarithm of the cumulative distribution function (CDF) for a half-normal distribution.
	*
	* @private
	* @param {number} x - input value
	* @returns {number} evaluated logcdf
	*/
	function logcdf( x ) {
		var z;
		if ( x < 0.0 ) {
			return NINF;
		}
		z = x / sigma;
 
		return ln( erf( z * INV_SQRT_TWO ) );
	}
}
 
 
// EXPORTS //
 
module.exports = factory;