From 43016945387e02d6396d33cb7134c62c977b7fd8 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Mon, 30 Dec 2024 11:26:38 -0800 Subject: [PATCH] docs: update related packages sections PR-URL: https://github.com/stdlib-js/stdlib/pull/4362 Reviewed-by: Athan Reines Reviewed-by: Philipp Burckhardt --- .../constants/float32/min-base10-exponent/README.md | 11 +++++++++++ .../float32/min-base2-exponent-subnormal/README.md | 11 +++++++++++ .../@stdlib/math/base/special/log2/README.md | 2 +- .../@stdlib/math/base/special/secd/README.md | 11 +++++++++++ lib/node_modules/@stdlib/ndarray/for-each/README.md | 8 ++++++++ 5 files changed, 42 insertions(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/constants/float32/min-base10-exponent/README.md b/lib/node_modules/@stdlib/constants/float32/min-base10-exponent/README.md index 129bec4f830b..dc1aeeea051b 100644 --- a/lib/node_modules/@stdlib/constants/float32/min-base10-exponent/README.md +++ b/lib/node_modules/@stdlib/constants/float32/min-base10-exponent/README.md @@ -126,6 +126,13 @@ Macro for the minimum base 10 exponent for a normal [single-precision floating-p
+* * * + +## See Also + +- [`@stdlib/constants/float32/min-base10-exponent-subnormal`][@stdlib/constants/float32/min-base10-exponent-subnormal]: the minimum base 10 exponent for a subnormal single-precision floating-point number. +- [`@stdlib/constants/float64/min-base10-exponent`][@stdlib/constants/float64/min-base10-exponent]: the minimum base 10 exponent for a normal double-precision floating-point number. +
@@ -138,6 +145,10 @@ Macro for the minimum base 10 exponent for a normal [single-precision floating-p +[@stdlib/constants/float32/min-base10-exponent-subnormal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/min-base10-exponent-subnormal + +[@stdlib/constants/float64/min-base10-exponent]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/min-base10-exponent + diff --git a/lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/README.md b/lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/README.md index 7a6b803de198..0d6b5e2144de 100644 --- a/lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/README.md +++ b/lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/README.md @@ -124,6 +124,13 @@ Macro for the minimum biased base 2 exponent for a subnormal [single-precision f
+* * * + +## See Also + +- [`@stdlib/constants/float32/min-base2-exponent`][@stdlib/constants/float32/min-base2-exponent]: the minimum biased base 2 exponent for a normal single-precision floating-point number. +- [`@stdlib/constants/float64/min-base2-exponent-subnormal`][@stdlib/constants/float64/min-base2-exponent-subnormal]: the minimum biased base 2 exponent for a subnormal double-precision floating-point number. +
@@ -136,6 +143,10 @@ Macro for the minimum biased base 2 exponent for a subnormal [single-precision f +[@stdlib/constants/float32/min-base2-exponent]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/min-base2-exponent + +[@stdlib/constants/float64/min-base2-exponent-subnormal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/min-base2-exponent-subnormal + diff --git a/lib/node_modules/@stdlib/math/base/special/log2/README.md b/lib/node_modules/@stdlib/math/base/special/log2/README.md index 6d8388b8f317..d6300db140f4 100644 --- a/lib/node_modules/@stdlib/math/base/special/log2/README.md +++ b/lib/node_modules/@stdlib/math/base/special/log2/README.md @@ -200,7 +200,7 @@ int main( void ) { - [`@stdlib/math/base/special/exp2`][@stdlib/math/base/special/exp2]: base 2 exponential function. - [`@stdlib/math/base/special/ln`][@stdlib/math/base/special/ln]: evaluate the natural logarithm of a double-precision floating-point number. -- [`@stdlib/math/base/special/log`][@stdlib/math/base/special/log]: base `b` logarithm. +- [`@stdlib/math/base/special/log`][@stdlib/math/base/special/log]: compute the base `b` logarithm of a double-precision floating-point number. diff --git a/lib/node_modules/@stdlib/math/base/special/secd/README.md b/lib/node_modules/@stdlib/math/base/special/secd/README.md index ad7ed1d18b42..c4727adafe37 100644 --- a/lib/node_modules/@stdlib/math/base/special/secd/README.md +++ b/lib/node_modules/@stdlib/math/base/special/secd/README.md @@ -172,6 +172,13 @@ int main( void ) {
+* * * + +## See Also + +- [`@stdlib/math/base/special/cosd`][@stdlib/math/base/special/cosd]: compute the cosine of an angle measured in degrees. +- [`@stdlib/math/base/special/cos`][@stdlib/math/base/special/cos]: compute the cosine of a number. +
@@ -184,6 +191,10 @@ int main( void ) { +[@stdlib/math/base/special/cosd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/cosd + +[@stdlib/math/base/special/cos]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/cos + diff --git a/lib/node_modules/@stdlib/ndarray/for-each/README.md b/lib/node_modules/@stdlib/ndarray/for-each/README.md index 07fbb840f010..7b33b84c1fdd 100644 --- a/lib/node_modules/@stdlib/ndarray/for-each/README.md +++ b/lib/node_modules/@stdlib/ndarray/for-each/README.md @@ -147,6 +147,12 @@ forEach( x, naryFunction( log, 2 ) );
+* * * + +## See Also + +- [`@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. +
@@ -157,6 +163,8 @@ forEach( x, naryFunction( log, 2 ) ); +[@stdlib/ndarray/map]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/map +