Package Exports

@stdlib/stats-base-dists-cauchy-mode

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/stats-base-dists-cauchy-mode) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Mode

Cauchy distribution mode.

The mode for a Cauchy random variable with location parameter x0 and scale parameter Ɣ > 0 is

Installation

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

Usage

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

mode( x0, gamma )

Returns the mode of a Cauchy distribution with location parameter x0 and scale parameter gamma.

var v = mode( 10.0, 5.0 );
// returns 10.0

v = mode( 7.0, 2.0 );
// returns 7.0

If provided NaN as any argument, the function returns NaN.

var v = mode( NaN, 5.0 );
// returns NaN

v = mode( 20.0, NaN );
// returns NaN

If provided gamma <= 0, the function returns NaN.

var v = mode( 1.0, -1.0 );
// returns NaN

v = mode( 1.0, 0.0 );
// returns NaN

Examples

var randu = require( '@stdlib/random-base-randu' );
var EPS = require( '@stdlib/constants-float64-eps' );
var mode = require( '@stdlib/stats-base-dists-cauchy-mode' );

var gamma;
var x0;
var v;
var i;

for ( i = 0; i < 10; i++ ) {
    x0 = randu() * 100.0;
    gamma = ( randu()*10.0 ) + EPS;
    v = mode( x0, gamma );
    console.log( 'x0: %d, γ: %d, mode(X;x0,γ): %d', x0.toFixed( 4 ), gamma.toFixed( 4 ), v.toFixed( 4 ) );
}

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.

License

See LICENSE.

@stdlib/stats-base-dists-cauchy-mode