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

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!

Mode

Lognormal distribution mode.

The mode for a lognormal random variable is

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-mode

Usage

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

mode( mu, sigma )

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

var y = mode( 2.0, 1.0 );
// returns ~2.718

y = mode( 0.0, 1.0 );
// returns ~0.368

y = mode( -1.0, 4.0 );
// returns ~0.0

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

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

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

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

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

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

Examples

var uniform = require( '@stdlib/random-array-uniform' );
var logEachMap = require( '@stdlib/console-log-each-map' );
var mode = require( '@stdlib/stats-base-dists-lognormal-mode' );

var opts = {
    'dtype': 'float64'
};
var mu = uniform( 10, -5.0, 5.0, opts );
var sigma = uniform( 10, 0.0, 20.0, opts );

logEachMap( 'µ: %0.4f, σ: %0.4f, mode(X;µ,σ): %0.4f', mu, sigma, mode );

---

C APIs

Usage

#include "stdlib/stats/base/dists/lognormal/mode.h"

stdlib_base_dists_lognormal_mode( mu, sigma )

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

double out = stdlib_base_dists_lognormal_mode( 0.0, 1.0 );
// returns ~0.368

The function accepts the following arguments:

• mu: [in] double location parameter.
• sigma: [in] double scale parameter.

double stdlib_base_dists_lognormal_mode( const double mu, const double sigma );

Examples

#include "stdlib/stats/base/dists/lognormal/mode.h"
#include <stdlib.h>
#include <stdio.h>

static double random_uniform( const double min, const double max ) {
    double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
    return min + ( v*(max-min) );
}

int main( void ) {
    double sigma;
    double mu;
    double y;
    int i;

    for ( i = 0; i < 10; i++ ) {
        mu = random_uniform( -5.0, 5.0 );
        sigma = random_uniform( 0.1, 20.0 );
        y = stdlib_base_dists_lognormal_mode( mu, sigma );
        printf( "µ: %.4f, σ: %.4f, Mode(X;µ,σ): %.4f\n", 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

---

License

See LICENSE.

Copyright

Copyright 2016-2026. The Stdlib Authors.