@stdlib/stats-base-dists-kumaraswamy-quantile
v0.3.1
Published
Kumaraswamy's double bounded distribution quantile function.
Readme
Quantile Function
Kumaraswamy's double bounded distribution quantile function.
The quantile function for a Kumaraswamy's double bounded random variable is
for 0 <= p <= 1, where a > 0 is the first shape parameter and b > 0 is the second shape parameter.
Installation
npm install @stdlib/stats-base-dists-kumaraswamy-quantileUsage
var quantile = require( '@stdlib/stats-base-dists-kumaraswamy-quantile' );quantile( p, a, b )
Evaluates the quantile function for a Kumaraswamy's double bounded distribution with parameters a (first shape parameter) and b (second shape parameter).
var y = quantile( 0.5, 1.0, 1.0 );
// returns 0.5
y = quantile( 0.5, 2.0, 4.0 );
// returns ~0.399
y = quantile( 0.2, 2.0, 2.0 );
// returns ~0.325
y = quantile( 0.8, 4.0, 4.0 );
// returns ~0.759If provided a probability p outside the interval [0,1], the function returns NaN.
var y = quantile( -0.5, 4.0, 2.0 );
// returns NaN
y = quantile( 1.5, 4.0, 2.0 );
// returns NaNIf provided NaN as any argument, the function returns NaN.
var y = quantile( NaN, 1.0, 1.0 );
// returns NaN
y = quantile( 0.2, NaN, 1.0 );
// returns NaN
y = quantile( 0.2, 1.0, NaN );
// returns NaNIf provided a <= 0, the function returns NaN.
var y = quantile( 0.2, -1.0, 0.5 );
// returns NaN
y = quantile( 0.2, 0.0, 0.5 );
// returns NaNIf provided b <= 0, the function returns NaN.
var y = quantile( 0.2, 0.5, -1.0 );
// returns NaN
y = quantile( 0.2, 0.5, 0.0 );
// returns NaNquantile.factory( a, b )
Returns a function for evaluating the quantile function for a Kumaraswamy's double bounded distribution with parameters a (first shape parameter) and b (second shape parameter).
var myQuantile = quantile.factory( 0.5, 0.5 );
var y = myQuantile( 0.8 );
// returns ~0.922
y = myQuantile( 0.3 );
// returns ~0.26Examples
var uniform = require( '@stdlib/random-array-uniform' );
var EPS = require( '@stdlib/constants-float64-eps' );
var logEachMap = require( '@stdlib/console-log-each-map' );
var quantile = require( '@stdlib/stats-base-dists-kumaraswamy-quantile' );
var opts = {
'dtype': 'float64'
};
var p = uniform( 10, 0.0, 1.0, opts );
var a = uniform( 10, EPS, 5.0, opts );
var b = uniform( 10, EPS, 5.0, opts );
logEachMap( 'p: %0.4f, a: %0.4f, b: %0.4f, Q(p;a,b): %0.4f', p, a, b, quantile );C APIs
Usage
#include "stdlib/stats/base/dists/kumaraswamy/quantile.h"stdlib_base_dists_kumaraswamy_quantile( p, a, b )
Evaluates the quantile function of a Kumaraswamy's double bounded distribution with parameters a (first shape parameter) and b (second shape parameter).
double out = stdlib_base_dists_kumaraswamy_quantile( 0.5, 1.0, 1.0 );
// returns 0.5The function accepts the following arguments:
- p:
[in] doubleprobability. - a:
[in] doublefirst shape parameter. - b:
[in] doublesecond shape parameter.
double stdlib_base_dists_kumaraswamy_quantile( const double p, const double a, const double b );Examples
#include "stdlib/stats/base/dists/kumaraswamy/quantile.h"
#include "stdlib/constants/float64/eps.h"
#include <stdlib.h>
#include <stdio.h>
static double random_uniform( const double min, const double max ) {
double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
return min + ( v*(max-min) );
}
int main( void ) {
double p;
double a;
double b;
double y;
int i;
for ( i = 0; i < 25; i++ ) {
p = random_uniform( 0.0, 1.0 );
a = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 5.0 );
b = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 5.0 );
y = stdlib_base_dists_kumaraswamy_quantile( p, a, b );
printf( "p: %lf, a: %lf, b: %lf, Q(p;a,b): %lf\n", p, a, b, y );
}
}Notice
This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2026. The Stdlib Authors.
