All files main.js

100% Statements 100/100
100% Branches 11/11
100% Functions 1/1
100% Lines 100/100

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 1012x 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 1008x 1008x 1008x 1008x 1008x 1008x 1008x 1008x 1005x 1008x 6x 6x 1002x 1002x 1002x 1008x 431x 431x 1008x 402x 402x 169x 169x 169x 1008x 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 sin = require( '@stdlib/math/base/special/sin' );
var PI = require( '@stdlib/constants/float64/pi' );
 
 
// VARIABLES //
 
var PI_OVER_4 = PI / 4.0;
 
 
// MAIN //
 
/**
* Evaluates the cumulative distribution function (CDF) for an anglit distribution with location parameter `mu` and scale parameter `sigma` at a value `x`.
*
* @param {number} x - input value
* @param {number} mu - location parameter
* @param {PositiveNumber} sigma - scale parameter
* @returns {Probability} evaluated CDF
*
* @example
* var y = cdf( 0.0, 0.0, 1.0 );
* // returns 0.5
*
* @example
* var y = cdf( 0.5, 0.0, 1.0 );
* // returns ~0.921
*
* @example
* var y = cdf( 2.0, 0.0, 1.0 );
* // returns 1.0
*
* @example
* var y = cdf( -2.0, 0.0, 1.0 );
* // returns 0.0
*
* @example
* var y = cdf( NaN, 0.0, 1.0 );
* // returns NaN
*
* @example
* var y = cdf( 0.0, NaN, 1.0 );
* // returns NaN
*
* @example
* var y = cdf( 0.0, 0.0, -1.0 );
* // returns NaN
*/
function cdf( x, mu, sigma ) {
	var y;
	var s;
 
	if (
		isnan( x ) ||
		isnan( mu ) ||
		isnan( sigma ) ||
		sigma <= 0.0
	) {
		return NaN;
	}
 
	// Transform x to the standardized form
	y = ( x - mu ) / sigma;
	if ( y <= -PI_OVER_4 ) {
		return 0.0;
	}
	if ( y >= PI_OVER_4 ) {
		return 1.0;
	}
 
	s = sin( y + PI_OVER_4 );
	return s * s;
}
 
 
// EXPORTS //
 
module.exports = cdf;