From 5f090b8b0e9ce58862e2cf6a8d91c0d8ad745275 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Wed, 11 Dec 2024 02:58:59 +0000 Subject: [PATCH] docs: update related packages sections --- .../array/base/cartesian-power/README.md | 18 +++++++++++++++ .../@stdlib/blas/base/daxpy/README.md | 4 ++-- .../@stdlib/blas/ext/base/sapxsum/README.md | 6 ++--- .../@stdlib/math/base/special/acsc/README.md | 3 +++ .../@stdlib/math/base/special/asecd/README.md | 17 ++++++++++++++ .../@stdlib/math/base/special/cotd/README.md | 14 ++++++++++++ .../@stdlib/math/base/special/cscd/README.md | 11 ++++++++++ .../math/base/special/maxabsn/README.md | 14 ++++++++++++ .../@stdlib/math/base/special/maxn/README.md | 3 +++ .../math/base/special/minabsn/README.md | 14 ++++++++++++ .../strided/special/besselj1-by/README.md | 18 +++++++++++++++ .../@stdlib/ndarray/iter/stacks/README.md | 22 +++++++++++++++++++ .../string/base/replace-before/README.md | 18 +++++++++++++++ 13 files changed, 157 insertions(+), 5 deletions(-) diff --git a/lib/node_modules/@stdlib/array/base/cartesian-power/README.md b/lib/node_modules/@stdlib/array/base/cartesian-power/README.md index 6d2f0a1fa8cf..4e59329e87f9 100644 --- a/lib/node_modules/@stdlib/array/base/cartesian-power/README.md +++ b/lib/node_modules/@stdlib/array/base/cartesian-power/README.md @@ -89,6 +89,14 @@ var out = cartesianPower( x, 3 );
+* * * + +## See Also + +- [`@stdlib/array/cartesian-power`][@stdlib/array/cartesian-power]: return the Cartesian power. +- [`@stdlib/array/base/cartesian-product`][@stdlib/array/base/cartesian-product]: return the Cartesian product. +- [`@stdlib/array/base/cartesian-square`][@stdlib/array/base/cartesian-square]: return the Cartesian square. +
@@ -99,6 +107,16 @@ var out = cartesianPower( x, 3 ); [cartesian-product]: https://en.wikipedia.org/wiki/Cartesian_product + + +[@stdlib/array/cartesian-power]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/cartesian-power + +[@stdlib/array/base/cartesian-product]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/cartesian-product + +[@stdlib/array/base/cartesian-square]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/cartesian-square + + + diff --git a/lib/node_modules/@stdlib/blas/base/daxpy/README.md b/lib/node_modules/@stdlib/blas/base/daxpy/README.md index 264cb253bf18..44fece16fd6c 100644 --- a/lib/node_modules/@stdlib/blas/base/daxpy/README.md +++ b/lib/node_modules/@stdlib/blas/base/daxpy/README.md @@ -308,8 +308,8 @@ int main( void ) { ## See Also - [`@stdlib/blas/base/dasum`][@stdlib/blas/base/dasum]: compute the sum of absolute values (L1 norm). -- [`@stdlib/blas/base/gaxpy`][@stdlib/blas/base/gaxpy]: multiply x by a constant and add the result to y. -- [`@stdlib/blas/base/saxpy`][@stdlib/blas/base/saxpy]: multiply a vector x by a constant and add the result to y. +- [`@stdlib/blas/base/gaxpy`][@stdlib/blas/base/gaxpy]: multiply a vector `x` by a constant and add the result to `y`. +- [`@stdlib/blas/base/saxpy`][@stdlib/blas/base/saxpy]: multiply a vector `x` by a constant and add the result to `y`. diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/README.md b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/README.md index 7c7e27ae3ca7..3b335687ccc9 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/README.md @@ -157,9 +157,9 @@ console.log( x ); ## 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/gapxsum`][@stdlib/blas/ext/base/gapxsum]: adds a constant to each strided array element and computes the sum. -- [`@stdlib/blas/ext/base/sapxsumpw`][@stdlib/blas/ext/base/sapxsumpw]: adds a constant to each single-precision floating-point strided array element and computes the sum using pairwise summation. +- [`@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/gapxsum`][@stdlib/blas/ext/base/gapxsum]: add a constant to each strided array element and compute the sum. +- [`@stdlib/blas/ext/base/sapxsumpw`][@stdlib/blas/ext/base/sapxsumpw]: add a constant to each single-precision floating-point strided array element and compute the sum using pairwise summation. - [`@stdlib/blas/ext/base/ssum`][@stdlib/blas/ext/base/ssum]: calculate the sum of single-precision floating-point strided array elements. diff --git a/lib/node_modules/@stdlib/math/base/special/acsc/README.md b/lib/node_modules/@stdlib/math/base/special/acsc/README.md index 890e365de435..c116b1dc1758 100644 --- a/lib/node_modules/@stdlib/math/base/special/acsc/README.md +++ b/lib/node_modules/@stdlib/math/base/special/acsc/README.md @@ -172,6 +172,7 @@ int main( void ) { - [`@stdlib/math/base/special/acsch`][@stdlib/math/base/special/acsch]: compute the hyperbolic arccosecant of a number. - [`@stdlib/math/base/special/asec`][@stdlib/math/base/special/asec]: compute the inverse (arc) secant of a number. - [`@stdlib/math/base/special/asin`][@stdlib/math/base/special/asin]: compute the arcsine of a double-precision floating-point number. +- [`@stdlib/math/base/special/csc`][@stdlib/math/base/special/csc]: compute the cosecant of a number. @@ -193,6 +194,8 @@ int main( void ) { [@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/csc]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/csc + diff --git a/lib/node_modules/@stdlib/math/base/special/asecd/README.md b/lib/node_modules/@stdlib/math/base/special/asecd/README.md index 96ef982d38b6..e39ace36bc55 100644 --- a/lib/node_modules/@stdlib/math/base/special/asecd/README.md +++ b/lib/node_modules/@stdlib/math/base/special/asecd/README.md @@ -173,6 +173,15 @@ int main( void ) {
+* * * + +## See Also + +- [`@stdlib/math/base/special/asec`][@stdlib/math/base/special/asec]: compute the inverse (arc) secant of a number. +- [`@stdlib/math/base/special/asech`][@stdlib/math/base/special/asech]: compute the hyperbolic arcsecant of a number. +- [`@stdlib/math/base/special/acosd`][@stdlib/math/base/special/acosd]: compute the arccosine (in degrees) of a double-precision floating-point number. +- [`@stdlib/math/base/special/secd`][@stdlib/math/base/special/secd]: compute the secant of an angle measured in degrees. +
@@ -185,6 +194,14 @@ int main( void ) { +[@stdlib/math/base/special/asec]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/asec + +[@stdlib/math/base/special/asech]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/asech + +[@stdlib/math/base/special/acosd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/acosd + +[@stdlib/math/base/special/secd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/secd + diff --git a/lib/node_modules/@stdlib/math/base/special/cotd/README.md b/lib/node_modules/@stdlib/math/base/special/cotd/README.md index eb2a1098fdb6..f7d9201c3bb9 100644 --- a/lib/node_modules/@stdlib/math/base/special/cotd/README.md +++ b/lib/node_modules/@stdlib/math/base/special/cotd/README.md @@ -170,6 +170,14 @@ int main( void ) {
+* * * + +## See Also + +- [`@stdlib/math/base/special/cscd`][@stdlib/math/base/special/cscd]: compute the cosecant of a degree. +- [`@stdlib/math/base/special/secd`][@stdlib/math/base/special/secd]: compute the secant of an angle measured in degrees. +- [`@stdlib/math/base/special/tand`][@stdlib/math/base/special/tand]: compute the tangent of an angle measured in degrees. +
@@ -182,6 +190,12 @@ int main( void ) { +[@stdlib/math/base/special/cscd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/cscd + +[@stdlib/math/base/special/secd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/secd + +[@stdlib/math/base/special/tand]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/tand + diff --git a/lib/node_modules/@stdlib/math/base/special/cscd/README.md b/lib/node_modules/@stdlib/math/base/special/cscd/README.md index bed790f4ffb1..5dd7572de5f3 100644 --- a/lib/node_modules/@stdlib/math/base/special/cscd/README.md +++ b/lib/node_modules/@stdlib/math/base/special/cscd/README.md @@ -172,6 +172,13 @@ int main( void ) {
+* * * + +## See Also + +- [`@stdlib/math/base/special/cotd`][@stdlib/math/base/special/cotd]: compute the cotangent of an angle measured in degrees. +- [`@stdlib/math/base/special/secd`][@stdlib/math/base/special/secd]: compute the secant of an angle measured in degrees. +
@@ -184,6 +191,10 @@ int main( void ) { +[@stdlib/math/base/special/cotd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/cotd + +[@stdlib/math/base/special/secd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/secd + diff --git a/lib/node_modules/@stdlib/math/base/special/maxabsn/README.md b/lib/node_modules/@stdlib/math/base/special/maxabsn/README.md index fb4212440ac9..b2a615659104 100644 --- a/lib/node_modules/@stdlib/math/base/special/maxabsn/README.md +++ b/lib/node_modules/@stdlib/math/base/special/maxabsn/README.md @@ -129,6 +129,14 @@ for ( i = 0; i < 100; i++ ) {
+* * * + +## See Also + +- [`@stdlib/math/base/special/maxn`][@stdlib/math/base/special/maxn]: return the maximum value. +- [`@stdlib/math/base/special/maxabs`][@stdlib/math/base/special/maxabs]: return the maximum absolute value. +- [`@stdlib/math/base/special/minabsn`][@stdlib/math/base/special/minabsn]: return the minimum absolute value. +
@@ -139,6 +147,12 @@ for ( i = 0; i < 100; i++ ) { +[@stdlib/math/base/special/maxn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/maxn + +[@stdlib/math/base/special/maxabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/maxabs + +[@stdlib/math/base/special/minabsn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/minabsn + diff --git a/lib/node_modules/@stdlib/math/base/special/maxn/README.md b/lib/node_modules/@stdlib/math/base/special/maxn/README.md index 88389d6046e3..6a88f1cf1e4d 100644 --- a/lib/node_modules/@stdlib/math/base/special/maxn/README.md +++ b/lib/node_modules/@stdlib/math/base/special/maxn/README.md @@ -134,6 +134,7 @@ for ( i = 0; i < 100; i++ ) { ## See Also - [`@stdlib/math/base/special/max`][@stdlib/math/base/special/max]: return the maximum value. +- [`@stdlib/math/base/special/maxabsn`][@stdlib/math/base/special/maxabsn]: return the maximum absolute value. - [`@stdlib/math/base/special/minn`][@stdlib/math/base/special/minn]: return the minimum value. @@ -148,6 +149,8 @@ for ( i = 0; i < 100; i++ ) { [@stdlib/math/base/special/max]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/max +[@stdlib/math/base/special/maxabsn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/maxabsn + [@stdlib/math/base/special/minn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/minn diff --git a/lib/node_modules/@stdlib/math/base/special/minabsn/README.md b/lib/node_modules/@stdlib/math/base/special/minabsn/README.md index 7fac04d6f8b7..0e5778fd1b87 100644 --- a/lib/node_modules/@stdlib/math/base/special/minabsn/README.md +++ b/lib/node_modules/@stdlib/math/base/special/minabsn/README.md @@ -129,6 +129,14 @@ for ( i = 0; i < 100; i++ ) {
+* * * + +## See Also + +- [`@stdlib/math/base/special/maxabsn`][@stdlib/math/base/special/maxabsn]: return the maximum absolute value. +- [`@stdlib/math/base/special/minn`][@stdlib/math/base/special/minn]: return the minimum value. +- [`@stdlib/math/base/special/minabs`][@stdlib/math/base/special/minabs]: return the minimum absolute value. +
@@ -139,6 +147,12 @@ for ( i = 0; i < 100; i++ ) { +[@stdlib/math/base/special/maxabsn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/maxabsn + +[@stdlib/math/base/special/minn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/minn + +[@stdlib/math/base/special/minabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/minabs + diff --git a/lib/node_modules/@stdlib/math/strided/special/besselj1-by/README.md b/lib/node_modules/@stdlib/math/strided/special/besselj1-by/README.md index 51ffd432f014..621870a1d818 100644 --- a/lib/node_modules/@stdlib/math/strided/special/besselj1-by/README.md +++ b/lib/node_modules/@stdlib/math/strided/special/besselj1-by/README.md @@ -229,6 +229,14 @@ console.log( y );
+* * * + +## See Also + +- [`@stdlib/math/strided/special/besselj0-by`][@stdlib/math/strided/special/besselj0-by]: compute the Bessel function of the first kind of order zero for each element retrieved from an input strided array via a callback function. +- [`@stdlib/math/strided/special/bessely0-by`][@stdlib/math/strided/special/bessely0-by]: compute the Bessel function of the second kind of order zero for each element retrieved from an input strided array via a callback function. +- [`@stdlib/math/strided/special/bessely1-by`][@stdlib/math/strided/special/bessely1-by]: compute the Bessel function of the second kind of order one for each element retrieved from an input strided array via a callback function. +
@@ -243,6 +251,16 @@ console.log( y ); [@stdlib/math/base/special/besselj1]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/besselj1 + + +[@stdlib/math/strided/special/besselj0-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/special/besselj0-by + +[@stdlib/math/strided/special/bessely0-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/special/bessely0-by + +[@stdlib/math/strided/special/bessely1-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/special/bessely1-by + + + diff --git a/lib/node_modules/@stdlib/ndarray/iter/stacks/README.md b/lib/node_modules/@stdlib/ndarray/iter/stacks/README.md index 4ccc15458cec..3db605266786 100644 --- a/lib/node_modules/@stdlib/ndarray/iter/stacks/README.md +++ b/lib/node_modules/@stdlib/ndarray/iter/stacks/README.md @@ -195,6 +195,16 @@ while ( true ) {
+* * * + +## See Also + +- [`@stdlib/ndarray/iter/columns`][@stdlib/ndarray/iter/columns]: create an iterator which iterates over each column in a matrix (or stack of matrices). +- [`@stdlib/ndarray/iter/matrices`][@stdlib/ndarray/iter/matrices]: create an iterator which iterates over each matrix in a stack of matrices. +- [`@stdlib/ndarray/iter/rows`][@stdlib/ndarray/iter/rows]: create an iterator which iterates over each row in a matrix (or stack of matrices). +- [`@stdlib/ndarray/iter/subarrays`][@stdlib/ndarray/iter/subarrays]: create an iterator which iterates over each subarray in a stack of subarrays. +- [`@stdlib/ndarray/slice`][@stdlib/ndarray/slice]: return a read-only view of an input ndarray. +
@@ -209,6 +219,18 @@ while ( true ) { [@stdlib/ndarray/slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/slice + + +[@stdlib/ndarray/iter/columns]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/columns + +[@stdlib/ndarray/iter/matrices]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/matrices + +[@stdlib/ndarray/iter/rows]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/rows + +[@stdlib/ndarray/iter/subarrays]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/subarrays + + + diff --git a/lib/node_modules/@stdlib/string/base/replace-before/README.md b/lib/node_modules/@stdlib/string/base/replace-before/README.md index 12a41c3094ab..bba719a804ca 100644 --- a/lib/node_modules/@stdlib/string/base/replace-before/README.md +++ b/lib/node_modules/@stdlib/string/base/replace-before/README.md @@ -124,6 +124,14 @@ out = replaceBefore( '', 'xyz', 'foo', 0 );
+* * * + +## See Also + +- [`@stdlib/string/base/replace-after`][@stdlib/string/base/replace-after]: replace the substring after the first occurrence of a specified search string. +- [`@stdlib/string/base/replace-before-last`][@stdlib/string/base/replace-before-last]: replace the substring before the last occurrence of a specified search string. +- [`@stdlib/string/base/replace-after-last`][@stdlib/string/base/replace-after-last]: replace the substring after the last occurrence of a specified search string. +
@@ -132,6 +140,16 @@ out = replaceBefore( '', 'xyz', 'foo', 0 );
+ + +[@stdlib/string/base/replace-after]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/replace-after + +[@stdlib/string/base/replace-before-last]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/replace-before-last + +[@stdlib/string/base/replace-after-last]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/replace-after-last + + +