From 6979ee61fe8bf6468265c8138d3e5bdfc2e64f9f Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Fri, 13 Dec 2024 03:24:01 +0000 Subject: [PATCH] docs: update related packages sections --- .../@stdlib/array/base/cuany/README.md | 1 - .../@stdlib/array/base/flatten4d-by/README.md | 12 +++++++++ .../@stdlib/array/base/ones3d/README.md | 27 +++++++++++++++++++ .../@stdlib/blas/base/idamax/README.md | 1 - .../@stdlib/blas/ext/base/dsapxsum/README.md | 4 +-- .../@stdlib/math/base/special/acscd/README.md | 20 ++++++++++++++ .../@stdlib/slice/base/slice2seq/README.md | 12 +++++++++ .../@stdlib/slice/base/str2slice/README.md | 12 +++++++++ .../strided/base/offset-view/README.md | 12 +++++++++ 9 files changed, 97 insertions(+), 4 deletions(-) diff --git a/lib/node_modules/@stdlib/array/base/cuany/README.md b/lib/node_modules/@stdlib/array/base/cuany/README.md index 39053f03339f..f372a2d6ea92 100644 --- a/lib/node_modules/@stdlib/array/base/cuany/README.md +++ b/lib/node_modules/@stdlib/array/base/cuany/README.md @@ -108,7 +108,6 @@ console.log( out );
-
diff --git a/lib/node_modules/@stdlib/array/base/flatten4d-by/README.md b/lib/node_modules/@stdlib/array/base/flatten4d-by/README.md index afb799faf9b2..1f98df6bafea 100644 --- a/lib/node_modules/@stdlib/array/base/flatten4d-by/README.md +++ b/lib/node_modules/@stdlib/array/base/flatten4d-by/README.md @@ -184,6 +184,12 @@ out = flatten4dBy( x, [ 2, 2, 2, 2 ], true, fcn );
+* * * + +## See Also + +- [`@stdlib/array/base/flatten4d`][@stdlib/array/base/flatten4d]: flatten a four-dimensional nested array. +
@@ -192,6 +198,12 @@ out = flatten4dBy( x, [ 2, 2, 2, 2 ], true, fcn );
+ + +[@stdlib/array/base/flatten4d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten4d + + +
diff --git a/lib/node_modules/@stdlib/array/base/ones3d/README.md b/lib/node_modules/@stdlib/array/base/ones3d/README.md index 73f70f810960..b53669bdc6ea 100644 --- a/lib/node_modules/@stdlib/array/base/ones3d/README.md +++ b/lib/node_modules/@stdlib/array/base/ones3d/README.md @@ -95,6 +95,17 @@ out = ones3d( [ 1, 3, 1 ] );
+* * * + +## See Also + +- [`@stdlib/array/base/zeros3d`][@stdlib/array/base/zeros3d]: create a zero-filled three-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/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. +- [`@stdlib/array/base/onesnd`][@stdlib/array/base/onesnd]: create an n-dimensional nested array filled with ones. +
@@ -103,6 +114,22 @@ out = ones3d( [ 1, 3, 1 ] );
+ + +[@stdlib/array/base/zeros3d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zeros3d + +[@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/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 + +[@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/blas/base/idamax/README.md b/lib/node_modules/@stdlib/blas/base/idamax/README.md index 0600c90b7bd7..6798076ddaec 100644 --- a/lib/node_modules/@stdlib/blas/base/idamax/README.md +++ b/lib/node_modules/@stdlib/blas/base/idamax/README.md @@ -266,7 +266,6 @@ int main( void ) { -
diff --git a/lib/node_modules/@stdlib/blas/ext/base/dsapxsum/README.md b/lib/node_modules/@stdlib/blas/ext/base/dsapxsum/README.md index 84f8643b1c2d..0c7820c2ff18 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dsapxsum/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/dsapxsum/README.md @@ -280,9 +280,9 @@ int main( void ) { ## See Also -- [`@stdlib/blas/ext/base/dapxsum`][@stdlib/blas/ext/base/dapxsum]: adds a constant to each double-precision floating-point strided array element and computes the sum. +- [`@stdlib/blas/ext/base/dapxsum`][@stdlib/blas/ext/base/dapxsum]: add a scalar constant to each double-precision floating-point strided array element and compute the sum. - [`@stdlib/blas/ext/base/dssum`][@stdlib/blas/ext/base/dssum]: calculate the sum of single-precision floating-point strided array elements using extended accumulation and returning an extended precision result. -- [`@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/sapxsum`][@stdlib/blas/ext/base/sapxsum]: add a constant to each single-precision floating-point strided array element and compute the sum.
diff --git a/lib/node_modules/@stdlib/math/base/special/acscd/README.md b/lib/node_modules/@stdlib/math/base/special/acscd/README.md index 050bc5f3e842..edab4b168bf5 100644 --- a/lib/node_modules/@stdlib/math/base/special/acscd/README.md +++ b/lib/node_modules/@stdlib/math/base/special/acscd/README.md @@ -173,6 +173,16 @@ 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/asecd`][@stdlib/math/base/special/asecd]: compute the arcsecant (in degrees) of a double-precision floating-point number. +- [`@stdlib/math/base/special/asind`][@stdlib/math/base/special/asind]: compute the arcsine (in degrees) of a double-precision floating-point number. +- [`@stdlib/math/base/special/cscd`][@stdlib/math/base/special/cscd]: compute the cosecant of a degree. +
@@ -185,6 +195,16 @@ int main( void ) { +[@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/asecd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/asecd + +[@stdlib/math/base/special/asind]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/asind + +[@stdlib/math/base/special/cscd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/cscd + diff --git a/lib/node_modules/@stdlib/slice/base/slice2seq/README.md b/lib/node_modules/@stdlib/slice/base/slice2seq/README.md index 89a3b9b05789..4145d199eb74 100644 --- a/lib/node_modules/@stdlib/slice/base/slice2seq/README.md +++ b/lib/node_modules/@stdlib/slice/base/slice2seq/README.md @@ -142,6 +142,12 @@ str = slice2seq( new Slice( null, null, -1 ) );
+* * * + +## See Also + +- [`@stdlib/slice/base/seq2slice`][@stdlib/slice/base/seq2slice]: convert a subsequence string to a Slice object. +
@@ -152,6 +158,12 @@ str = slice2seq( new Slice( null, null, -1 ) ); [@stdlib/slice/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/ctor + + +[@stdlib/slice/base/seq2slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/base/seq2slice + + + diff --git a/lib/node_modules/@stdlib/slice/base/str2slice/README.md b/lib/node_modules/@stdlib/slice/base/str2slice/README.md index b1664e2274b0..9d2b5af133c7 100644 --- a/lib/node_modules/@stdlib/slice/base/str2slice/README.md +++ b/lib/node_modules/@stdlib/slice/base/str2slice/README.md @@ -141,6 +141,12 @@ console.log( s );
+* * * + +## See Also + +- [`@stdlib/slice/base/str2multislice`][@stdlib/slice/base/str2multislice]: parse a string-serialized MultiSlice object. +
@@ -151,6 +157,12 @@ console.log( s ); [@stdlib/slice/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/ctor + + +[@stdlib/slice/base/str2multislice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/base/str2multislice + + + diff --git a/lib/node_modules/@stdlib/strided/base/offset-view/README.md b/lib/node_modules/@stdlib/strided/base/offset-view/README.md index 23cccbb81b29..aac9ded99cc0 100644 --- a/lib/node_modules/@stdlib/strided/base/offset-view/README.md +++ b/lib/node_modules/@stdlib/strided/base/offset-view/README.md @@ -139,6 +139,12 @@ var v1 = x[ 1 ];
+* * * + +## See Also + +- [`@stdlib/strided/base/min-view-buffer-index`][@stdlib/strided/base/min-view-buffer-index]: return the minimum accessible index based on a set of provided strided array parameters. +
@@ -147,6 +153,12 @@ var v1 = x[ 1 ];
+ + +[@stdlib/strided/base/min-view-buffer-index]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/min-view-buffer-index + + +