From a2ba71825ddc61c07008496a5b84b099dc67da82 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 7 Dec 2023 02:29:27 +0000 Subject: [PATCH] docs: update related packages sections --- .../assert/is-complex64matrix-like/README.md | 18 ++++++++++++++++ .../@stdlib/math/base/ops/addf/README.md | 3 +++ .../@stdlib/math/base/ops/div/README.md | 18 ++++++++++++++++ .../random/array/discrete-uniform/README.md | 18 ++++++++++++++++ .../@stdlib/random/strided/arcsine/README.md | 13 ++++++++++++ .../@stdlib/slice/seq2slice/README.md | 2 ++ .../@stdlib/string/dotcase/README.md | 21 +++++++++++++++++++ 7 files changed, 93 insertions(+) diff --git a/lib/node_modules/@stdlib/assert/is-complex64matrix-like/README.md b/lib/node_modules/@stdlib/assert/is-complex64matrix-like/README.md index bc3ceaaf22e3..c075e1a9c571 100644 --- a/lib/node_modules/@stdlib/assert/is-complex64matrix-like/README.md +++ b/lib/node_modules/@stdlib/assert/is-complex64matrix-like/README.md @@ -83,6 +83,14 @@ out = isComplex64MatrixLike( null );
+* * * + +## See Also + +- [`@stdlib/assert/is-complex128matrix-like`][@stdlib/assert/is-complex128matrix-like]: test if a value is a 2-dimensional ndarray-like object containing double-precision complex floating-point numbers. +- [`@stdlib/assert/is-ndarray-like`][@stdlib/assert/is-ndarray-like]: test if a value is ndarray-like. +- [`@stdlib/assert/is-matrix-like`][@stdlib/assert/is-matrix-like]: test if a value is a 2-dimensional ndarray-like object. +
@@ -93,6 +101,16 @@ out = isComplex64MatrixLike( null ); [@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor + + +[@stdlib/assert/is-complex128matrix-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-complex128matrix-like + +[@stdlib/assert/is-ndarray-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-ndarray-like + +[@stdlib/assert/is-matrix-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-matrix-like + + + diff --git a/lib/node_modules/@stdlib/math/base/ops/addf/README.md b/lib/node_modules/@stdlib/math/base/ops/addf/README.md index 2e1b2341ca82..00d3b5a47243 100644 --- a/lib/node_modules/@stdlib/math/base/ops/addf/README.md +++ b/lib/node_modules/@stdlib/math/base/ops/addf/README.md @@ -196,6 +196,7 @@ int main( void ) { ## See Also - [`@stdlib/math/base/ops/add`][@stdlib/math/base/ops/add]: compute the sum of two double-precision floating-point numbers. +- [`@stdlib/math/base/ops/divf`][@stdlib/math/base/ops/divf]: divide two single-precision floating-point numbers. - [`@stdlib/math/base/ops/mulf`][@stdlib/math/base/ops/mulf]: multiply two single-precision floating-point numbers. - [`@stdlib/math/base/ops/subf`][@stdlib/math/base/ops/subf]: subtract two single-precision floating-point numbers. @@ -211,6 +212,8 @@ int main( void ) { [@stdlib/math/base/ops/add]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/add +[@stdlib/math/base/ops/divf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/divf + [@stdlib/math/base/ops/mulf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/mulf [@stdlib/math/base/ops/subf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/subf diff --git a/lib/node_modules/@stdlib/math/base/ops/div/README.md b/lib/node_modules/@stdlib/math/base/ops/div/README.md index 2efb831a7f0f..bc2f5d41eb51 100644 --- a/lib/node_modules/@stdlib/math/base/ops/div/README.md +++ b/lib/node_modules/@stdlib/math/base/ops/div/README.md @@ -191,6 +191,14 @@ int main( void ) {
+* * * + +## See Also + +- [`@stdlib/math/base/ops/add`][@stdlib/math/base/ops/add]: compute the sum of two double-precision floating-point numbers. +- [`@stdlib/math/base/ops/mul`][@stdlib/math/base/ops/mul]: multiply two double-precision floating-point numbers. +- [`@stdlib/math/base/ops/sub`][@stdlib/math/base/ops/sub]: subtract two double-precision floating-point numbers. +
@@ -199,6 +207,16 @@ int main( void ) {
+ + +[@stdlib/math/base/ops/add]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/add + +[@stdlib/math/base/ops/mul]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/mul + +[@stdlib/math/base/ops/sub]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/sub + + +
diff --git a/lib/node_modules/@stdlib/random/array/discrete-uniform/README.md b/lib/node_modules/@stdlib/random/array/discrete-uniform/README.md index a41e438a4971..0f5351f76346 100644 --- a/lib/node_modules/@stdlib/random/array/discrete-uniform/README.md +++ b/lib/node_modules/@stdlib/random/array/discrete-uniform/README.md @@ -331,6 +331,14 @@ logEach( '%d', x4 );
+* * * + +## See Also + +- [`@stdlib/random/array/uniform`][@stdlib/random/array/uniform]: create an array containing pseudorandom numbers drawn from a continuous uniform distribution. +- [`@stdlib/random/base/discrete-uniform`][@stdlib/random/base/discrete-uniform]: discrete uniform distributed pseudorandom numbers. +- [`@stdlib/random/strided/discrete-uniform`][@stdlib/random/strided/discrete-uniform]: fill a strided array with pseudorandom numbers drawn from a discrete uniform distribution. +
@@ -347,6 +355,16 @@ logEach( '%d', x4 ); [@stdlib/array/float64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float64 + + +[@stdlib/random/array/uniform]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/uniform + +[@stdlib/random/base/discrete-uniform]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/base/discrete-uniform + +[@stdlib/random/strided/discrete-uniform]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided/discrete-uniform + + + diff --git a/lib/node_modules/@stdlib/random/strided/arcsine/README.md b/lib/node_modules/@stdlib/random/strided/arcsine/README.md index 25e7cf158b24..d712bed380be 100644 --- a/lib/node_modules/@stdlib/random/strided/arcsine/README.md +++ b/lib/node_modules/@stdlib/random/strided/arcsine/README.md @@ -207,6 +207,13 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );
+* * * + +## See Also + +- [`@stdlib/random/base/arcsine`][@stdlib/random/base/arcsine]: arcsine distributed pseudorandom numbers. +- [`@stdlib/random/array/arcsine`][@stdlib/random/array/arcsine]: create an array containing pseudorandom numbers drawn from an arcsine distribution. +
@@ -221,6 +228,12 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 ); [@stdlib/array/uint32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/uint32 + + +[@stdlib/random/array/arcsine]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/arcsine + + + diff --git a/lib/node_modules/@stdlib/slice/seq2slice/README.md b/lib/node_modules/@stdlib/slice/seq2slice/README.md index dd7144f67539..070c8d3f10c1 100644 --- a/lib/node_modules/@stdlib/slice/seq2slice/README.md +++ b/lib/node_modules/@stdlib/slice/seq2slice/README.md @@ -270,6 +270,8 @@ console.log( 'start: %s. stop: %s. step: %s.', s.start, s.stop, s.step ); + + diff --git a/lib/node_modules/@stdlib/string/dotcase/README.md b/lib/node_modules/@stdlib/string/dotcase/README.md index f17c6b730d16..eef498a1d5f4 100644 --- a/lib/node_modules/@stdlib/string/dotcase/README.md +++ b/lib/node_modules/@stdlib/string/dotcase/README.md @@ -162,6 +162,15 @@ foo.bar
+* * * + +## See Also + +- [`@stdlib/string/camelcase`][@stdlib/string/camelcase]: convert a string to camel case. +- [`@stdlib/string/kebabcase`][@stdlib/string/kebabcase]: convert a string to kebab case. +- [`@stdlib/string/pascalcase`][@stdlib/string/pascalcase]: convert a string to Pascal case. +- [`@stdlib/string/snakecase`][@stdlib/string/snakecase]: convert a string to snake case. +
@@ -174,6 +183,18 @@ foo.bar [mdn-regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions + + +[@stdlib/string/camelcase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/camelcase + +[@stdlib/string/kebabcase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/kebabcase + +[@stdlib/string/pascalcase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/pascalcase + +[@stdlib/string/snakecase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/snakecase + + +