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

Alternatively,

• To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
• If you are using Deno, visit the deno branch (see README for usage intructions).
• For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

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

Returns a Cauchy distribution object.

var cauchy = new Cauchy();

var median = cauchy.median;
// returns 0.0

By default, x0 = 0.0 and gamma = 1.0. To create a distribution having a different x0 (location parameter) and gamma (scale parameter), provide the corresponding arguments.

var cauchy = new Cauchy( 2.0, 4.0 );

var median = cauchy.median;
// returns 2.0

A Cauchy distribution object has the following properties and methods...

Location parameter of the distribution.

var cauchy = new Cauchy();

var x0 = cauchy.x0;
// returns 0.0

cauchy.x0 = 3.0;

x0 = cauchy.x0;
// returns 3.0

Scale parameter of the distribution. gamma must be a positive number.

var cauchy = new Cauchy( 2.0, 4.0 );

var gamma = cauchy.gamma;
// returns 4.0

cauchy.gamma = 3.0;

gamma = cauchy.gamma;
// returns 3.0

Returns the differential entropy.

var cauchy = new Cauchy( 4.0, 12.0 );

var entropy = cauchy.entropy;
// returns ~5.016

Returns the median.

var cauchy = new Cauchy( 4.0, 12.0 );

var median = cauchy.median;
// returns 4.0

Returns the mode.

var cauchy = new Cauchy( 4.0, 12.0 );

var mode = cauchy.mode;
// returns 4.0

Evaluates the cumulative distribution function (CDF).

var cauchy = new Cauchy( 2.0, 4.0 );

var y = cauchy.cdf( 0.5 );
// returns ~0.386

Evaluates the natural logarithm of the cumulative distribution function (CDF).

var cauchy = new Cauchy( 2.0, 4.0 );

var y = cauchy.logcdf( 0.5 );
// returns ~-0.952

Evaluates the natural logarithm of the probability density function (PDF).

var cauchy = new Cauchy( 2.0, 4.0 );

var y = cauchy.logpdf( 0.8 );
// returns ~-2.617

Evaluates the probability density function (PDF).

var cauchy = new Cauchy( 2.0, 4.0 );

var y = cauchy.pdf( 0.8 );
// returns ~0.073

Evaluates the quantile function at probability p.

var cauchy = new Cauchy( 2.0, 4.0 );

var y = cauchy.quantile( 0.5 );
// returns 2.0

y = cauchy.quantile( 1.9 );
// returns NaN

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.

See LICENSE.

Copyright © 2016-2024. The Stdlib Authors.