@stdlib/stats-base-dists-cauchy-cdf
v0.3.1TypeScript
Cauchy distribution cumulative distribution function (CDF).
0/weekUpdated yesterdayApache-2.0Unpacked: 55.8 KB
Published by The Stdlib Authors
npm install @stdlib/stats-base-dists-cauchy-cdfWe 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!
About stdlib...
Cumulative Distribution Function
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> [Cauchy][cauchy-distribution] distribution [cumulative distribution function][cdf].
The [cumulative distribution function][cdf] for a [Cauchy][cauchy-distribution] random variable is
where x0 is the location parameter and gamma > 0 is the scale parameter.
Installation
``bash`
npm install @stdlib/stats-base-dists-cauchy-cdf
Usage
`javascript`
var cdf = require( '@stdlib/stats-base-dists-cauchy-cdf' );
#### cdf( x, x0, gamma )
Evaluates the [cumulative distribution function][cdf] (CDF) for a [Cauchy][cauchy-distribution] distribution with parameters x0 (location parameter) and gamma > 0 (scale parameter).
`javascript
var y = cdf( 4.0, 0.0, 2.0 );
// returns ~0.852
y = cdf( 1.0, 0.0, 2.0 );
// returns ~0.648
y = cdf( 1.0, 3.0, 2.0 );
// returns 0.25
`
If provided NaN as any argument, the function returns NaN.
`javascript
var y = cdf( NaN, 0.0, 2.0 );
// returns NaN
y = cdf( 1.0, 2.0, NaN );
// returns NaN
y = cdf( 1.0, NaN, 3.0 );
// returns NaN
`
If provided gamma <= 0, the function returns NaN.
`javascript
var y = cdf( 2.0, 0.0, -1.0 );
// returns NaN
y = cdf( 2.0, 0.0, 0.0 );
// returns NaN
`
#### cdf.factory( x0, gamma )
Returns a function for evaluating the [cumulative distribution function][cdf] of a [Cauchy][cauchy-distribution] distribution with parameters x0 (location parameter) and gamma > 0 (scale parameter).
`javascript
var mycdf = cdf.factory( 10.0, 2.0 );
var y = mycdf( 10.0 );
// returns 0.5
y = mycdf( 12.0 );
// returns 0.75
`
Examples
`javascript
var uniform = require( '@stdlib/random-array-uniform' );
var logEachMap = require( '@stdlib/console-log-each-map' );
var EPS = require( '@stdlib/constants-float64-eps' );
var cdf = require( '@stdlib/stats-base-dists-cauchy-cdf' );
var opts = {
'dtype': 'float64'
};
var gamma = uniform( 10, EPS, 10.0, opts );
var x0 = uniform( 10, 0.0, 10.0, opts );
var x = uniform( 10, 0.0, 10.0, opts );
logEachMap( 'x: %0.4f, x0: %0.4f, γ: %0.4f, F(x;x0,γ): %0.4f', x, x0, gamma, cdf );
`
*
C APIs
$3
`c`
#include "stdlib/stats/base/dists/cauchy/cdf.h"
#### stdlib_base_dists_cauchy_cdf( x, x0, gamma )
Evaluates the [cumulative distribution function][cdf] (CDF) for a [Cauchy][cauchy-distribution] distribution with parameters x0 (location parameter) and gamma > 0 (scale parameter).
`c`
double out = stdlib_base_dists_cauchy_cdf( 4.0, 0.0, 2.0 );
// returns ~0.852
The function accepts the following arguments:
- x: [in] double input value.[in] double
- x0: location parameter.[in] double
- gamma: scale parameter.
`c`
double stdlib_base_dists_cauchy_cdf( const double x, const double x0, const double gamma );
$3
`c
#include "stdlib/stats/base/dists/cauchy/cdf.h"
#include
#include
static double random_uniform( const double min, const double max ) {
double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
return min + ( v*(max-min) );
}
int main( void ) {
double gamma;
double x0;
double y;
double x;
int i;
for ( i = 0; i < 25; i++ ) {
x = random_uniform( 0.0, 10.0 );
x0 = random_uniform( 0.0, 10.0 );
gamma = random_uniform( 0.0, 10.0 );
y = stdlib_base_dists_cauchy_cdf( x, x0, gamma );
printf( "x: %lf, k: %lf, γ: %lf, F(x;x0,γ): %lf\n", x, x0, gamma, y );
}
}
`
*
Notice
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
License
See [LICENSE][stdlib-license].
Copyright
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-cauchy-cdf.svg
[npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-cauchy-cdf
[test-image]: https://github.com/stdlib-js/stats-base-dists-cauchy-cdf/actions/workflows/test.yml/badge.svg?branch=v0.3.1
[test-url]: https://github.com/stdlib-js/stats-base-dists-cauchy-cdf/actions/workflows/test.yml?query=branch:v0.3.1
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-cauchy-cdf/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-cauchy-cdf?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/stats-base-dists-cauchy-cdf/tree/deno
[deno-readme]: https://github.com/stdlib-js/stats-base-dists-cauchy-cdf/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/stats-base-dists-cauchy-cdf/tree/umd
[umd-readme]: https://github.com/stdlib-js/stats-base-dists-cauchy-cdf/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/stats-base-dists-cauchy-cdf/tree/esm
[esm-readme]: https://github.com/stdlib-js/stats-base-dists-cauchy-cdf/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/stats-base-dists-cauchy-cdf/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-dists-cauchy-cdf/main/LICENSE
[cdf]: https://en.wikipedia.org/wiki/Cumulative_distribution_function
[cauchy-distribution]: https://en.wikipedia.org/wiki/Cauchy_distribution