time-to-botec/squiggle/node_modules/@stdlib/stats/base/dists/cauchy/README.md

Cauchy

Cauchy distribution.

Usage

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

cauchy

Cauchy distribution.

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

The namespace contains the following distribution functions:

• cdf( x, x0, gamma ): Cauchy distribution cumulative distribution function.
• logcdf( x, x0, gamma ): Cauchy distribution logarithm of cumulative distribution function.
• logpdf( x, x0, gamma ): Cauchy distribution logarithm of probability density function (logPDF).
• pdf( x, x0, gamma ): Cauchy distribution probability density function (PDF).
• quantile( p, x0, gamma ): Cauchy distribution quantile function.

The namespace contains the following functions for calculating distribution properties:

• entropy( x0, gamma ): Cauchy distribution differential entropy.
• median( x0, gamma ): Cauchy distribution median.
• mode( x0, gamma ): Cauchy distribution mode.

The namespace contains a constructor function for creating a Cauchy distribution object.

• Cauchy( [x0, gamma] ): Cauchy distribution constructor.

var Cauchy = require( '@stdlib/stats/base/dists/cauchy' ).Cauchy;

var dist = new Cauchy( 2.0, 4.0 );

var median = dist.median;
// returns 2.0

Examples

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

console.log( objectKeys( cauchy ) );