npm.io
0.3.1 • Published 8 months ago

@stdlib/stats-base-dists-levy-logpdf

Licence
Apache-2.0
Version
0.3.1
Deps
8
Size
64 kB
Vulns
0
Weekly
0
Stars
2
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 Probability Density Function

NPM version Build Status Coverage Status

Lévy distribution logarithm of probability density function (PDF).

The probability density function (PDF) for a Lévy random variable is

Probability density function (PDF) for a Lévy distribution.

where μ is the location parameter and c > 0 is the scale parameter.

Installation

npm install @stdlib/stats-base-dists-levy-logpdf

Usage

var logpdf = require( '@stdlib/stats-base-dists-levy-logpdf' );
logpdf( x, mu, c )

Evaluates the logarithm of the probability density function (PDF) for a Lévy distribution with parameters mu (location parameter) and c (scale parameter).

var y = logpdf( 2.0, 0.0, 1.0 );
// returns ~-2.209

y = logpdf( -1.0, 4.0, 4.0 );
// returns -Infinity

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

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

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

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

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

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

y = logpdf( 2.0, 0.0, 0.0 );
// returns NaN
logpdf.factory( mu, c )

Returns a function for evaluating the logarithm of the probability density function (PDF) of a Lévy distribution with parameters mu (location parameter) and c (scale parameter).

var mylogpdf = logpdf.factory( 10.0, 2.0 );

var y = mylogpdf( 11.0 );
// returns ~-1.572

y = mylogpdf( 20.0 );
// returns ~-4.126

Notes

  • In virtually all cases, using the logpdf or logcdf functions is preferable to manually computing the logarithm of the pdf or cdf, respectively, since the latter is prone to overflow and underflow.

Examples

var randu = require( '@stdlib/random-base-randu' );
var EPS = require( '@stdlib/constants-float64-eps' );
var logpdf = require( '@stdlib/stats-base-dists-levy-logpdf' );

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

for ( i = 0; i < 10; i++ ) {
    mu = randu() * 10.0;
    x = ( randu()*10.0 ) + mu;
    c = ( randu()*10.0 ) + EPS;
    y = logpdf( x, mu, c );
    console.log( 'x: %d, µ: %d, c: %d, ln(f(x;µ,c)): %d', x, mu, c, y );
}

C APIs

Usage
#include "stdlib/stats/base/dists/levy/logpdf.h"
stdlib_base_dists_levy_logpdf( x, mu, c )

Evaluates the natural logarithm of the probability density function for a Lévy distribution with input value x, location parameter mu, and scale parameter c.

double out = stdlib_base_dists_levy_logpdf( 2.0, 0.0, 1.0 );
// returns ~-2.209

The function accepts the following arguments:

  • x: [in] double input value.
  • mu: [in] double location parameter.
  • c: [in] double scale parameter.
double stdlib_base_dists_levy_logpdf( const double x, const double mu, const double c );
Examples
#include "stdlib/stats/base/dists/levy/logpdf.h"
#include "stdlib/constants/float64/eps.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 mu;
    double x;
    double c;
    double y;
    int i;

    for ( i = 0; i < 25; i++ ) {
        mu = random_uniform( 0.0, 10.0 );
        x = random_uniform( mu, mu + 10.0 );
        c = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 20.0 );
        y = stdlib_base_dists_levy_logpdf( x, mu, c );
        printf( "x: %lf, µ: %lf, c: %lf, ln(f(x;µ,c)): %lf\n", x, mu, c, 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 2016-2026. The Stdlib Authors.

Keywords