From 056eb9917fcae30f6e6e097e5f1cfcf62f153ed6 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Sat, 18 May 2024 02:29:04 +0000 Subject: [PATCH] docs: update related packages sections --- .../@stdlib/array/base/flatten-by/README.md | 12 +++++++++ .../@stdlib/array/base/flatten3d/README.md | 12 +++++++++ .../@stdlib/array/base/fliplr2d/README.md | 18 +++++++++++++ .../@stdlib/array/base/onesnd/README.md | 27 +++++++++++++++++++ .../@stdlib/array/base/zerosnd/README.md | 27 +++++++++++++++++++ .../@stdlib/math/base/special/asinf/README.md | 15 +++++++++++ .../base/for-each-code-point-right/README.md | 15 +++++++++++ .../@stdlib/string/base/headercase/README.md | 18 +++++++++++++ 8 files changed, 144 insertions(+) diff --git a/lib/node_modules/@stdlib/array/base/flatten-by/README.md b/lib/node_modules/@stdlib/array/base/flatten-by/README.md index c2597d57ce0c..b28631f0e4b7 100644 --- a/lib/node_modules/@stdlib/array/base/flatten-by/README.md +++ b/lib/node_modules/@stdlib/array/base/flatten-by/README.md @@ -200,6 +200,12 @@ out = flattenBy( x, [ 2, 2, 1, 2, 2 ], true, fcn );
+* * * + +## See Also + +- [`@stdlib/array/base/flatten`][@stdlib/array/base/flatten]: flatten an n-dimensional nested array. +
@@ -208,6 +214,12 @@ out = flattenBy( x, [ 2, 2, 1, 2, 2 ], true, fcn );
+ + +[@stdlib/array/base/flatten]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten + + +
diff --git a/lib/node_modules/@stdlib/array/base/flatten3d/README.md b/lib/node_modules/@stdlib/array/base/flatten3d/README.md index dcb069970b25..48621b257b37 100644 --- a/lib/node_modules/@stdlib/array/base/flatten3d/README.md +++ b/lib/node_modules/@stdlib/array/base/flatten3d/README.md @@ -139,6 +139,12 @@ out = flatten3d( x, [ 4, 2, 2 ], true );
+* * * + +## See Also + +- [`@stdlib/array/base/flatten3d-by`][@stdlib/array/base/flatten3d-by]: flatten a three-dimensional nested array according to a callback function. +
@@ -147,6 +153,12 @@ out = flatten3d( x, [ 4, 2, 2 ], true );
+ + +[@stdlib/array/base/flatten3d-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten3d-by + + +
diff --git a/lib/node_modules/@stdlib/array/base/fliplr2d/README.md b/lib/node_modules/@stdlib/array/base/fliplr2d/README.md index 3851a2b14984..96bc88c3ba5a 100644 --- a/lib/node_modules/@stdlib/array/base/fliplr2d/README.md +++ b/lib/node_modules/@stdlib/array/base/fliplr2d/README.md @@ -97,6 +97,14 @@ console.log( y );
+* * * + +## See Also + +- [`@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. +- [`@stdlib/array/base/fliplr5d`][@stdlib/array/base/fliplr5d]: reverse the order of elements along the last dimension of a five-dimensional nested input array. +
@@ -105,6 +113,16 @@ console.log( y );
+ + +[@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 + +[@stdlib/array/base/fliplr5d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/fliplr5d + + +
diff --git a/lib/node_modules/@stdlib/array/base/onesnd/README.md b/lib/node_modules/@stdlib/array/base/onesnd/README.md index dd7e9fc62d24..51c70bf7cabc 100644 --- a/lib/node_modules/@stdlib/array/base/onesnd/README.md +++ b/lib/node_modules/@stdlib/array/base/onesnd/README.md @@ -104,6 +104,17 @@ out = onesnd( [ 1, 1, 1, 3 ] );
+* * * + +## See Also + +- [`@stdlib/array/base/zerosnd`][@stdlib/array/base/zerosnd]: create a zero-filled n-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/ones5d`][@stdlib/array/base/ones5d]: create a five-dimensional nested array filled with ones. +
@@ -112,6 +123,22 @@ out = onesnd( [ 1, 1, 1, 3 ] );
+ + +[@stdlib/array/base/zerosnd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zerosnd + +[@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/ones5d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/ones5d + + +
diff --git a/lib/node_modules/@stdlib/array/base/zerosnd/README.md b/lib/node_modules/@stdlib/array/base/zerosnd/README.md index 28e27206017c..6259b55ab4ae 100644 --- a/lib/node_modules/@stdlib/array/base/zerosnd/README.md +++ b/lib/node_modules/@stdlib/array/base/zerosnd/README.md @@ -104,6 +104,17 @@ out = zerosnd( [ 1, 1, 1, 3 ] );
+* * * + +## See Also + +- [`@stdlib/array/base/zeros`][@stdlib/array/base/zeros]: create a zero-filled generic array. +- [`@stdlib/array/base/onesnd`][@stdlib/array/base/onesnd]: create an n-dimensional nested array filled with ones. +- [`@stdlib/array/base/zeros2d`][@stdlib/array/base/zeros2d]: create a zero-filled two-dimensional nested array. +- [`@stdlib/array/base/zeros3d`][@stdlib/array/base/zeros3d]: create a zero-filled three-dimensional nested array. +- [`@stdlib/array/base/zeros4d`][@stdlib/array/base/zeros4d]: create a zero-filled four-dimensional nested array. +- [`@stdlib/array/base/zeros5d`][@stdlib/array/base/zeros5d]: create a zero-filled five-dimensional nested array. +
@@ -112,6 +123,22 @@ out = zerosnd( [ 1, 1, 1, 3 ] );
+ + +[@stdlib/array/base/zeros]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zeros + +[@stdlib/array/base/onesnd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/onesnd + +[@stdlib/array/base/zeros2d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zeros2d + +[@stdlib/array/base/zeros3d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zeros3d + +[@stdlib/array/base/zeros4d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zeros4d + +[@stdlib/array/base/zeros5d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zeros5d + + +
diff --git a/lib/node_modules/@stdlib/math/base/special/asinf/README.md b/lib/node_modules/@stdlib/math/base/special/asinf/README.md index 60ad620152f2..76734caf1b8a 100644 --- a/lib/node_modules/@stdlib/math/base/special/asinf/README.md +++ b/lib/node_modules/@stdlib/math/base/special/asinf/README.md @@ -160,6 +160,13 @@ int main( void ) {
+* * * + +## See Also + +- [`@stdlib/math/base/special/asin`][@stdlib/math/base/special/asin]: compute the arcsine of a double-precision floating-point number. +- [`@stdlib/math/base/special/asindf`][@stdlib/math/base/special/asindf]: compute the arcsine (in degrees) of a single-precision floating-point number. +
@@ -170,6 +177,14 @@ int main( void ) { [arcsine]: https://en.wikipedia.org/wiki/Inverse_trigonometric_functions + + +[@stdlib/math/base/special/asin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/asin + +[@stdlib/math/base/special/asindf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/asindf + + + diff --git a/lib/node_modules/@stdlib/string/base/for-each-code-point-right/README.md b/lib/node_modules/@stdlib/string/base/for-each-code-point-right/README.md index 0c680a84182d..9b688ab28d51 100644 --- a/lib/node_modules/@stdlib/string/base/for-each-code-point-right/README.md +++ b/lib/node_modules/@stdlib/string/base/for-each-code-point-right/README.md @@ -133,6 +133,13 @@ forEachCodePointRight( '\uD834\uDD1E', log );
+* * * + +## See Also + +- [`@stdlib/string/base/for-each-code-point`][@stdlib/string/base/for-each-code-point]: invoke a function for each Unicode code point in a string. +- [`@stdlib/string/base/for-each-right`][@stdlib/string/base/for-each-right]: invoke a function for each UTF-16 code unit in a string, iterating from right to left. +
@@ -141,6 +148,14 @@ forEachCodePointRight( '\uD834\uDD1E', log );
+ + +[@stdlib/string/base/for-each-code-point]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/for-each-code-point + +[@stdlib/string/base/for-each-right]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/for-each-right + + +
diff --git a/lib/node_modules/@stdlib/string/base/headercase/README.md b/lib/node_modules/@stdlib/string/base/headercase/README.md index fb91eee28d69..41c97ed63ae2 100644 --- a/lib/node_modules/@stdlib/string/base/headercase/README.md +++ b/lib/node_modules/@stdlib/string/base/headercase/README.md @@ -84,6 +84,14 @@ out = headercase( str );
+* * * + +## See Also + +- [`@stdlib/string/base/camelcase`][@stdlib/string/base/camelcase]: convert a string to camel case. +- [`@stdlib/string/base/pascalcase`][@stdlib/string/base/pascalcase]: convert a string to Pascal case. +- [`@stdlib/string/base/uppercase`][@stdlib/string/base/uppercase]: convert a string to uppercase. +
@@ -92,6 +100,16 @@ out = headercase( str );
+ + +[@stdlib/string/base/camelcase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/camelcase + +[@stdlib/string/base/pascalcase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/pascalcase + +[@stdlib/string/base/uppercase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/uppercase + + +