Skip to content

Commit

Permalink
docs: update related packages sections
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Jan 29, 2024
1 parent 6c3807f commit 05bad62
Show file tree
Hide file tree
Showing 7 changed files with 89 additions and 0 deletions.
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/ndarray/broadcast-array/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@ for ( i = 0; i < N; i++ ) {
## See Also

- <span class="package-name">[`@stdlib/ndarray/array`][@stdlib/ndarray/array]</span><span class="delimiter">: </span><span class="description">multidimensional arrays.</span>
- <span class="package-name">[`@stdlib/ndarray/broadcast-arrays`][@stdlib/ndarray/broadcast-arrays]</span><span class="delimiter">: </span><span class="description">broadcast ndarrays to a common shape.</span>
- <span class="package-name">[`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]</span><span class="delimiter">: </span><span class="description">multidimensional array constructor.</span>
- <span class="package-name">[`@stdlib/ndarray/maybe-broadcast-array`][@stdlib/ndarray/maybe-broadcast-array]</span><span class="delimiter">: </span><span class="description">broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.</span>

Expand All @@ -150,6 +151,8 @@ for ( i = 0; i < N; i++ ) {

[@stdlib/ndarray/array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/array

[@stdlib/ndarray/broadcast-arrays]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/broadcast-arrays

[@stdlib/ndarray/maybe-broadcast-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array

<!-- </related-links> -->
Expand Down
7 changes: 7 additions & 0 deletions lib/node_modules/@stdlib/random/array/geometric/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -357,6 +357,7 @@ logEach( '%f', x4 );
## See Also

- <span class="package-name">[`@stdlib/random/base/geometric`][@stdlib/random/base/geometric]</span><span class="delimiter">: </span><span class="description">geometric distributed pseudorandom numbers.</span>
- <span class="package-name">[`@stdlib/random/strided/geometric`][@stdlib/random/strided/geometric]</span><span class="delimiter">: </span><span class="description">fill a strided array with pseudorandom numbers drawn from a geometric distribution.</span>

</section>

Expand All @@ -374,6 +375,12 @@ logEach( '%f', x4 );

[@stdlib/array/float64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float64

<!-- <related-links> -->

[@stdlib/random/strided/geometric]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided/geometric

<!-- </related-links> -->

</section>

<!-- /.links -->
7 changes: 7 additions & 0 deletions lib/node_modules/@stdlib/random/array/rayleigh/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -357,6 +357,7 @@ logEach( '%f', x4 );
## See Also

- <span class="package-name">[`@stdlib/random/base/rayleigh`][@stdlib/random/base/rayleigh]</span><span class="delimiter">: </span><span class="description">Rayleigh distributed pseudorandom numbers.</span>
- <span class="package-name">[`@stdlib/random/strided/rayleigh`][@stdlib/random/strided/rayleigh]</span><span class="delimiter">: </span><span class="description">fill a strided array with pseudorandom numbers drawn from a Rayleigh distribution.</span>

</section>

Expand All @@ -374,6 +375,12 @@ logEach( '%f', x4 );

[@stdlib/array/float64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float64

<!-- <related-links> -->

[@stdlib/random/strided/rayleigh]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided/rayleigh

<!-- </related-links> -->

</section>

<!-- /.links -->
18 changes: 18 additions & 0 deletions lib/node_modules/@stdlib/random/base/chi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -398,6 +398,14 @@ for ( i = 0; i < 100; i++ ) {

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/random/array/chi`][@stdlib/random/array/chi]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a chi distribution.</span>
- <span class="package-name">[`@stdlib/random/iter/chi`][@stdlib/random/iter/chi]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a chi distribution.</span>
- <span class="package-name">[`@stdlib/random/streams/chi`][@stdlib/random/streams/chi]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating pseudorandom numbers drawn from a chi distribution.</span>

</section>

<!-- /.related -->
Expand All @@ -410,6 +418,16 @@ for ( i = 0; i < 100; i++ ) {

[@stdlib/array/uint32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/uint32

<!-- <related-links> -->

[@stdlib/random/array/chi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/chi

[@stdlib/random/iter/chi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/chi

[@stdlib/random/streams/chi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/chi

<!-- </related-links> -->

</section>

<!-- /.links -->
18 changes: 18 additions & 0 deletions lib/node_modules/@stdlib/random/base/erlang/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -413,6 +413,14 @@ for ( i = 0; i < 100; i++ ) {

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/random/array/erlang`][@stdlib/random/array/erlang]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from an Erlang distribution.</span>
- <span class="package-name">[`@stdlib/random/iter/erlang`][@stdlib/random/iter/erlang]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from an Erlang distribution.</span>
- <span class="package-name">[`@stdlib/random/streams/erlang`][@stdlib/random/streams/erlang]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating pseudorandom numbers drawn from an Erlang distribution.</span>

</section>

<!-- /.related -->
Expand All @@ -425,6 +433,16 @@ for ( i = 0; i < 100; i++ ) {

[@stdlib/array/uint32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/uint32

<!-- <related-links> -->

[@stdlib/random/array/erlang]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/erlang

[@stdlib/random/iter/erlang]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/erlang

[@stdlib/random/streams/erlang]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/erlang

<!-- </related-links> -->

</section>

<!-- /.links -->
18 changes: 18 additions & 0 deletions lib/node_modules/@stdlib/random/base/gumbel/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -401,6 +401,14 @@ for ( i = 0; i < 100; i++ ) {

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/random/array/gumbel`][@stdlib/random/array/gumbel]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a Gumbel distribution.</span>
- <span class="package-name">[`@stdlib/random/iter/gumbel`][@stdlib/random/iter/gumbel]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a Gumbel distribution.</span>
- <span class="package-name">[`@stdlib/random/streams/gumbel`][@stdlib/random/streams/gumbel]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating pseudorandom numbers drawn from a Gumbel distribution.</span>

</section>

<!-- /.related -->
Expand All @@ -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

<!-- <related-links> -->

[@stdlib/random/array/gumbel]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/gumbel

[@stdlib/random/iter/gumbel]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/gumbel

[@stdlib/random/streams/gumbel]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/gumbel

<!-- </related-links> -->

</section>

<!-- /.links -->
18 changes: 18 additions & 0 deletions lib/node_modules/@stdlib/random/base/poisson/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -411,6 +411,14 @@ for ( i = 0; i < 100; i++ ) {

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/random/array/poisson`][@stdlib/random/array/poisson]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a Poisson distribution.</span>
- <span class="package-name">[`@stdlib/random/iter/poisson`][@stdlib/random/iter/poisson]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a Poisson distribution.</span>
- <span class="package-name">[`@stdlib/random/streams/poisson`][@stdlib/random/streams/poisson]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating pseudorandom numbers drawn from a Poisson distribution.</span>

</section>

<!-- /.related -->
Expand All @@ -425,6 +433,16 @@ for ( i = 0; i < 100; i++ ) {

[@stdlib/array/uint32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/uint32

<!-- <related-links> -->

[@stdlib/random/array/poisson]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/poisson

[@stdlib/random/iter/poisson]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/poisson

[@stdlib/random/streams/poisson]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/poisson

<!-- </related-links> -->

</section>

<!-- /.links -->

0 comments on commit 05bad62

Please sign in to comment.