From 918089cf25ef95468b3e570653f246c9d7ea822e Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Tue, 10 Dec 2024 03:01:19 +0000 Subject: [PATCH] docs: update related packages sections --- .../@stdlib/array/base/flatten2d/README.md | 12 +++++++++ .../@stdlib/array/base/flatten3d-by/README.md | 12 +++++++++ .../@stdlib/array/base/fliplr3d/README.md | 18 +++++++++++++ .../@stdlib/array/base/zeros2d/README.md | 27 +++++++++++++++++++ .../@stdlib/array/place/README.md | 18 +++++++++++++ .../@stdlib/assert/has-btoa-support/README.md | 12 +++++++++ .../@stdlib/blas/base/dasum/README.md | 2 +- .../blas/ext/base/dapxsumkbn/README.md | 6 ++--- .../@stdlib/iter/do-while-each/README.md | 18 +++++++++++++ .../base/nonreduced-dimensions/README.md | 18 +++++++++++++ .../@stdlib/stats/levene-test/README.md | 2 +- .../@stdlib/string/base/dotcase/README.md | 21 +++++++++++++++ 12 files changed, 161 insertions(+), 5 deletions(-) diff --git a/lib/node_modules/@stdlib/array/base/flatten2d/README.md b/lib/node_modules/@stdlib/array/base/flatten2d/README.md index fadaa81818f5..46a7018a3f91 100644 --- a/lib/node_modules/@stdlib/array/base/flatten2d/README.md +++ b/lib/node_modules/@stdlib/array/base/flatten2d/README.md @@ -139,6 +139,12 @@ out = flatten2d( x, [ 4, 4 ], true );
+* * * + +## See Also + +- [`@stdlib/array/base/flatten2d-by`][@stdlib/array/base/flatten2d-by]: flatten a two-dimensional nested array according to a callback function. +
@@ -147,6 +153,12 @@ out = flatten2d( x, [ 4, 4 ], true );
+ + +[@stdlib/array/base/flatten2d-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten2d-by + + +
diff --git a/lib/node_modules/@stdlib/array/base/flatten3d-by/README.md b/lib/node_modules/@stdlib/array/base/flatten3d-by/README.md index d61670b91dfe..338ff7ca1eef 100644 --- a/lib/node_modules/@stdlib/array/base/flatten3d-by/README.md +++ b/lib/node_modules/@stdlib/array/base/flatten3d-by/README.md @@ -185,6 +185,12 @@ out = flatten3dBy( x, [ 4, 2, 2 ], true, fcn );
+* * * + +## See Also + +- [`@stdlib/array/base/flatten3d`][@stdlib/array/base/flatten3d]: flatten a three-dimensional nested array. +
@@ -193,6 +199,12 @@ out = flatten3dBy( x, [ 4, 2, 2 ], true, fcn );
+ + +[@stdlib/array/base/flatten3d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten3d + + +
diff --git a/lib/node_modules/@stdlib/array/base/fliplr3d/README.md b/lib/node_modules/@stdlib/array/base/fliplr3d/README.md index 21eebf5e4566..fe11d15e0dc2 100644 --- a/lib/node_modules/@stdlib/array/base/fliplr3d/README.md +++ b/lib/node_modules/@stdlib/array/base/fliplr3d/README.md @@ -97,6 +97,14 @@ console.log( y );
+* * * + +## See Also + +- [`@stdlib/array/base/fliplr2d`][@stdlib/array/base/fliplr2d]: reverse the order of elements along the last dimension of a two-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/fliplr2d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/fliplr2d + +[@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/zeros2d/README.md b/lib/node_modules/@stdlib/array/base/zeros2d/README.md index 45a36caa1513..9ac7b0641d38 100644 --- a/lib/node_modules/@stdlib/array/base/zeros2d/README.md +++ b/lib/node_modules/@stdlib/array/base/zeros2d/README.md @@ -103,6 +103,17 @@ console.log( arr );
+* * * + +## See Also + +- [`@stdlib/array/base/zeros`][@stdlib/array/base/zeros]: create a zero-filled generic array. +- [`@stdlib/array/base/ones2d`][@stdlib/array/base/ones2d]: create a two-dimensional nested array filled with ones. +- [`@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. +- [`@stdlib/array/base/zerosnd`][@stdlib/array/base/zerosnd]: create a zero-filled n-dimensional nested array. +
@@ -111,6 +122,22 @@ console.log( arr );
+ + +[@stdlib/array/base/zeros]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zeros + +[@stdlib/array/base/ones2d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/ones2d + +[@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 + +[@stdlib/array/base/zerosnd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zerosnd + + +
diff --git a/lib/node_modules/@stdlib/array/place/README.md b/lib/node_modules/@stdlib/array/place/README.md index adf94ca59a19..705c0f6fc56c 100644 --- a/lib/node_modules/@stdlib/array/place/README.md +++ b/lib/node_modules/@stdlib/array/place/README.md @@ -146,6 +146,14 @@ console.log( out );
+* * * + +## See Also + +- [`@stdlib/array/mskput`][@stdlib/array/mskput]: replace elements of an array with provided values according to a provided mask array. +- [`@stdlib/array/put`][@stdlib/array/put]: replace specified elements of an array with provided values. +- [`@stdlib/array/take`][@stdlib/array/take]: take elements from an array. +
@@ -160,6 +168,16 @@ console.log( out ); [@stdlib/array/same-kind-casts]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/same-kind-casts + + +[@stdlib/array/mskput]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/mskput + +[@stdlib/array/put]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/put + +[@stdlib/array/take]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/take + + + diff --git a/lib/node_modules/@stdlib/assert/has-btoa-support/README.md b/lib/node_modules/@stdlib/assert/has-btoa-support/README.md index e589c45eaabf..3a8b0cc57809 100644 --- a/lib/node_modules/@stdlib/assert/has-btoa-support/README.md +++ b/lib/node_modules/@stdlib/assert/has-btoa-support/README.md @@ -108,6 +108,12 @@ $ has-btoa-support
+* * * + +## See Also + +- [`@stdlib/assert/has-atob-support`][@stdlib/assert/has-atob-support]: detect native atob support. +
@@ -118,6 +124,12 @@ $ has-btoa-support [mdn-btoa]: https://developer.mozilla.org/en-US/docs/Web/API/Window/btoa + + +[@stdlib/assert/has-atob-support]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/has-atob-support + + + diff --git a/lib/node_modules/@stdlib/blas/base/dasum/README.md b/lib/node_modules/@stdlib/blas/base/dasum/README.md index 985daee97205..8effa69bb48a 100644 --- a/lib/node_modules/@stdlib/blas/base/dasum/README.md +++ b/lib/node_modules/@stdlib/blas/base/dasum/README.md @@ -301,7 +301,7 @@ int main( void ) { ## See Also -- [`@stdlib/blas/base/daxpy`][@stdlib/blas/base/daxpy]: multiply a vector x by a constant and add the result to y. +- [`@stdlib/blas/base/daxpy`][@stdlib/blas/base/daxpy]: multiply a vector `x` by a constant and add the result to `y`. - [`@stdlib/blas/base/gasum`][@stdlib/blas/base/gasum]: compute the sum of absolute values (L1 norm). - [`@stdlib/blas/base/sasum`][@stdlib/blas/base/sasum]: compute the sum of absolute values (L1 norm). - [`@stdlib/blas/ext/base/dsum`][@stdlib/blas/ext/base/dsum]: calculate the sum of double-precision floating-point strided array elements. diff --git a/lib/node_modules/@stdlib/blas/ext/base/dapxsumkbn/README.md b/lib/node_modules/@stdlib/blas/ext/base/dapxsumkbn/README.md index 69b401b8368e..1b1afe9a0d9d 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dapxsumkbn/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/dapxsumkbn/README.md @@ -283,10 +283,10 @@ 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/dsumkbn`][@stdlib/blas/ext/base/dsumkbn]: calculate the sum of double-precision floating-point strided array elements using an improved Kahan–Babuška algorithm. -- [`@stdlib/blas/ext/base/gapxsumkbn`][@stdlib/blas/ext/base/gapxsumkbn]: adds a constant to each strided array element and computes the sum using an improved Kahan–Babuška algorithm. -- [`@stdlib/blas/ext/base/sapxsumkbn`][@stdlib/blas/ext/base/sapxsumkbn]: adds a constant to each single-precision floating-point strided array element and computes the sum using an improved Kahan–Babuška algorithm. +- [`@stdlib/blas/ext/base/gapxsumkbn`][@stdlib/blas/ext/base/gapxsumkbn]: add a constant to each strided array element and compute the sum using an improved Kahan–Babuška algorithm. +- [`@stdlib/blas/ext/base/sapxsumkbn`][@stdlib/blas/ext/base/sapxsumkbn]: add a constant to each single-precision floating-point strided array element and compute the sum using an improved Kahan–Babuška algorithm. diff --git a/lib/node_modules/@stdlib/iter/do-while-each/README.md b/lib/node_modules/@stdlib/iter/do-while-each/README.md index 6fdef20c1353..6c0a7d178c96 100644 --- a/lib/node_modules/@stdlib/iter/do-while-each/README.md +++ b/lib/node_modules/@stdlib/iter/do-while-each/README.md @@ -226,6 +226,14 @@ while ( true ) {
+* * * + +## See Also + +- [`@stdlib/iter/do-until-each`][@stdlib/iter/do-until-each]: create an iterator which, while a test condition is false, invokes a function for each iterated value before returning the iterated value. +- [`@stdlib/iter/until-each`][@stdlib/iter/until-each]: create an iterator which, while a test condition is false, invokes a function for each iterated value before returning the iterated value. +- [`@stdlib/iter/while-each`][@stdlib/iter/while-each]: create an iterator which, while a test condition is true, invokes a function for each iterated value before returning the iterated value. +
@@ -234,6 +242,16 @@ while ( true ) {
+ + +[@stdlib/iter/do-until-each]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/do-until-each + +[@stdlib/iter/until-each]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/until-each + +[@stdlib/iter/while-each]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/while-each + + +
diff --git a/lib/node_modules/@stdlib/slice/base/nonreduced-dimensions/README.md b/lib/node_modules/@stdlib/slice/base/nonreduced-dimensions/README.md index 939768b84494..410566c47aa2 100644 --- a/lib/node_modules/@stdlib/slice/base/nonreduced-dimensions/README.md +++ b/lib/node_modules/@stdlib/slice/base/nonreduced-dimensions/README.md @@ -123,6 +123,14 @@ console.log( '%s => [%s]', s.toString(), out.join( ',' ) );
+* * * + +## See Also + +- [`@stdlib/slice/base/length`][@stdlib/slice/base/length]: compute the number of elements in a normalized slice. +- [`@stdlib/slice/base/reduced-dimensions`][@stdlib/slice/base/reduced-dimensions]: return a list of reduced dimensions in an un-normalized multi-slice. +- [`@stdlib/slice/base/shape`][@stdlib/slice/base/shape]: compute the shape of a normalized multi-slice. +
@@ -133,6 +141,16 @@ console.log( '%s => [%s]', s.toString(), out.join( ',' ) ); [@stdlib/slice/multi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/multi + + +[@stdlib/slice/base/length]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/base/length + +[@stdlib/slice/base/reduced-dimensions]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/base/reduced-dimensions + +[@stdlib/slice/base/shape]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/base/shape + + + diff --git a/lib/node_modules/@stdlib/stats/levene-test/README.md b/lib/node_modules/@stdlib/stats/levene-test/README.md index fba43d1b48f3..bef68827fdaa 100644 --- a/lib/node_modules/@stdlib/stats/levene-test/README.md +++ b/lib/node_modules/@stdlib/stats/levene-test/README.md @@ -197,7 +197,7 @@ var table = out.print(); ## See Also -- [`@stdlib/stats/vartest`][@stdlib/stats/vartest]: two-sample F-test for equal variances +- [`@stdlib/stats/vartest`][@stdlib/stats/vartest]: two-sample F-test for equal variances. - [`@stdlib/stats/bartlett-test`][@stdlib/stats/bartlett-test]: Bartlett’s test for equal variances. diff --git a/lib/node_modules/@stdlib/string/base/dotcase/README.md b/lib/node_modules/@stdlib/string/base/dotcase/README.md index 3dcee73044b5..aea38bfc0ca8 100644 --- a/lib/node_modules/@stdlib/string/base/dotcase/README.md +++ b/lib/node_modules/@stdlib/string/base/dotcase/README.md @@ -89,6 +89,15 @@ out = dotcase( str );
+* * * + +## See Also + +- [`@stdlib/string/base/camelcase`][@stdlib/string/base/camelcase]: convert a string to camel case. +- [`@stdlib/string/base/lowercase`][@stdlib/string/base/lowercase]: convert a string to lowercase. +- [`@stdlib/string/base/snakecase`][@stdlib/string/base/snakecase]: convert a string to snake case. +- [`@stdlib/string/base/uppercase`][@stdlib/string/base/uppercase]: convert a string to uppercase. +
@@ -97,6 +106,18 @@ out = dotcase( str );
+ + +[@stdlib/string/base/camelcase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/camelcase + +[@stdlib/string/base/lowercase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/lowercase + +[@stdlib/string/base/snakecase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/snakecase + +[@stdlib/string/base/uppercase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/uppercase + + +