Skip to content

refactor: update math/base/special/atanh according to the FreeBSD implementation #6179

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: develop
Choose a base branch
from
Open

refactor: update math/base/special/atanh according to the FreeBSD implementation #6179

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
52b85a0
chore: refactor atanh implementation
Neerajpathak07 Mar 19, 2025
eac4d5d
chore: minor clean up
Neerajpathak07 Mar 19, 2025
2dc8d29
chore: add new var
Neerajpathak07 Mar 19, 2025
c83baa6
chore: pointer conversion
Neerajpathak07 Mar 19, 2025
6244749
chore: refactor native tests
Neerajpathak07 Mar 19, 2025
a2e6cd9
chore: refactor implementation
Neerajpathak07 Mar 19, 2025
80012d6
chore: adding case for x < 0.0
Neerajpathak07 Mar 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/math/base/special/atanh/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
*
* ## Notice
*
* The following copyright, license, and long comment were part of the original implementation available as part of [FreeBSD]{@link https://svnweb.freebsd.org/base/release/9.3.0/lib/msun/src/e_atanh.c?view=markup}. The implementation follows the original, but has been modified for JavaScript.
* The following copyright, license, and long comment were part of the original implementation available as part of [FreeBSD]{@link https://svnweb.freebsd.org/base/release/12.2.0/lib/msun/src/e_atanh.c?view=markup}. The implementation follows the original, but has been modified for JavaScript.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have updated the link to the new version of FreeBSD

*
* ```text
* Copyright (C) 2004 by Sun Microsystems, Inc. All rights reserved.
Expand Down
9 changes: 9 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/atanh/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@
"@stdlib/math/base/napi/unary",
"@stdlib/math/base/special/log1p",
"@stdlib/math/base/assert/is-nan",
"@stdlib/constants/float64/high-word-abs-mask",
"@stdlib/number/float64/base/set-high-word",
"@stdlib/number/float64/base/to-words",
"@stdlib/constants/float64/pinf",
"@stdlib/constants/float64/ninf"
]
Expand All @@ -56,6 +59,9 @@
"dependencies": [
"@stdlib/math/base/special/log1p",
"@stdlib/math/base/assert/is-nan",
"@stdlib/constants/float64/high-word-abs-mask",
"@stdlib/number/float64/base/set-high-word",
"@stdlib/number/float64/base/to-words",
"@stdlib/constants/float64/pinf",
"@stdlib/constants/float64/ninf"
]
Expand All @@ -73,6 +79,9 @@
"dependencies": [
"@stdlib/math/base/special/log1p",
"@stdlib/math/base/assert/is-nan",
"@stdlib/constants/float64/high-word-abs-mask",
"@stdlib/number/float64/base/set-high-word",
"@stdlib/number/float64/base/to-words",
"@stdlib/constants/float64/pinf",
"@stdlib/constants/float64/ninf"
]
Expand Down
33 changes: 25 additions & 8 deletions lib/node_modules/@stdlib/math/base/special/atanh/src/main.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@
#include "stdlib/math/base/special/atanh.h"
#include "stdlib/math/base/assert/is_nan.h"
#include "stdlib/math/base/special/log1p.h"
#include "stdlib/constants/float64/high_word_abs_mask.h"
#include "stdlib/number/float64/base/set_high_word.h"
#include "stdlib/number/float64/base/to_words.h"
#include "stdlib/constants/float64/pinf.h"
#include "stdlib/constants/float64/ninf.h"
#include <stdint.h>
Expand Down Expand Up @@ -79,34 +82,48 @@ static const double NEAR_ZERO = 1.0 / (1 << 28); // 2**-28
* // returns ~1.472
*/
double stdlib_base_atanh( const double x ) {
int32_t sgn;
uint32_t ahx;
uint32_t lx;
uint32_t hx;
double ax;
double t;

if ( stdlib_base_is_nan( x ) || x < -1.0 || x > 1.0 ) {
return 0.0 / 0.0; // NaN
}

// Split `x` into high and low words:
stdlib_base_float64_to_words( x, &hx, &lx );

ahx = hx & STDLIB_CONSTANT_FLOAT64_HIGH_WORD_ABS_MASK;

// special cases
if ( x == 1.0 ) {
return STDLIB_CONSTANT_FLOAT64_PINF;
}
if ( x == -1.0 ) {
return STDLIB_CONSTANT_FLOAT64_NINF;
}

if ( x < 0.0 ) {
sgn = 1;
hx = 1;
ax = -x;
} else {
sgn = 0;
hx = 0;
ax = x;
}
// Case: |x| < 2**-28
if ( ax < NEAR_ZERO ) {
return ( sgn == 1 ) ? -ax : ax;
return ( hx == 1 ) ? -ax : ax;
}
if ( ax < 0.5 ) {

stdlib_base_float64_set_high_word( ahx, &ax );

if( ax < 0.5 ) {
t = ax + ax;
t = 0.5 * stdlib_base_log1p( t + ( t * ax / ( 1 - ax ) ) );
t = 0.5 * stdlib_base_log1p( t + ( t * ax / ( 1.0 - ax ) ) );
} else {
t = 0.5 * stdlib_base_log1p( ( ax + ax ) / ( 1 - ax ) );
t = 0.5 * stdlib_base_log1p( ( ax + ax ) / ( 1.0 - ax ) );
}
return ( sgn == 1 ) ? -t : t;
return ( hx == 1 ) ? -t : t;
}