About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
Cauchy distribution constructor.
import Cauchy from 'https://cdn.jsdelivr.net/gh/stdlib-js/stats-base-dists-cauchy-ctor@esm/index.mjs';
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
<!DOCTYPE html>
<html lang="en">
<body>
<script type="module">
import Cauchy from 'https://cdn.jsdelivr.net/gh/stdlib-js/stats-base-dists-cauchy-ctor@esm/index.mjs';
var cauchy = new Cauchy( 2.0, 4.0 );
var entropy = cauchy.entropy;
// returns ~3.917
var median = cauchy.median;
// returns 2.0
var mode = cauchy.mode;
// returns 2.0
var y = cauchy.cdf( 0.8 );
// returns ~0.407
</script>
</body>
</html>
This package is part of stdlib, a standard library 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-2025. The Stdlib Authors.