From fc5e29ddbed2febfb37b7c76793a7b6873b836da Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Sat, 28 Dec 2024 02:41:39 +0000 Subject: [PATCH] docs: update related packages sections --- .../array/base/cartesian-product/README.md | 18 ++++++++++++++++++ .../@stdlib/constants/float32/two-pi/README.md | 16 ++++++++++++++++ .../@stdlib/math/base/special/acotf/README.md | 18 ++++++++++++++++++ .../math/strided/special/besselj0-by/README.md | 18 ++++++++++++++++++ .../math/strided/special/dcbrt-by/README.md | 12 ++++++++++++ .../@stdlib/ndarray/to-array/README.md | 3 +++ 6 files changed, 85 insertions(+) diff --git a/lib/node_modules/@stdlib/array/base/cartesian-product/README.md b/lib/node_modules/@stdlib/array/base/cartesian-product/README.md index bab5d422de11..0459ccbaafd1 100644 --- a/lib/node_modules/@stdlib/array/base/cartesian-product/README.md +++ b/lib/node_modules/@stdlib/array/base/cartesian-product/README.md @@ -87,6 +87,14 @@ var out = cartesianProduct( x1, x2 );
+* * * + +## See Also + +- [`@stdlib/array/cartesian-product`][@stdlib/array/cartesian-product]: return the Cartesian product. +- [`@stdlib/array/base/cartesian-power`][@stdlib/array/base/cartesian-power]: return the Cartesian power. +- [`@stdlib/array/base/cartesian-square`][@stdlib/array/base/cartesian-square]: return the Cartesian square. +
@@ -97,6 +105,16 @@ var out = cartesianProduct( x1, x2 ); [cartesian-product]: https://en.wikipedia.org/wiki/Cartesian_product + + +[@stdlib/array/cartesian-product]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/cartesian-product + +[@stdlib/array/base/cartesian-power]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/cartesian-power + +[@stdlib/array/base/cartesian-square]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/cartesian-square + + + diff --git a/lib/node_modules/@stdlib/constants/float32/two-pi/README.md b/lib/node_modules/@stdlib/constants/float32/two-pi/README.md index b71a91206ac1..123213e99d33 100644 --- a/lib/node_modules/@stdlib/constants/float32/two-pi/README.md +++ b/lib/node_modules/@stdlib/constants/float32/two-pi/README.md @@ -108,6 +108,14 @@ Macro for The mathematical constant [π][@stdlib/constants/float32/pi] times 2.
+* * * + +## See Also + +- [`@stdlib/constants/float32/fourth-pi`][@stdlib/constants/float32/fourth-pi]: 1/4 times π. +- [`@stdlib/constants/float32/half-pi`][@stdlib/constants/float32/half-pi]: 1/2 times π. +- [`@stdlib/constants/float32/pi`][@stdlib/constants/float32/pi]: π. +
@@ -118,6 +126,14 @@ Macro for The mathematical constant [π][@stdlib/constants/float32/pi] times 2. [@stdlib/constants/float32/pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/pi + + +[@stdlib/constants/float32/fourth-pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/fourth-pi + +[@stdlib/constants/float32/half-pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/half-pi + + + diff --git a/lib/node_modules/@stdlib/math/base/special/acotf/README.md b/lib/node_modules/@stdlib/math/base/special/acotf/README.md index 6b3d3f5f90d2..77dcf4fbccac 100644 --- a/lib/node_modules/@stdlib/math/base/special/acotf/README.md +++ b/lib/node_modules/@stdlib/math/base/special/acotf/README.md @@ -157,6 +157,14 @@ int main( void ) {
+* * * + +## See Also + +- [`@stdlib/math/base/special/acot`][@stdlib/math/base/special/acot]: compute the inverse cotangent. +- [`@stdlib/math/base/special/acoth`][@stdlib/math/base/special/acoth]: compute the inverse hyperbolic cotangent. +- [`@stdlib/math/base/special/atanf`][@stdlib/math/base/special/atanf]: compute the arctangent of a single-precision floating-point number. +
@@ -167,6 +175,16 @@ int main( void ) { [arccotangent]: https://en.wikipedia.org/wiki/Inverse_trigonometric_functions + + +[@stdlib/math/base/special/acot]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/acot + +[@stdlib/math/base/special/acoth]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/acoth + +[@stdlib/math/base/special/atanf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/atanf + + + diff --git a/lib/node_modules/@stdlib/math/strided/special/besselj0-by/README.md b/lib/node_modules/@stdlib/math/strided/special/besselj0-by/README.md index b1fb67785bcb..b4ee5b41a97d 100644 --- a/lib/node_modules/@stdlib/math/strided/special/besselj0-by/README.md +++ b/lib/node_modules/@stdlib/math/strided/special/besselj0-by/README.md @@ -229,6 +229,14 @@ console.log( y );
+* * * + +## See Also + +- [`@stdlib/math/strided/special/besselj1-by`][@stdlib/math/strided/special/besselj1-by]: compute the Bessel function of the first kind of order one for each element retrieved from an input strided array via a callback function. +- [`@stdlib/math/strided/special/bessely0-by`][@stdlib/math/strided/special/bessely0-by]: compute the Bessel function of the second kind of order zero for each element retrieved from an input strided array via a callback function. +- [`@stdlib/math/strided/special/bessely1-by`][@stdlib/math/strided/special/bessely1-by]: compute the Bessel function of the second kind of order one for each element retrieved from an input strided array via a callback function. +
@@ -243,6 +251,16 @@ console.log( y ); [@stdlib/math/base/special/besselj0]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/besselj0 + + +[@stdlib/math/strided/special/besselj1-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/special/besselj1-by + +[@stdlib/math/strided/special/bessely0-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/special/bessely0-by + +[@stdlib/math/strided/special/bessely1-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/special/bessely1-by + + + diff --git a/lib/node_modules/@stdlib/math/strided/special/dcbrt-by/README.md b/lib/node_modules/@stdlib/math/strided/special/dcbrt-by/README.md index c90dfcf53ccf..ac04a57ba396 100644 --- a/lib/node_modules/@stdlib/math/strided/special/dcbrt-by/README.md +++ b/lib/node_modules/@stdlib/math/strided/special/dcbrt-by/README.md @@ -239,6 +239,12 @@ console.log( out );
+* * * + +## See Also + +- [`@stdlib/math/strided/special/cbrt`][@stdlib/math/strided/special/cbrt]: compute the cube root of each element in a strided array. +
@@ -251,6 +257,12 @@ console.log( out ); [@stdlib/math/base/special/cbrt]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/cbrt + + +[@stdlib/math/strided/special/cbrt]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/special/cbrt + + + diff --git a/lib/node_modules/@stdlib/ndarray/to-array/README.md b/lib/node_modules/@stdlib/ndarray/to-array/README.md index 91aad76d708e..cfc48687e8c6 100644 --- a/lib/node_modules/@stdlib/ndarray/to-array/README.md +++ b/lib/node_modules/@stdlib/ndarray/to-array/README.md @@ -144,6 +144,7 @@ for ( i = 0; i < 20; i++ ) { - [`@stdlib/ndarray/array`][@stdlib/ndarray/array]: multidimensional arrays. - [`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]: multidimensional array constructor. +- [`@stdlib/ndarray/to-json`][@stdlib/ndarray/to-json]: serialize an ndarray as a JSON object. @@ -159,6 +160,8 @@ for ( i = 0; i < 20; i++ ) { [@stdlib/ndarray/array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/array +[@stdlib/ndarray/to-json]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-json +