time-to-botec/squiggle/node_modules/@stdlib/stats/base/dists/kumaraswamy/README.md
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

6.8 KiB

Kumaraswamy

Kumaraswamy's double bounded distribution.

Usage

var kumaraswamy = require( '@stdlib/stats/base/dists/kumaraswamy' );

kumaraswamy

Kumaraswamy's double bounded distribution.

var dist = kumaraswamy;
// returns {...}

The namespace contains the following distribution functions:

  • cdf( x, a, b ): Kumaraswamy's double bounded distribution cumulative distribution function.
  • logcdf( x, a, b ): evaluate the natural logarithm of the cumulative distribution function for a Kumaraswamy's double bounded distribution.
  • logpdf( x, a, b ): evaluate the natural logarithm of the probability density function for a Kumaraswamy's double bounded distribution.
  • pdf( x, a, b ): Kumaraswamy's double bounded distribution probability density function.
  • quantile( p, a, b ): Kumaraswamy's double bounded distribution quantile function.

The namespace contains the following functions for calculating distribution properties:

  • kurtosis( a, b ): Kumaraswamy's double bounded distribution excess kurtosis.
  • mean( a, b ): Kumaraswamy's double bounded distribution expected value.
  • median( a, b ): Kumaraswamy's double bounded distribution median.
  • mode( a, b ): Kumaraswamy's double bounded distribution mode.
  • skewness( a, b ): Kumaraswamy's double bounded distribution skewness.
  • stdev( a, b ): Kumaraswamy's double bounded distribution standard deviation.
  • variance( a, b ): Kumaraswamy's double bounded distribution variance.

The namespace contains a constructor function for creating a Kumaraswamy's double bounded distribution object.

var Kumaraswamy = require( '@stdlib/stats/base/dists/kumaraswamy' ).Kumaraswamy;

var dist = new Kumaraswamy( 2.0, 4.0 );

var y = dist.logpdf( 0.8 );
// returns ~-1.209

Examples

var objectKeys = require( '@stdlib/utils/keys' );
var kumaraswamy = require( '@stdlib/stats/base/dists/kumaraswamy' );

console.log( objectKeys( kumaraswamy ) );