From 21b463ef4c824643aee63e94e968f6619cbdf7fe Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Fri, 20 Dec 2024 02:45:28 +0000 Subject: [PATCH 1/2] docs: update related packages sections --- .../@stdlib/array/base/fliplr5d/README.md | 18 ++++++++++++++++++ .../@stdlib/blas/ext/base/gapx/README.md | 2 +- .../blas/ext/base/sapxsumkbn2/README.md | 6 +++--- .../constants/float32/sqrt-half-pi/README.md | 2 -- .../float64/high-word-exponent-mask/README.md | 6 ++++++ .../base/assert/is-positive-finite/README.md | 14 ++++++++++++++ .../@stdlib/math/base/special/minn/README.md | 3 +++ .../math/strided/special/atan-by/README.md | 12 ++++++++++++ .../@stdlib/ndarray/reject/README.md | 17 +++++++++++++++++ .../slice/base/str2multislice/README.md | 12 ++++++++++++ 10 files changed, 86 insertions(+), 6 deletions(-) diff --git a/lib/node_modules/@stdlib/array/base/fliplr5d/README.md b/lib/node_modules/@stdlib/array/base/fliplr5d/README.md index 04c45a1f76c9..b9864326bb4d 100644 --- a/lib/node_modules/@stdlib/array/base/fliplr5d/README.md +++ b/lib/node_modules/@stdlib/array/base/fliplr5d/README.md @@ -97,6 +97,14 @@ console.log( y );
+* * * + +## See Also + +- [`@stdlib/array/base/fliplr2d`][@stdlib/array/base/fliplr2d]: reverse the order of elements along the last dimension of a two-dimensional nested input array. +- [`@stdlib/array/base/fliplr3d`][@stdlib/array/base/fliplr3d]: reverse the order of elements along the last dimension of a three-dimensional nested input array. +- [`@stdlib/array/base/fliplr4d`][@stdlib/array/base/fliplr4d]: reverse the order of elements along the last dimension of a four-dimensional nested input array. +
@@ -105,6 +113,16 @@ console.log( y );
+ + +[@stdlib/array/base/fliplr2d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/fliplr2d + +[@stdlib/array/base/fliplr3d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/fliplr3d + +[@stdlib/array/base/fliplr4d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/fliplr4d + + +
diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapx/README.md b/lib/node_modules/@stdlib/blas/ext/base/gapx/README.md index 6905d4cb1310..ffb549adc4c1 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapx/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/gapx/README.md @@ -163,7 +163,7 @@ console.log( x ); ## See Also -- [`@stdlib/blas/ext/base/dapx`][@stdlib/blas/ext/base/dapx]: add a constant to each element in a double-precision floating-point strided array. +- [`@stdlib/blas/ext/base/dapx`][@stdlib/blas/ext/base/dapx]: add a scalar constant to each element in a double-precision floating-point strided array. - [`@stdlib/blas/ext/base/sapx`][@stdlib/blas/ext/base/sapx]: add a constant to each element in a single-precision floating-point strided array. diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapxsumkbn2/README.md b/lib/node_modules/@stdlib/blas/ext/base/sapxsumkbn2/README.md index 7c4d4b9c89df..034dc4343c27 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapxsumkbn2/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/sapxsumkbn2/README.md @@ -166,9 +166,9 @@ console.log( v ); ## See Also -- [`@stdlib/blas/ext/base/dapxsumkbn2`][@stdlib/blas/ext/base/dapxsumkbn2]: adds a constant to each double-precision floating-point strided array element and computes the sum using a second-order iterative Kahan–Babuška algorithm. -- [`@stdlib/blas/ext/base/gapxsumkbn2`][@stdlib/blas/ext/base/gapxsumkbn2]: adds a constant to each strided array element and computes the sum using a second-order iterative Kahan–Babuška algorithm. -- [`@stdlib/blas/ext/base/sapxsum`][@stdlib/blas/ext/base/sapxsum]: adds a constant to each single-precision floating-point strided array element and computes the sum. +- [`@stdlib/blas/ext/base/dapxsumkbn2`][@stdlib/blas/ext/base/dapxsumkbn2]: add a scalar constant to each double-precision floating-point strided array element and compute the sum using a second-order iterative Kahan–Babuška algorithm. +- [`@stdlib/blas/ext/base/gapxsumkbn2`][@stdlib/blas/ext/base/gapxsumkbn2]: add a constant to each strided array element and compute the sum using a second-order iterative Kahan–Babuška algorithm. +- [`@stdlib/blas/ext/base/sapxsum`][@stdlib/blas/ext/base/sapxsum]: add a constant to each single-precision floating-point strided array element and compute the sum. - [`@stdlib/blas/ext/base/ssumkbn2`][@stdlib/blas/ext/base/ssumkbn2]: calculate the sum of single-precision floating-point strided array elements using a second-order iterative Kahan–Babuška algorithm. diff --git a/lib/node_modules/@stdlib/constants/float32/sqrt-half-pi/README.md b/lib/node_modules/@stdlib/constants/float32/sqrt-half-pi/README.md index 194bd769c40e..4f8e2c209b8c 100644 --- a/lib/node_modules/@stdlib/constants/float32/sqrt-half-pi/README.md +++ b/lib/node_modules/@stdlib/constants/float32/sqrt-half-pi/README.md @@ -136,8 +136,6 @@ Macro for the square root of the mathematical constant [π][@stdlib/constants/fl -[@stdlib/constants/float32/pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/pi - diff --git a/lib/node_modules/@stdlib/constants/float64/high-word-exponent-mask/README.md b/lib/node_modules/@stdlib/constants/float64/high-word-exponent-mask/README.md index ad329ebe930e..041be5aeddb2 100644 --- a/lib/node_modules/@stdlib/constants/float64/high-word-exponent-mask/README.md +++ b/lib/node_modules/@stdlib/constants/float64/high-word-exponent-mask/README.md @@ -150,6 +150,8 @@ Macro for the high word mask for the exponent of a [double-precision floating-po ## See Also - [`@stdlib/constants/float64/high-word-significand-mask`][@stdlib/constants/float64/high-word-significand-mask]: high word mask for the significand of a double-precision floating-point number. +- [`@stdlib/constants/float64/high-word-sign-mask`][@stdlib/constants/float64/high-word-sign-mask]: high word mask for the sign bit of a double-precision floating-point number. +- [`@stdlib/constants/float64/high-word-abs-mask`][@stdlib/constants/float64/high-word-abs-mask]: high word mask for excluding the sign bit of a double-precision floating-point number. @@ -165,6 +167,10 @@ Macro for the high word mask for the exponent of a [double-precision floating-po [@stdlib/constants/float64/high-word-significand-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/high-word-significand-mask +[@stdlib/constants/float64/high-word-sign-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/high-word-sign-mask + +[@stdlib/constants/float64/high-word-abs-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/high-word-abs-mask + diff --git a/lib/node_modules/@stdlib/math/base/assert/is-positive-finite/README.md b/lib/node_modules/@stdlib/math/base/assert/is-positive-finite/README.md index 04a4d71e68b7..4c2389c8cff4 100644 --- a/lib/node_modules/@stdlib/math/base/assert/is-positive-finite/README.md +++ b/lib/node_modules/@stdlib/math/base/assert/is-positive-finite/README.md @@ -176,6 +176,14 @@ int main( void ) {
+* * * + +## See Also + +- [`@stdlib/math/base/assert/is-negative-finite`][@stdlib/math/base/assert/is-negative-finite]: test if a double-precision floating-point numeric value is a negative finite number. +- [`@stdlib/math/base/assert/is-nonnegative-finite`][@stdlib/math/base/assert/is-nonnegative-finite]: test if a numeric value is a nonnegative finite number. +- [`@stdlib/math/base/assert/is-nonpositive-finite`][@stdlib/math/base/assert/is-nonpositive-finite]: test if a numeric value is a nonpositive finite number. +
@@ -186,6 +194,12 @@ int main( void ) { +[@stdlib/math/base/assert/is-negative-finite]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/assert/is-negative-finite + +[@stdlib/math/base/assert/is-nonnegative-finite]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/assert/is-nonnegative-finite + +[@stdlib/math/base/assert/is-nonpositive-finite]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/assert/is-nonpositive-finite + diff --git a/lib/node_modules/@stdlib/math/base/special/minn/README.md b/lib/node_modules/@stdlib/math/base/special/minn/README.md index e36aeeac114b..459d61d55fe3 100644 --- a/lib/node_modules/@stdlib/math/base/special/minn/README.md +++ b/lib/node_modules/@stdlib/math/base/special/minn/README.md @@ -135,6 +135,7 @@ for ( i = 0; i < 100; i++ ) { - [`@stdlib/math/base/special/maxn`][@stdlib/math/base/special/maxn]: return the maximum value. - [`@stdlib/math/base/special/min`][@stdlib/math/base/special/min]: return the minimum value. +- [`@stdlib/math/base/special/minabsn`][@stdlib/math/base/special/minabsn]: return the minimum absolute value. @@ -150,6 +151,8 @@ for ( i = 0; i < 100; i++ ) { [@stdlib/math/base/special/min]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/min +[@stdlib/math/base/special/minabsn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/minabsn + diff --git a/lib/node_modules/@stdlib/math/strided/special/atan-by/README.md b/lib/node_modules/@stdlib/math/strided/special/atan-by/README.md index 906cd675c452..d17c8e8f76a0 100644 --- a/lib/node_modules/@stdlib/math/strided/special/atan-by/README.md +++ b/lib/node_modules/@stdlib/math/strided/special/atan-by/README.md @@ -229,6 +229,12 @@ console.log( y );
+* * * + +## See Also + +- [`@stdlib/math/strided/special/atanh-by`][@stdlib/math/strided/special/atanh-by]: compute the hyperbolic arctangent of each element retrieved from an input strided array via a callback function. +
@@ -243,6 +249,12 @@ console.log( y ); [@stdlib/math/base/special/atan]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/atan + + +[@stdlib/math/strided/special/atanh-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/special/atanh-by + + + diff --git a/lib/node_modules/@stdlib/ndarray/reject/README.md b/lib/node_modules/@stdlib/ndarray/reject/README.md index c7d5f4e88ff4..33f771a68306 100644 --- a/lib/node_modules/@stdlib/ndarray/reject/README.md +++ b/lib/node_modules/@stdlib/ndarray/reject/README.md @@ -204,6 +204,15 @@ console.log( ndarray2array( y ) );
+* * * + +## See Also + +- [`@stdlib/ndarray/filter`][@stdlib/ndarray/filter]: return a shallow copy of an ndarray containing only those elements which pass a test implemented by a predicate function. +- [`@stdlib/ndarray/filter-map`][@stdlib/ndarray/filter-map]: filter and map elements in an input ndarray to elements in a new output ndarray according to a callback function. +- [`@stdlib/ndarray/map`][@stdlib/ndarray/map]: apply a callback to elements in an input ndarray and assign results to elements in a new output ndarray. +- [`@stdlib/ndarray/slice`][@stdlib/ndarray/slice]: return a read-only view of an input ndarray. +
@@ -218,6 +227,14 @@ console.log( ndarray2array( y ) ); +[@stdlib/ndarray/filter]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/filter + +[@stdlib/ndarray/filter-map]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/filter-map + +[@stdlib/ndarray/map]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/map + +[@stdlib/ndarray/slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/slice + diff --git a/lib/node_modules/@stdlib/slice/base/str2multislice/README.md b/lib/node_modules/@stdlib/slice/base/str2multislice/README.md index 95dfba4c4f7e..a36f63edc693 100644 --- a/lib/node_modules/@stdlib/slice/base/str2multislice/README.md +++ b/lib/node_modules/@stdlib/slice/base/str2multislice/README.md @@ -131,6 +131,12 @@ s = str2multislice( 'MultiSlice(foo,bar)' );
+* * * + +## See Also + +- [`@stdlib/slice/base/str2slice`][@stdlib/slice/base/str2slice]: parse a string-serialized Slice object. +
@@ -141,6 +147,12 @@ s = str2multislice( 'MultiSlice(foo,bar)' ); [@stdlib/slice/multi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/multi + + +[@stdlib/slice/base/str2slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/base/str2slice + + + From f536592a7a4f1e7dbfd85899b13947789fd1f49d Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Thu, 19 Dec 2024 21:54:08 -0500 Subject: [PATCH 2/2] chore: re-add related link to float32/pi in README --- .../@stdlib/constants/float32/sqrt-half-pi/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/lib/node_modules/@stdlib/constants/float32/sqrt-half-pi/README.md b/lib/node_modules/@stdlib/constants/float32/sqrt-half-pi/README.md index 4f8e2c209b8c..194bd769c40e 100644 --- a/lib/node_modules/@stdlib/constants/float32/sqrt-half-pi/README.md +++ b/lib/node_modules/@stdlib/constants/float32/sqrt-half-pi/README.md @@ -136,6 +136,8 @@ Macro for the square root of the mathematical constant [π][@stdlib/constants/fl +[@stdlib/constants/float32/pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/pi +