@stdlib/math-base-special-logaddexp

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!

logaddexp

Evaluates the natural logarithm of exp(x) + exp(y).

Log-domain computations are commonly used to increase accuracy and avoid underflow and overflow when very small or very large numbers are represented directly as limited-precision, floating-point numbers. For example, in statistics, evaluating logaddexp() is useful when probabilities are so small as to exceed the normal range of floating-point numbers.

Installation

npm install @stdlib/math-base-special-logaddexp

Usage

var logaddexp = require( '@stdlib/math-base-special-logaddexp' );

logaddexp( x, y )

Evaluates the natural logarithm of exp(x) + exp(y).

var v = logaddexp( 90.0, 90.0 );
// returns ~90.6931

v = logaddexp( -20.0, 90.0 );
// returns 90.0

v = logaddexp( 0.0, -100.0 );
// returns ~3.7201e-44

v = logaddexp( NaN, 1.0 );
// returns NaN

Examples

var incrspace = require( '@stdlib/array-base-incrspace' );
var logaddexp = require( '@stdlib/math-base-special-logaddexp' );

var x = incrspace( -100.0, 100.0, 1.0 );

var v;
var i;
var j;
for ( i = 0; i < x.length; i++ ) {
    for ( j = i; j < x.length; j++ ) {
        v = logaddexp( x[ i ], x[ j ] );
        console.log( 'x: %d, y: %d, f(x, y): %d', x[ i ], x[ j ], v );
    }
}

---

C APIs

Usage

#include "stdlib/math/base/special/logaddexp.h"

stdlib_base_logaddexp( x, y )

Evaluates the natural logarithm of exp(x) + exp(y).

double out = stdlib_base_logaddexp( 90.0, 90.0 );
// returns ~90.6931

out = stdlib_base_logaddexp( -20.0, 90.0 );
// returns 90.0

The function accepts the following arguments:

• x: [in] double input value.
• y: [in] double input value.

double stdlib_base_logaddexp( const double x, const double y );

Examples

#include "stdlib/math/base/special/logaddexp.h"
#include <stdlib.h>
#include <stdio.h>

int main( void ) {
    double x;
    double y;
    double v;
    int i;
    
    for ( i = 0; i < 100; i++ ) {
        x = ( ( (double)rand() / (double)RAND_MAX ) * 200.0 ) - 100.0;
        y = ( ( (double)rand() / (double)RAND_MAX ) * 200.0 ) - 100.0;
        v = stdlib_base_logaddexp( x, y );
        printf( "x: %lf, y: %lf, logaddexp(x, y): %lf\n", x, y, v );
    }
}

---

See Also

• @stdlib/math-base/special/exp: natural exponential function.
• @stdlib/math-base/special/ln: evaluate the natural logarithm of a double-precision floating-point number.

---

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-2024. The Stdlib Authors.