@stdlib/stats-base-dists-lognormal-logcdf
TypeScript icon, indicating that this package has built-in type declarations

0.2.1 • Public • Published
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!

Logarithm of Cumulative Distribution Function

NPM version Build Status Coverage Status

Evaluate the natural logarithm of the cumulative distribution function (CDF) for a lognormal distribution.

Installation

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

Usage

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

logcdf( x, mu, sigma )

Evaluates the natural logarithm of the cumulative distribution function (CDF) for a lognormal distribution with parameters mu (mean) and sigma (standard deviation).

var y = logcdf( 2.0, 0.0, 1.0 );
// returns ~-0.2799

y = logcdf( 13.0, 4.0, 2.0 );
// returns ~-1.442

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

var y = logcdf( NaN, 0.0, 1.0 );
// returns NaN

y = logcdf( 0.0, NaN, 1.0 );
// returns NaN

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

If provided sigma < 0, the function returns NaN.

var y = logcdf( 2.0, 0.0, -1.0 );
// returns NaN

If provided sigma = 0, the function evaluates the natural logarithm of the CDF of a degenerate distribution centered at mu.

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

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

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

logcdf.factory( mu, sigma )

Returns a function for evaluating the cumulative distribution function (CDF) of a lognormal distribution with parameters mu (mean) and sigma (standard deviation).

var mylogcdf = logcdf.factory( 10.0, 2.0 );

var y = mylogcdf( 10.0 );
// returns ~-9.732

y = mylogcdf( 5.0 );
// returns ~-11.203

Examples

var randu = require( '@stdlib/random-base-randu' );
var logcdf = require( '@stdlib/stats-base-dists-lognormal-logcdf' );

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

for ( i = 0; i < 10; i++ ) {
    x = randu() * 10.0;
    mu = (randu() * 10.0) - 5.0;
    sigma = randu() * 20.0;
    y = logcdf( x, mu, sigma );
    console.log( 'x: %d, µ: %d, σ: %d, ln(F(x;µ,σ)): %d', x, mu, sigma, 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

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.

Package Sidebar

Install

npm i @stdlib/stats-base-dists-lognormal-logcdf

Homepage

stdlib.io

Weekly Downloads

74

Version

0.2.1

License

Apache-2.0

Unpacked Size

36.2 kB

Total Files

12

Last publish

Collaborators

  • stdlib-bot
  • kgryte
  • planeshifter
  • rreusser