All files / stats/base/dists/bradford/quantile/lib main.js

100% Statements 85/85
100% Branches 8/8
100% Functions 1/1
100% Lines 85/85

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 862x 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 3009x 3009x 3009x 3009x 3009x 3009x 3002x 3009x 9x 9x 3000x 3009x 2x 2x 2x 2x 2x  
/**
* @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 expm1 = require( '@stdlib/math/base/special/expm1' );
var log1p = require( '@stdlib/math/base/special/log1p' );
 
 
// MAIN //
 
/**
* Evaluates the quantile function for a Bradford distribution with shape parameter `c` at a probability `p`.
*
* @param {Probability} p - input value
* @param {PositiveNumber} c - shape parameter
* @returns {NonNegativeNumber} evaluated quantile function
*
* @example
* var y = quantile( 0.1, 0.1 );
* // returns ~0.096
*
* @example
* var y = quantile( 0.5, 5.0 );
* // returns ~0.290
*
* @example
* var y = quantile( 1.0, 10.0 );
* // returns 1.0
*
* @example
* var y = quantile( 0.5, 0.0 );
* // returns NaN
*
* @example
* var y = quantile( 2.0, 0.5 );
* // returns NaN
*
* @example
* var y = quantile( -1.0, 0.5 );
* // returns NaN
*
* @example
* var y = quantile( NaN, 1.0 );
* // returns NaN
*
* @example
* var y = quantile( 1.0, NaN );
* // returns NaN
*/
function quantile( p, c ) {
	if (
		isnan( c ) ||
		isnan( p ) ||
		c <= 0.0 ||
		p < 0.0 ||
		p > 1.0
	) {
		return NaN;
	}
	return expm1( p * log1p( c ) ) / c;
}
 
 
// EXPORTS //
 
module.exports = quantile;