README

Logarithm of Cumulative Distribution Function

Degenerate distribution logarithm of cumulative distribution function.

The cumulative distribution function for a degenerate random variable is

Cumulative distribution function for a degenerate distribution.

where µ is the constant value of the distribution.

Installation

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

Usage

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

logcdf( x, mu )

Evaluates the natural logarithm of the CDF of a degenerate distribution centered at mu.

var y = logcdf( 2.0, 8.0 );
// returns -Infinity

y = logcdf( 8.0, 8.0 );
// returns 0.0

y = logcdf( 10.0, 8.0 );
// returns 0.0

logcdf.factory( mu )

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

var mylogcdf = logcdf.factory( 10.0 );

var y = mylogcdf( 10.0 );
// returns 0.0

y = mylogcdf( 8.0 );
// returns -Infinity

Examples

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

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 = logcdf( x, mu );
    console.log( 'x: %d, µ: %d, ln(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.

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

Usage no npm install needed!