Skip to content

refactor: use constants/float64/nan and clean-up #13585

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

Merged
kgryte merged 4 commits into from
Jul 20, 2026
Merged

refactor: use constants/float64/nan and clean-up #13585

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
684a36f
refactor: use `constants/float64/nan` across `math/base/special`
claude Jul 20, 2026
dfb2724
chore: flatten `arrays` parameter description in `blas` ndarray READMEs
claude Jul 20, 2026
504abdd
style: remove stale `eslint-disable max-len` directives in READMEs
claude Jul 20, 2026
0932739
refactor: exclude `math/base/special/gamma` from NaN propagation
claude Jul 20, 2026
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
4 changes: 1 addition & 3 deletions lib/node_modules/@stdlib/blas/base/ndarray/dnrm2/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,7 @@ var y = dnrm2( [ x ] );

The function has the following parameters:

- **arrays**: array-like object containing the following ndarrays:

- a one-dimensional input ndarray.
- **arrays**: array-like object containing a one-dimensional input ndarray.

</section>

Expand Down
4 changes: 1 addition & 3 deletions lib/node_modules/@stdlib/blas/base/ndarray/dzasum/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,7 @@ var y = dzasum( [ x ] );

The function has the following parameters:

- **arrays**: array-like object containing the following ndarrays:

- a one-dimensional input ndarray.
- **arrays**: array-like object containing a one-dimensional input ndarray.

</section>

Expand Down
4 changes: 1 addition & 3 deletions lib/node_modules/@stdlib/blas/base/ndarray/dznrm2/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,7 @@ var y = dznrm2( [ x ] );

The function has the following parameters:

- **arrays**: array-like object containing the following ndarrays:

- a one-dimensional input ndarray.
- **arrays**: array-like object containing a one-dimensional input ndarray.

</section>

Expand Down
4 changes: 1 addition & 3 deletions lib/node_modules/@stdlib/blas/base/ndarray/gnrm2/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,7 @@ var y = gnrm2( [ x ] );

The function has the following parameters:

- **arrays**: array-like object containing the following ndarrays:

- a one-dimensional input ndarray.
- **arrays**: array-like object containing a one-dimensional input ndarray.

</section>

Expand Down
4 changes: 1 addition & 3 deletions lib/node_modules/@stdlib/blas/base/ndarray/scasum/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,7 @@ var y = scasum( [ x ] );

The function has the following parameters:

- **arrays**: array-like object containing the following ndarrays:

- a one-dimensional input ndarray.
- **arrays**: array-like object containing a one-dimensional input ndarray.

</section>

Expand Down
4 changes: 1 addition & 3 deletions lib/node_modules/@stdlib/blas/base/ndarray/scnrm2/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,7 @@ var y = scnrm2( [ x ] );

The function has the following parameters:

- **arrays**: array-like object containing the following ndarrays:

- a one-dimensional input ndarray.
- **arrays**: array-like object containing a one-dimensional input ndarray.

</section>

Expand Down
4 changes: 1 addition & 3 deletions lib/node_modules/@stdlib/blas/base/ndarray/snrm2/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,7 @@ var y = snrm2( [ x ] );

The function has the following parameters:

- **arrays**: array-like object containing the following ndarrays:

- a one-dimensional input ndarray.
- **arrays**: array-like object containing a one-dimensional input ndarray.

</section>

Expand Down
2 changes: 0 additions & 2 deletions lib/node_modules/@stdlib/blas/ext/base/dfirst-index-less-than/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,8 +129,6 @@ The function has the following additional parameters:

While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, to access only the last three elements of each strided array:

<!-- eslint-disable max-len -->

```javascript
var Float64Array = require( '@stdlib/array/float64' );

Expand Down
2 changes: 0 additions & 2 deletions lib/node_modules/@stdlib/blas/ext/base/dsome/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,6 @@ The function has the following parameters:

The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to test every other element:

<!-- eslint-disable max-len -->

```javascript
var Float64Array = require( '@stdlib/array/float64' );

