@stdlib/stats-base-dists-cauchy NPM

Cauchy

Cauchy distribution.

Installation

npm install @stdlib/stats-base-dists-cauchy

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 ) );

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.