@stdlib/stats-base-dists-degenerate-cdf

Cumulative Distribution Function

Degenerate distribution cumulative distribution function.

The cumulative distribution function for a degenerate random variable is

where µ is the constant value of the distribution.

Installation

npm install @stdlib/stats-base-dists-degenerate-cdf

Usage

var cdf = require( '@stdlib/stats-base-dists-degenerate-cdf' );

cdf( x, mu )

Evaluates the CDF of a degenerate distribution centered at mu.

var y = cdf( 2.0, 8.0 );
// returns 0.0

y = cdf( 8.0, 8.0 );
// returns 1.0

y = cdf( 10.0, 8.0 );
// returns 1.0

cdf.factory( mu )

Returns a function for evaluating the cumulative distribution function of a degenerate distribution centered at mu.

var mycdf = cdf.factory( 10.0 );

var y = mycdf( 10.0 );
// returns 1.0

y = mycdf( 8.0 );
// returns 0.0

Examples

var randu = require( '@stdlib/random-base-randu' );
var round = require( '@stdlib/math-base-special-round' );
var cdf = require( '@stdlib/stats-base-dists-degenerate-cdf' );

var mu;
var x;
var y;
var i;

for ( i = 0; i < 100; i++ ) {
    x = round( randu()*10.0 );
    mu = round( randu()*10.0 );
    y = cdf( x, mu );
    console.log( 'x: %d, µ: %d, F(x;µ): %d', x, mu, y );
}

---

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.

Community

---

License

See LICENSE.

Copyright

Copyright © 2016-2021. The Stdlib Authors.

Changelog

0.0.6 (2021-08-22)

No changes reported for this release.

</section> <!-- /.release --> <section class="release" id="v0.0.5">