Expand Down
4 changes: 1 addition & 3 deletions lib/node_modules/@stdlib/blas/ext/base/ndarray/dindex-of-falsy/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,7 @@ var idx = dindexOfFalsy( [ x ] );

The function has the following parameters:

- **arrays**: array-like object containing the following ndarrays:

- a one-dimensional input ndarray.
- **arrays**: array-like object containing a one-dimensional input ndarray.

If the function is unable to find a falsy element, the function returns `-1`.

Expand Down
4 changes: 1 addition & 3 deletions lib/node_modules/@stdlib/blas/ext/base/ndarray/gindex-of-falsy/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,7 @@ var idx = gindexOfFalsy( [ x ] );

The function has the following parameters:

- **arrays**: array-like object containing the following ndarrays:

- a one-dimensional input ndarray.
- **arrays**: array-like object containing a one-dimensional input ndarray.

If the function is unable to find a falsy element, the function returns `-1`.

Expand Down
2 changes: 0 additions & 2 deletions lib/node_modules/@stdlib/blas/ext/base/ssome/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,6 @@ The function has the following parameters:

The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to test every other element:

<!-- eslint-disable max-len -->

```javascript
var Float32Array = require( '@stdlib/array/float32' );

Expand Down
2 changes: 0 additions & 2 deletions lib/node_modules/@stdlib/lapack/base/dgttrf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,8 +241,6 @@ The function has the following additional parameters:

While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example,

<!-- eslint-disable max-len -->

```javascript
var Float64Array = require( '@stdlib/array/float64' );
var Int32Array = require( '@stdlib/array/int32' );
Expand Down
2 changes: 0 additions & 2 deletions lib/node_modules/@stdlib/lapack/base/dlassq/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,6 @@ The function has the following additional parameters:

While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example,

<!-- eslint-disable max-len -->

```javascript
var Float64Array = require( '@stdlib/array/float64' );

Expand Down
2 changes: 0 additions & 2 deletions lib/node_modules/@stdlib/lapack/base/dpttrf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,6 @@ The function has the following additional parameters:

While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example,

<!-- eslint-disable max-len -->

```javascript
var Float64Array = require( '@stdlib/array/float64' );

Expand Down
2 changes: 0 additions & 2 deletions lib/node_modules/@stdlib/lapack/base/spttrf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,6 @@ The function has the following additional parameters:

While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example,

<!-- eslint-disable max-len -->

