diff --git a/lib/node_modules/@stdlib/math/base/special/logaddexp/README.md b/lib/node_modules/@stdlib/math/base/special/logaddexp/README.md new file mode 100644 index 000000000000..eb6a9aa8fb10 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/logaddexp/README.md @@ -0,0 +1,107 @@ +# logaddexp + +> Compute the function [logaddexp][logaddexp]. + +
+ +
+ +
+ +The [logaddexp][logaddexp] (logarithm of sum of exponentials) is defined as + +
+ Equation for logaddexp function +
+
+ +
+ +
+ +## Usage + +```javascript +var logaddexp = require( '@stdlib/math/base/special/logaddexp' ); +``` + +#### logaddexp( x1, x2 ) + +Evaluates the natural logarithm of the sum of exp(x1) and exp(x2) using anumerically stable formula. + +TODO + +```javascript +var v = logaddexp( 0.0, 0.0 ); +// returns the same value as ln( 2.0 ) + +v = logaddexp( 50.0, 0.0 ); +// returns the same value as ln( exp( 50.0 ) + 1.0) + +v = logaddexp( 50.0, Number.POSITIVE_INFINITY ); +// returns Number.POSITIVE_INFINITY + +v = logaddexp( 50.0, Number.POSITIVE_INFINITY ); +// returns Number.POSITIVE_INFINITY + +v = logaddexp( 50.0, Number.NaN ); +// returns Number.NaN + +v = logaddexp( Number.NEGATIVE_INFINITY, Number.POSITIVE_INFINITY ); +// returns Number.POSITIVE_INFINITY + +v = logaddexp( Number.NaN, Number.POSITIVE_INFINITY ); +// returns Number.NaN +``` + +
+ + + + + +
+ +
+ + + + + +
+ +## Examples + +```javascript +var linspace = require( '@stdlib/math/utils/linspace' ); +var logaddexp = require( '@stdlib/math/base/special/logaddexp' ); + +var x = linspace( 0.0, 5.0, 11 ); +var i; + +for ( i = 0; i < x.length; i++ ) { + console.log( logaddexp( x[ i ] ) ); +} +``` + +
+ + + + + +
+ +
+ + + + + + + + diff --git a/lib/node_modules/@stdlib/math/base/special/logaddexp/docs/img/eq_logaddexp.svg b/lib/node_modules/@stdlib/math/base/special/logaddexp/docs/img/eq_logaddexp.svg new file mode 100644 index 000000000000..b727d544b532 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/logaddexp/docs/img/eq_logaddexp.svg @@ -0,0 +1,28 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + +