From bcb36392bd0195faab7d0a84cde614a8fcdd1c37 Mon Sep 17 00:00:00 2001 From: acavarero Date: Thu, 31 Aug 2017 21:01:41 +0200 Subject: [PATCH 1/6] logaddexp: README.md --- .../math/base/special/logaddexp/README.md | 76 +++++++++++++++++++ 1 file changed, 76 insertions(+) create mode 100644 lib/node_modules/@stdlib/math/base/special/logaddexp/README.md 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..5800489ed133 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/logaddexp/README.md @@ -0,0 +1,76 @@ +# logaddexp + +> Compute the [logaddexp][logaddexp] function of two numbers. + +
+ +The [logaddexp][logaddexp] function is defined as + + + +
+ Inverse half-value versed sine. +
+
+ + + +
+ + + +
+ +## Usage + +```javascript +var sin = require( '@stdlib/math/base/special/sin' ); +``` + +#### sin( x ) + +Computes the [sine][sine] of a `number` (in radians). + +```javascript +var v = sin( 0.0 ); +// returns ~0.0 + +v = sin( Math.PI/2.0 ); +// returns ~1.0 + +v = sin( -Math.PI/6.0 ); +// returns ~-0.5 +``` + +
+ + + +
+ +## Examples + +```javascript +var linspace = require( '@stdlib/math/utils/linspace' ); +var TWO_PI = require( '@stdlib/math/constants/float64-two-pi' ); +var sin = require( '@stdlib/math/base/special/sin' ); + +var x = linspace( 0.0, TWO_PI, 100 ); +var i; + +for ( i = 0; i < x.length; i++ ) { + console.log( sin( x[ i ] ) ); +} +``` + +
+ + + +
+ +[logaddexp]: https://en.wikipedia.org/wiki/LogSumExp + +
+ + From 33c4df5ed989cec30373626122e852fb4091d17f Mon Sep 17 00:00:00 2001 From: acavarero Date: Sat, 23 Sep 2017 12:44:49 +0200 Subject: [PATCH 2/6] add image for doc --- .../special/logaddexp/docs/img/eq_logaddexp.gif | Bin 0 -> 487 bytes 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 lib/node_modules/@stdlib/math/base/special/logaddexp/docs/img/eq_logaddexp.gif diff --git a/lib/node_modules/@stdlib/math/base/special/logaddexp/docs/img/eq_logaddexp.gif b/lib/node_modules/@stdlib/math/base/special/logaddexp/docs/img/eq_logaddexp.gif new file mode 100644 index 0000000000000000000000000000000000000000..3601e1df137b64a1ac25a9d04abf195caf55e26e GIT binary patch literal 487 zcmVrKFf1OEn+I%i5G*H-Q+4uaJg%~>#E|e> zvJ*rB3^4RQYuz_AU&a9pli*+(KobgV3sxNoh6?}>gamaRM@ohXh>Bc+6%3Y66)pw@ zL1_dm4KQ~UZk+%Lp`lQWAdew#1gWcJX$>P5cLjtJqY`Qpdm{(|bEOgsJq(Q%u5=&D z63iO{8qE>`5(1?LXxVcPZvi8F&S(e(xfTx#4WEwK=fLV0+y@7l6bB;%`aEd@1bIMC z!UH}4%uy)N;M6)F4HQUJ;K0E|1+ywJba;gy0BM!m0`y9t4Zr||00`s=7O)o^Q}SBA z1Q16g0xJSaN^k&!Kqd!JN)>zf@CvLALn#zJv8GrXDunz^kTgc*gh3P>)G+`L%+U>6 zCva7QNdhZj4F|k2>t{f>wdpv{{E8uzo24N9fbppm(ad;%J$zdt&RN&MN)dB-uoeUX dGzkVz$f3Bh2ON+HxX5TBgXPZ~L`;YP06SDhu>Sx6 literal 0 HcmV?d00001 From b6b35d333f7c10dc2cb6a0ed8cd0fd448b42f74c Mon Sep 17 00:00:00 2001 From: acavarero Date: Sat, 23 Sep 2017 15:13:22 +0200 Subject: [PATCH 3/6] new image for doc --- .../logaddexp/docs/img/eq_logaddexp.gif | Bin 487 -> 0 bytes .../logaddexp/docs/img/eq_logaddexp.svg | 28 ++++++++++++++++++ 2 files changed, 28 insertions(+) delete mode 100644 lib/node_modules/@stdlib/math/base/special/logaddexp/docs/img/eq_logaddexp.gif create mode 100644 lib/node_modules/@stdlib/math/base/special/logaddexp/docs/img/eq_logaddexp.svg diff --git a/lib/node_modules/@stdlib/math/base/special/logaddexp/docs/img/eq_logaddexp.gif b/lib/node_modules/@stdlib/math/base/special/logaddexp/docs/img/eq_logaddexp.gif deleted file mode 100644 index 3601e1df137b64a1ac25a9d04abf195caf55e26e..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 487 zcmVrKFf1OEn+I%i5G*H-Q+4uaJg%~>#E|e> zvJ*rB3^4RQYuz_AU&a9pli*+(KobgV3sxNoh6?}>gamaRM@ohXh>Bc+6%3Y66)pw@ zL1_dm4KQ~UZk+%Lp`lQWAdew#1gWcJX$>P5cLjtJqY`Qpdm{(|bEOgsJq(Q%u5=&D z63iO{8qE>`5(1?LXxVcPZvi8F&S(e(xfTx#4WEwK=fLV0+y@7l6bB;%`aEd@1bIMC z!UH}4%uy)N;M6)F4HQUJ;K0E|1+ywJba;gy0BM!m0`y9t4Zr||00`s=7O)o^Q}SBA z1Q16g0xJSaN^k&!Kqd!JN)>zf@CvLALn#zJv8GrXDunz^kTgc*gh3P>)G+`L%+U>6 zCva7QNdhZj4F|k2>t{f>wdpv{{E8uzo24N9fbppm(ad;%J$zdt&RN&MN)dB-uoeUX dGzkVz$f3Bh2ON+HxX5TBgXPZ~L`;YP06SDhu>Sx6 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..358b114cbba0 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/logaddexp/docs/img/eq_logaddexp.svg @@ -0,0 +1,28 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + From da55eef6305447e20dd4736e2e9bf6d5a8379465 Mon Sep 17 00:00:00 2001 From: acavarero Date: Sun, 24 Sep 2017 23:26:16 +0200 Subject: [PATCH 4/6] try relative links to image --- .../math/base/special/logaddexp/README.md | 68 +++++++++++-------- 1 file changed, 38 insertions(+), 30 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/logaddexp/README.md b/lib/node_modules/@stdlib/math/base/special/logaddexp/README.md index 5800489ed133..ef89dc45a447 100644 --- a/lib/node_modules/@stdlib/math/base/special/logaddexp/README.md +++ b/lib/node_modules/@stdlib/math/base/special/logaddexp/README.md @@ -1,75 +1,83 @@ # logaddexp -> Compute the [logaddexp][logaddexp] function of two numbers. +> Compute the function [logaddexp][logaddexp].
-The [logaddexp][logaddexp] function is defined as +
+ +
- +The [logaddexp][logaddexp] (logarithm of sum of exponentials) is defined as -
- Inverse half-value versed sine. + +![Equation for logaddexp function](docs/img/eq_logaddexp.svg) + +
+ Equation for logaddexp function
- -
- -
## Usage ```javascript -var sin = require( '@stdlib/math/base/special/sin' ); +var logaddexp = require( '@stdlib/math/base/special/logaddexp' ); ``` -#### sin( x ) +#### logaddexp( x1, x2 ) -Computes the [sine][sine] of a `number` (in radians). +TODO ```javascript -var v = sin( 0.0 ); -// returns ~0.0 - -v = sin( Math.PI/2.0 ); -// returns ~1.0 - -v = sin( -Math.PI/6.0 ); -// returns ~-0.5 +var v = todo( 0.0 ); +// returns TODO ```
+ + +
+ +
+ + + + +
## Examples ```javascript -var linspace = require( '@stdlib/math/utils/linspace' ); -var TWO_PI = require( '@stdlib/math/constants/float64-two-pi' ); -var sin = require( '@stdlib/math/base/special/sin' ); - -var x = linspace( 0.0, TWO_PI, 100 ); -var i; +var todo = require( '@stdlib/' ); -for ( i = 0; i < x.length; i++ ) { - console.log( sin( x[ i ] ) ); -} +todo(); ```
+ + +
+ +
+ + + + +
-[logaddexp]: https://en.wikipedia.org/wiki/LogSumExp +[logaddexp]: https://en.wikipedia.org/wiki/LogSumExp
From de26bc9ed33816aadc3888877abf2b5c0f857a77 Mon Sep 17 00:00:00 2001 From: acavarero Date: Mon, 25 Sep 2017 18:09:22 +0200 Subject: [PATCH 5/6] correct relative link to image --- .../math/base/special/logaddexp/README.md | 27 +++++++++++++++---- .../logaddexp/docs/img/eq_logaddexp.svg | 8 +++--- 2 files changed, 26 insertions(+), 9 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/logaddexp/README.md b/lib/node_modules/@stdlib/math/base/special/logaddexp/README.md index ef89dc45a447..0cafefaae313 100644 --- a/lib/node_modules/@stdlib/math/base/special/logaddexp/README.md +++ b/lib/node_modules/@stdlib/math/base/special/logaddexp/README.md @@ -10,9 +10,6 @@ The [logaddexp][logaddexp] (logarithm of sum of exponentials) is defined as - -![Equation for logaddexp function](docs/img/eq_logaddexp.svg) -
Equation for logaddexp function
@@ -30,11 +27,31 @@ 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 = todo( 0.0 ); -// returns TODO +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 ``` 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 index 358b114cbba0..b727d544b532 100644 --- 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 @@ -1,6 +1,6 @@ - + @@ -12,7 +12,7 @@ - + @@ -22,7 +22,7 @@ - - + + From b4065b90b6094fa3df0d99a6c96117f29e38d6e7 Mon Sep 17 00:00:00 2001 From: acavarero Date: Mon, 25 Sep 2017 21:13:03 +0200 Subject: [PATCH 6/6] README --- .../@stdlib/math/base/special/logaddexp/README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/logaddexp/README.md b/lib/node_modules/@stdlib/math/base/special/logaddexp/README.md index 0cafefaae313..eb6a9aa8fb10 100644 --- a/lib/node_modules/@stdlib/math/base/special/logaddexp/README.md +++ b/lib/node_modules/@stdlib/math/base/special/logaddexp/README.md @@ -73,9 +73,15 @@ v = logaddexp( Number.NaN, Number.POSITIVE_INFINITY ); ## Examples ```javascript -var todo = require( '@stdlib/' ); +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; -todo(); +for ( i = 0; i < x.length; i++ ) { + console.log( logaddexp( x[ i ] ) ); +} ```