From 4582fdd013f31476123bfbaa06d250ed54b64700 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Tue, 21 May 2024 02:29:21 +0000 Subject: [PATCH] docs: update related packages sections --- .../@stdlib/array/base/flatten/README.md | 12 +++++++++ .../@stdlib/array/base/ones5d/README.md | 27 +++++++++++++++++++ .../constants/float32/exponent-mask/README.md | 18 +++++++++++++ .../@stdlib/math/base/special/acscf/README.md | 21 +++++++++++++++ .../@stdlib/math/base/special/acsch/README.md | 3 +++ .../math/base/special/rad2degf/README.md | 12 +++++++++ .../strided/special/ahaversin-by/README.md | 12 +++++++++ .../@stdlib/slice/base/seq2slice/README.md | 15 +++++++++++ .../@stdlib/utils/every-in-by/README.md | 14 ++++++++++ 9 files changed, 134 insertions(+) diff --git a/lib/node_modules/@stdlib/array/base/flatten/README.md b/lib/node_modules/@stdlib/array/base/flatten/README.md index d0af7b1f257e..266ffe81fe44 100644 --- a/lib/node_modules/@stdlib/array/base/flatten/README.md +++ b/lib/node_modules/@stdlib/array/base/flatten/README.md @@ -154,6 +154,12 @@ out = flatten( x, [ 2, 2, 1, 2, 2 ], true );
+* * * + +## See Also + +- [`@stdlib/array/base/flatten-by`][@stdlib/array/base/flatten-by]: flatten an n-dimensional nested array according to a callback function. +
@@ -162,6 +168,12 @@ out = flatten( x, [ 2, 2, 1, 2, 2 ], true );
+ + +[@stdlib/array/base/flatten-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten-by + + +
diff --git a/lib/node_modules/@stdlib/array/base/ones5d/README.md b/lib/node_modules/@stdlib/array/base/ones5d/README.md index fdd97e36c8bf..b2c678616fa8 100644 --- a/lib/node_modules/@stdlib/array/base/ones5d/README.md +++ b/lib/node_modules/@stdlib/array/base/ones5d/README.md @@ -95,6 +95,17 @@ out = ones5d( [ 1, 1, 1, 3, 1 ] );
+* * * + +## See Also + +- [`@stdlib/array/base/zeros5d`][@stdlib/array/base/zeros5d]: create a zero-filled five-dimensional nested array. +- [`@stdlib/array/base/ones`][@stdlib/array/base/ones]: create a generic array filled with ones. +- [`@stdlib/array/base/ones2d`][@stdlib/array/base/ones2d]: create a two-dimensional nested array filled with ones. +- [`@stdlib/array/base/ones3d`][@stdlib/array/base/ones3d]: create a three-dimensional nested array filled with ones. +- [`@stdlib/array/base/ones4d`][@stdlib/array/base/ones4d]: create a four-dimensional nested array filled with ones. +- [`@stdlib/array/base/onesnd`][@stdlib/array/base/onesnd]: create an n-dimensional nested array filled with ones. +
@@ -103,6 +114,22 @@ out = ones5d( [ 1, 1, 1, 3, 1 ] );
+ + +[@stdlib/array/base/zeros5d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zeros5d + +[@stdlib/array/base/ones]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/ones + +[@stdlib/array/base/ones2d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/ones2d + +[@stdlib/array/base/ones3d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/ones3d + +[@stdlib/array/base/ones4d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/ones4d + +[@stdlib/array/base/onesnd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/onesnd + + +
diff --git a/lib/node_modules/@stdlib/constants/float32/exponent-mask/README.md b/lib/node_modules/@stdlib/constants/float32/exponent-mask/README.md index 2ae6cff33a44..81c10793d207 100644 --- a/lib/node_modules/@stdlib/constants/float32/exponent-mask/README.md +++ b/lib/node_modules/@stdlib/constants/float32/exponent-mask/README.md @@ -139,6 +139,14 @@ Macro for the mask for the exponent of a [single-precision floating-point number
+* * * + +## See Also + +- [`@stdlib/constants/float32/sign-mask`][@stdlib/constants/float32/sign-mask]: mask for the sign bit of a single-precision floating-point number. +- [`@stdlib/constants/float32/significand-mask`][@stdlib/constants/float32/significand-mask]: mask for the significand of a single-precision floating-point number. +- [`@stdlib/constants/float32/abs-mask`][@stdlib/constants/float32/abs-mask]: mask for excluding the sign bit of a single-precision floating-point number. +
@@ -149,6 +157,16 @@ Macro for the mask for the exponent of a [single-precision floating-point number [ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985 + + +[@stdlib/constants/float32/sign-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/sign-mask + +[@stdlib/constants/float32/significand-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/significand-mask + +[@stdlib/constants/float32/abs-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/abs-mask + + + diff --git a/lib/node_modules/@stdlib/math/base/special/acscf/README.md b/lib/node_modules/@stdlib/math/base/special/acscf/README.md index abf443c87abd..ce3fea6269e1 100644 --- a/lib/node_modules/@stdlib/math/base/special/acscf/README.md +++ b/lib/node_modules/@stdlib/math/base/special/acscf/README.md @@ -167,6 +167,15 @@ int main( void ) {
+* * * + +## See Also + +- [`@stdlib/math/base/special/acsc`][@stdlib/math/base/special/acsc]: compute the arccosecant of a number. +- [`@stdlib/math/base/special/acsch`][@stdlib/math/base/special/acsch]: compute the hyperbolic arccosecant of a number. +- [`@stdlib/math/base/special/asecf`][@stdlib/math/base/special/asecf]: compute the inverse (arc) secant of a single-precision floating-point number. +- [`@stdlib/math/base/special/asinf`][@stdlib/math/base/special/asinf]: compute the arcsine of a single-precision floating-point number. +
@@ -177,6 +186,18 @@ int main( void ) { [arccosecant]: https://en.wikipedia.org/wiki/Inverse_trigonometric_functions + + +[@stdlib/math/base/special/acsc]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/acsc + +[@stdlib/math/base/special/acsch]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/acsch + +[@stdlib/math/base/special/asecf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/asecf + +[@stdlib/math/base/special/asinf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/asinf + + + diff --git a/lib/node_modules/@stdlib/math/base/special/acsch/README.md b/lib/node_modules/@stdlib/math/base/special/acsch/README.md index 968046f80167..e444a231c913 100644 --- a/lib/node_modules/@stdlib/math/base/special/acsch/README.md +++ b/lib/node_modules/@stdlib/math/base/special/acsch/README.md @@ -180,6 +180,7 @@ int main( void ) { - [`@stdlib/math/base/special/acsc`][@stdlib/math/base/special/acsc]: compute the arccosecant of a number. - [`@stdlib/math/base/special/asech`][@stdlib/math/base/special/asech]: compute the hyperbolic arcsecant of a number. - [`@stdlib/math/base/special/asinh`][@stdlib/math/base/special/asinh]: compute the hyperbolic arcsine of a double-precision floating-point number. +- [`@stdlib/math/base/special/csc`][@stdlib/math/base/special/csc]: compute the cosecant of a number. - [`@stdlib/math/base/special/csch`][@stdlib/math/base/special/csch]: compute the hyperbolic cosecant of a number. @@ -202,6 +203,8 @@ int main( void ) { [@stdlib/math/base/special/asinh]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/asinh +[@stdlib/math/base/special/csc]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/csc + [@stdlib/math/base/special/csch]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/csch diff --git a/lib/node_modules/@stdlib/math/base/special/rad2degf/README.md b/lib/node_modules/@stdlib/math/base/special/rad2degf/README.md index e931786d1192..5ac7a4755312 100644 --- a/lib/node_modules/@stdlib/math/base/special/rad2degf/README.md +++ b/lib/node_modules/@stdlib/math/base/special/rad2degf/README.md @@ -187,6 +187,12 @@ int main( void ) {
+* * * + +## See Also + +- [`@stdlib/math/base/special/rad2deg`][@stdlib/math/base/special/rad2deg]: convert an angle from radians to degrees. +
@@ -195,6 +201,12 @@ int main( void ) {
+ + +[@stdlib/math/base/special/rad2deg]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/rad2deg + + +
diff --git a/lib/node_modules/@stdlib/math/strided/special/ahaversin-by/README.md b/lib/node_modules/@stdlib/math/strided/special/ahaversin-by/README.md index a45c9458bd23..60489ebd681f 100644 --- a/lib/node_modules/@stdlib/math/strided/special/ahaversin-by/README.md +++ b/lib/node_modules/@stdlib/math/strided/special/ahaversin-by/README.md @@ -229,6 +229,12 @@ console.log( y );
+* * * + +## See Also + +- [`@stdlib/math/strided/special/ahavercos-by`][@stdlib/math/strided/special/ahavercos-by]: compute the inverse half-value versed cosine of each element retrieved from an input strided array via a callback function. +
@@ -243,6 +249,12 @@ console.log( y ); [@stdlib/math/base/special/ahaversin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/ahaversin + + +[@stdlib/math/strided/special/ahavercos-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/special/ahavercos-by + + + diff --git a/lib/node_modules/@stdlib/slice/base/seq2slice/README.md b/lib/node_modules/@stdlib/slice/base/seq2slice/README.md index fa8458e4cbe9..bd9fd988840e 100644 --- a/lib/node_modules/@stdlib/slice/base/seq2slice/README.md +++ b/lib/node_modules/@stdlib/slice/base/seq2slice/README.md @@ -263,6 +263,13 @@ console.log( 'start: %s. stop: %s. step: %s.', s.start, s.stop, s.step );
+* * * + +## See Also + +- [`@stdlib/slice/base/seq2multislice`][@stdlib/slice/base/seq2multislice]: convert a multidimensional subsequence string to a MultiSlice object. +- [`@stdlib/slice/base/slice2seq`][@stdlib/slice/base/slice2seq]: convert a Slice object to a subsequence string. +
@@ -273,6 +280,14 @@ console.log( 'start: %s. stop: %s. step: %s.', s.start, s.stop, s.step ); [@stdlib/slice/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/ctor + + +[@stdlib/slice/base/seq2multislice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/base/seq2multislice + +[@stdlib/slice/base/slice2seq]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/base/slice2seq + + + diff --git a/lib/node_modules/@stdlib/utils/every-in-by/README.md b/lib/node_modules/@stdlib/utils/every-in-by/README.md index 706362cafd15..dc399f0282f8 100644 --- a/lib/node_modules/@stdlib/utils/every-in-by/README.md +++ b/lib/node_modules/@stdlib/utils/every-in-by/README.md @@ -122,6 +122,20 @@ bool = everyInBy( o, isPositive );
+ + +[@stdlib/utils/any-in-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/any-in-by + +[@stdlib/utils/none-in-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/none-in-by + +[@stdlib/utils/some-in-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/some-in-by + +[@stdlib/utils/every-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/every-by + +[@stdlib/utils/every-own-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/every-own-by + + +