```javascript
var Float32Array = require( '@stdlib/array/float32' );

Expand Down
9 changes: 6 additions & 3 deletions lib/node_modules/@stdlib/math/base/special/acos/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@
"@stdlib/math/base/special/asin",
"@stdlib/math/base/assert/is-nan",
"@stdlib/math/base/special/sqrt",
"@stdlib/constants/float64/fourth-pi"
"@stdlib/constants/float64/fourth-pi",
"@stdlib/constants/float64/nan"
]
},
{
Expand All @@ -57,7 +58,8 @@
"@stdlib/math/base/special/asin",
"@stdlib/math/base/assert/is-nan",
"@stdlib/math/base/special/sqrt",
"@stdlib/constants/float64/fourth-pi"
"@stdlib/constants/float64/fourth-pi",
"@stdlib/constants/float64/nan"
]
},
{
Expand All @@ -74,7 +76,8 @@
"@stdlib/math/base/special/asin",
"@stdlib/math/base/assert/is-nan",
"@stdlib/math/base/special/sqrt",
"@stdlib/constants/float64/fourth-pi"
"@stdlib/constants/float64/fourth-pi",
"@stdlib/constants/float64/nan"
]
}
]
Expand Down
5 changes: 3 additions & 2 deletions lib/node_modules/@stdlib/math/base/special/acos/src/main.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
#include "stdlib/math/base/special/asin.h"
#include "stdlib/math/base/special/sqrt.h"
#include "stdlib/constants/float64/fourth_pi.h"
#include "stdlib/constants/float64/nan.h"
#include <stdint.h>

static const double MOREBITS = 6.123233995736765886130e-17; // pi/2 = PIO2 + MOREBITS.
Expand Down Expand Up @@ -81,10 +82,10 @@ static const double MOREBITS = 6.123233995736765886130e-17; // pi/2 = PIO2 + MOR
double stdlib_base_acos( const double x ) {
double z;
if ( stdlib_base_is_nan( x ) ) {
return 0.0 / 0.0; // NaN
return STDLIB_CONSTANT_FLOAT64_NAN;
}
if ( x < -1.0 || x > 1.0 ) {
return 0.0 / 0.0; // NaN
return STDLIB_CONSTANT_FLOAT64_NAN;
}
if ( x > 0.5 ) {
return 2.0 * stdlib_base_asin( stdlib_base_sqrt( 0.5 - ( 0.5 * x ) ) );
Expand Down
9 changes: 6 additions & 3 deletions lib/node_modules/@stdlib/math/base/special/acosh/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@
"@stdlib/math/base/special/log1p",
"@stdlib/math/base/special/sqrt",
"@stdlib/math/base/special/ln",
"@stdlib/constants/float64/ln-two"
"@stdlib/constants/float64/ln-two",
"@stdlib/constants/float64/nan"
]
},
{
Expand All @@ -59,7 +60,8 @@
"@stdlib/math/base/special/log1p",
"@stdlib/math/base/special/sqrt",
"@stdlib/math/base/special/ln",
"@stdlib/constants/float64/ln-two"
"@stdlib/constants/float64/ln-two",
"@stdlib/constants/float64/nan"
]
},
{
Expand All @@ -77,7 +79,8 @@
"@stdlib/math/base/special/log1p",
"@stdlib/math/base/special/sqrt",
"@stdlib/math/base/special/ln",
"@stdlib/constants/float64/ln-two"
"@stdlib/constants/float64/ln-two",
"@stdlib/constants/float64/nan"
]
}
]
Expand Down
3 changes: 2 additions & 1 deletion lib/node_modules/@stdlib/math/base/special/acosh/src/main.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
#include "stdlib/math/base/special/sqrt.h"
#include "stdlib/math/base/special/ln.h"
#include "stdlib/constants/float64/ln_two.h"
#include "stdlib/constants/float64/nan.h"
#include <stdint.h>

static const double HUGE = 1 << 28; // 2**28
Expand Down Expand Up @@ -79,7 +80,7 @@ static const double HUGE = 1 << 28; // 2**28
double stdlib_base_acosh( const double x ) {
double t;
if ( stdlib_base_is_nan( x ) || x < 1.0 ) {
return 0.0 / 0.0; // NaN
return STDLIB_CONSTANT_FLOAT64_NAN;
}
if ( x == 1.0 ) {
return 0.0;
Expand Down
9 changes: 6 additions & 3 deletions lib/node_modules/@stdlib/math/base/special/asin/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@
"@stdlib/math/base/napi/unary",
"@stdlib/math/base/assert/is-nan",
"@stdlib/math/base/special/sqrt",
"@stdlib/constants/float64/fourth-pi"
"@stdlib/constants/float64/fourth-pi",
"@stdlib/constants/float64/nan"
]
},
{
Expand All @@ -55,7 +56,8 @@
"dependencies": [
"@stdlib/math/base/assert/is-nan",
"@stdlib/math/base/special/sqrt",
"@stdlib/constants/float64/fourth-pi"
"@stdlib/constants/float64/fourth-pi",
"@stdlib/constants/float64/nan"
]
},
{
Expand All @@ -71,7 +73,8 @@
"dependencies": [
"@stdlib/math/base/assert/is-nan",
"@stdlib/math/base/special/sqrt",
"@stdlib/constants/float64/fourth-pi"
"@stdlib/constants/float64/fourth-pi",
"@stdlib/constants/float64/nan"
]
}
]
Expand Down
5 changes: 3 additions & 2 deletions lib/node_modules/@stdlib/math/base/special/asin/src/main.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
#include "stdlib/math/base/assert/is_nan.h"
#include "stdlib/math/base/special/sqrt.h"
#include "stdlib/constants/float64/fourth_pi.h"
#include "stdlib/constants/float64/nan.h"
#include <stdint.h>

static const double MOREBITS = 6.123233995736765886130e-17; // pi/2 = PIO2 + MOREBITS
Expand Down Expand Up @@ -165,7 +166,7 @@ double stdlib_base_asin( const double x ) {
double z;

if ( stdlib_base_is_nan( x ) ) {
return 0.0 / 0.0; // NaN
return STDLIB_CONSTANT_FLOAT64_NAN;
}
if ( x > 0.0 ) {
sgn = 0;
Expand All @@ -175,7 +176,7 @@ double stdlib_base_asin( const double x ) {
a = -x;
}
if ( a > 1.0 ) {
return 0.0 / 0.0; // NaN
return STDLIB_CONSTANT_FLOAT64_NAN;
}
if ( a > 0.625 ) {
// arcsin(1-x) = pi/2 - sqrt(2x)(1+R(x))
Expand Down
9 changes: 6 additions & 3 deletions lib/node_modules/@stdlib/math/base/special/atan2/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@
"@stdlib/math/base/assert/is-nan",
"@stdlib/math/base/special/atan",
"@stdlib/constants/float64/pinf",
"@stdlib/constants/float64/pi"
"@stdlib/constants/float64/pi",
"@stdlib/constants/float64/nan"
]
},
{
Expand All @@ -63,7 +64,8 @@
"@stdlib/math/base/assert/is-nan",
"@stdlib/math/base/special/atan",
"@stdlib/constants/float64/pinf",
"@stdlib/constants/float64/pi"
"@stdlib/constants/float64/pi",
"@stdlib/constants/float64/nan"
]
},
{
Expand All @@ -83,7 +85,8 @@
"@stdlib/math/base/assert/is-nan",
"@stdlib/math/base/special/atan",
"@stdlib/constants/float64/pinf",
"@stdlib/constants/float64/pi"
"@stdlib/constants/float64/pi",
"@stdlib/constants/float64/nan"
]
}
]
Expand Down
3 changes: 2 additions & 1 deletion lib/node_modules/@stdlib/math/base/special/atan2/src/main.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
#include "stdlib/math/base/special/atan.h"
#include "stdlib/constants/float64/pinf.h"
#include "stdlib/constants/float64/pi.h"
#include "stdlib/constants/float64/nan.h"
#include <stdint.h>

/**
Expand Down Expand Up @@ -81,7 +82,7 @@
double stdlib_base_atan2( const double y, const double x ) {
double q;
if ( stdlib_base_is_nan( x ) || stdlib_base_is_nan( y ) ) {
return 0.0 / 0.0; // NaN
return STDLIB_CONSTANT_FLOAT64_NAN;
}
if ( stdlib_base_is_infinite( x ) ) {
if ( x == STDLIB_CONSTANT_FLOAT64_PINF ) {
Expand Down
9 changes: 6 additions & 3 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 @@ -40,7 +40,8 @@
"@stdlib/math/base/special/log1p",
"@stdlib/math/base/assert/is-nan",
"@stdlib/constants/float64/pinf",
"@stdlib/constants/float64/ninf"
"@stdlib/constants/float64/ninf",
"@stdlib/constants/float64/nan"
]
},
{
Expand All @@ -57,7 +58,8 @@
"@stdlib/math/base/special/log1p",
"@stdlib/math/base/assert/is-nan",
"@stdlib/constants/float64/pinf",
"@stdlib/constants/float64/ninf"
"@stdlib/constants/float64/ninf",
"@stdlib/constants/float64/nan"
]
},
{
Expand All @@ -74,7 +76,8 @@
"@stdlib/math/base/special/log1p",
"@stdlib/math/base/assert/is-nan",
"@stdlib/constants/float64/pinf",
"@stdlib/constants/float64/ninf"
"@stdlib/constants/float64/ninf",
"@stdlib/constants/float64/nan"
]
}
]
Expand Down
Loading
Loading