All files / dists/bradford/cdf/lib main.js

86.36% Statements 76/88
100% Branches 1/1
0% Functions 0/1
86.36% Lines 76/88

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 891x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x                         1x 1x 1x 1x 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2025 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 log1p = require( '@stdlib/math/base/special/log1p' );
 
 
// MAIN //
 
/**
* Returns the cumulative distribution function (CDF) for a Bradford distribution with shape parameter `c` at a value `x`.
*
* @param {number} x - input value
* @param {PositiveNumber} c - shape parameter
* @returns {Probability} evaluated CDF
*
* @example
* var v = cdf( 0.1, 0.1 );
* // returns ~0.104
*
* @example
* var v = cdf( 0.5, 5.0 );
* // returns ~0.699
*
* @example
* var v = cdf( 1.0, 10.0 );
* // returns 1.0
*
* @example
* var v = cdf( -1.0, 0.5 );
* // returns 0.0
*
* @example
* var v = cdf( 2.0, 0.5 );
* // returns 1.0
*
* @example
* var v = cdf( 0.5, 0.0 );
* // returns NaN
*
* @example
* var v = cdf( 0.5, -5.0 );
* // returns NaN
*
* @example
* var v = cdf( NaN, 1.0 );
* // returns NaN
*
* @example
* var v = cdf( 1.0, NaN );
* // returns NaN
*/
function cdf( x, c ) {
	if ( isnan( c ) || isnan( x ) || c <= 0.0 ) {
		return NaN;
	}
	if ( x <= 0.0 ) {
		return 0.0;
	}
	if ( x >= 1.0 ) {
		return 1.0;
	}
	return log1p( c * x ) / log1p( c );
}
 
 
// EXPORTS //
 
module.exports = cdf;