JSPM

@stdlib/stats-base-dists-lognormal-stdev

0.0.2
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 322
  • Score
    100M100P100Q123304F
  • License Apache-2.0

Lognormal distribution standard deviation.

Package Exports

  • @stdlib/stats-base-dists-lognormal-stdev

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-lognormal-stdev) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Standard Deviation

NPM version Build Status Coverage Status dependencies

Lognormal distribution standard deviation.

The standard deviation for a lognormal random variable is

Standard deviation for a lognormal distribution.

where μ is the location parameter and σ > 0 is the scale parameter. According to the definition, the natural logarithm of a random variable from a lognormal distribution follows a normal distribution.

Installation

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

Usage

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

stdev( mu, sigma )

Returns the standard deviation for a lognormal distribution with location mu and scale sigma.

var y = stdev( 2.0, 1.0 );
// returns ~15.969

y = stdev( 0.0, 1.0 );
// returns ~2.161

y = stdev( -1.0, 2.0 );
// returns ~19.901

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

var y = stdev( NaN, 1.0 );
// returns NaN

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

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

var y = stdev( 0.0, 0.0 );
// returns NaN

y = stdev( 0.0, -1.0 );
// returns NaN

Examples

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

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

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

Copyright © 2016-2021. The Stdlib Authors.