From aa0fe466325a7c854acd3f7a213eb200e331ff88 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Wed, 14 Feb 2024 02:21:16 +0000 Subject: [PATCH] docs: update related packages sections --- .../@stdlib/array/from-scalar/README.md | 12 ++++++++++++ .../@stdlib/array/to-fancy/README.md | 15 +++++++++++++++ .../@stdlib/ndarray/slice/README.md | 3 +++ .../random/base/improved-ziggurat/README.md | 15 +++++++++++++++ .../@stdlib/random/base/laplace/README.md | 18 ++++++++++++++++++ .../@stdlib/random/strided/chi/README.md | 13 +++++++++++++ 6 files changed, 76 insertions(+) diff --git a/lib/node_modules/@stdlib/array/from-scalar/README.md b/lib/node_modules/@stdlib/array/from-scalar/README.md index 47040c9c693..ab3e99aa922 100644 --- a/lib/node_modules/@stdlib/array/from-scalar/README.md +++ b/lib/node_modules/@stdlib/array/from-scalar/README.md @@ -121,6 +121,12 @@ x = array2scalar( {} );
+* * * + +## See Also + +- [`@stdlib/array/from-iterator`][@stdlib/array/from-iterator]: create (or fill) an array from an iterator. +
@@ -133,6 +139,12 @@ x = array2scalar( {} ); [@stdlib/array/defaults]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/defaults + + +[@stdlib/array/from-iterator]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/from-iterator + + + diff --git a/lib/node_modules/@stdlib/array/to-fancy/README.md b/lib/node_modules/@stdlib/array/to-fancy/README.md index 598345956b8..388f0c8b695 100644 --- a/lib/node_modules/@stdlib/array/to-fancy/README.md +++ b/lib/node_modules/@stdlib/array/to-fancy/README.md @@ -505,6 +505,13 @@ z = y[ i ];
+* * * + +## See Also + +- [`@stdlib/array/slice`][@stdlib/array/slice]: return a shallow copy of a portion of an array. +- [`@stdlib/ndarray/fancy`][@stdlib/ndarray/fancy]: fancy multidimensional array constructor. +
@@ -535,6 +542,14 @@ z = y[ i ]; [@stdlib/array/dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/dtypes + + +[@stdlib/array/slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/slice + +[@stdlib/ndarray/fancy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/fancy + + + diff --git a/lib/node_modules/@stdlib/ndarray/slice/README.md b/lib/node_modules/@stdlib/ndarray/slice/README.md index 188888ae46a..b3bfad8fdf2 100644 --- a/lib/node_modules/@stdlib/ndarray/slice/README.md +++ b/lib/node_modules/@stdlib/ndarray/slice/README.md @@ -321,6 +321,7 @@ var a8 = ndarray2array( y8 ); ## See Also - [`@stdlib/ndarray/array`][@stdlib/ndarray/array]: multidimensional arrays. +- [`@stdlib/ndarray/at`][@stdlib/ndarray/at]: return an ndarray element. - [`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]: multidimensional array constructor. - [`@stdlib/ndarray/slice-assign`][@stdlib/ndarray/slice-assign]: assign element values from a broadcasted input ndarray to corresponding elements in an output ndarray view. - [`@stdlib/ndarray/slice-dimension`][@stdlib/ndarray/slice-dimension]: return a read-only view of an input ndarray when sliced along a specified dimension. @@ -343,6 +344,8 @@ var a8 = ndarray2array( y8 ); [@stdlib/ndarray/array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/array +[@stdlib/ndarray/at]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/at + [@stdlib/ndarray/slice-assign]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/slice-assign [@stdlib/ndarray/slice-dimension]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/slice-dimension diff --git a/lib/node_modules/@stdlib/random/base/improved-ziggurat/README.md b/lib/node_modules/@stdlib/random/base/improved-ziggurat/README.md index abf38e63ac8..42bc5b2df19 100644 --- a/lib/node_modules/@stdlib/random/base/improved-ziggurat/README.md +++ b/lib/node_modules/@stdlib/random/base/improved-ziggurat/README.md @@ -375,6 +375,13 @@ for ( i = 0; i < 100; i++ ) {
+* * * + +## See Also + +- [`@stdlib/random/iter/improved-ziggurat`][@stdlib/random/iter/improved-ziggurat]: create an iterator for generating pseudorandom numbers drawn from a standard normal distribution using the Improved Ziggurat algorithm. +- [`@stdlib/random/streams/improved-ziggurat`][@stdlib/random/streams/improved-ziggurat]: create a readable stream for generating pseudorandom numbers drawn from a standard normal distribution using the Improved Ziggurat algorithm. +
@@ -393,6 +400,14 @@ for ( i = 0; i < 100; i++ ) { [@stdlib/array/uint32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/uint32 + + +[@stdlib/random/iter/improved-ziggurat]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/improved-ziggurat + +[@stdlib/random/streams/improved-ziggurat]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/improved-ziggurat + + + diff --git a/lib/node_modules/@stdlib/random/base/laplace/README.md b/lib/node_modules/@stdlib/random/base/laplace/README.md index 3e1148f8e12..9877e41b2c1 100644 --- a/lib/node_modules/@stdlib/random/base/laplace/README.md +++ b/lib/node_modules/@stdlib/random/base/laplace/README.md @@ -401,6 +401,14 @@ for ( i = 0; i < 100; i++ ) {
+* * * + +## See Also + +- [`@stdlib/random/array/laplace`][@stdlib/random/array/laplace]: create an array containing pseudorandom numbers drawn from a Laplace (double exponential) distribution. +- [`@stdlib/random/iter/laplace`][@stdlib/random/iter/laplace]: create an iterator for generating pseudorandom numbers drawn from a Laplace distribution. +- [`@stdlib/random/streams/laplace`][@stdlib/random/streams/laplace]: create a readable stream for generating pseudorandom numbers drawn from a Laplace (double exponential) distribution. +
@@ -413,6 +421,16 @@ for ( i = 0; i < 100; i++ ) { [@stdlib/array/uint32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/uint32 + + +[@stdlib/random/array/laplace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/laplace + +[@stdlib/random/iter/laplace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/laplace + +[@stdlib/random/streams/laplace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/laplace + + + diff --git a/lib/node_modules/@stdlib/random/strided/chi/README.md b/lib/node_modules/@stdlib/random/strided/chi/README.md index ff45497d805..1557eebbc48 100644 --- a/lib/node_modules/@stdlib/random/strided/chi/README.md +++ b/lib/node_modules/@stdlib/random/strided/chi/README.md @@ -356,6 +356,13 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );
+* * * + +## See Also + +- [`@stdlib/random/base/chi`][@stdlib/random/base/chi]: Chi distributed pseudorandom numbers. +- [`@stdlib/random/array/chi`][@stdlib/random/array/chi]: create an array containing pseudorandom numbers drawn from a chi distribution. +
@@ -370,6 +377,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/chi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/chi + + +