Skip to content

Commit 42b1c7e

Browse files
authored
docs: update related packages sections
PR-URL: #1290 Reviewed-by: Philipp Burckhardt <[email protected]>
1 parent 6c3807f commit 42b1c7e

File tree

7 files changed

+89
-0
lines changed

7 files changed

+89
-0
lines changed

lib/node_modules/@stdlib/ndarray/broadcast-array/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,7 @@ for ( i = 0; i < N; i++ ) {
131131
## See Also
132132

133133
- <span class="package-name">[`@stdlib/ndarray/array`][@stdlib/ndarray/array]</span><span class="delimiter">: </span><span class="description">multidimensional arrays.</span>
134+
- <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>
134135
- <span class="package-name">[`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]</span><span class="delimiter">: </span><span class="description">multidimensional array constructor.</span>
135136
- <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>
136137

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

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

154+
[@stdlib/ndarray/broadcast-arrays]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/broadcast-arrays
155+
153156
[@stdlib/ndarray/maybe-broadcast-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array
154157

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

lib/node_modules/@stdlib/random/array/geometric/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -357,6 +357,7 @@ logEach( '%f', x4 );
357357
## See Also
358358

359359
- <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>
360+
- <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>
360361

361362
</section>
362363

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

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

378+
<!-- <related-links> -->
379+
380+
[@stdlib/random/strided/geometric]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided/geometric
381+
382+
<!-- </related-links> -->
383+
377384
</section>
378385

379386
<!-- /.links -->

lib/node_modules/@stdlib/random/array/rayleigh/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -357,6 +357,7 @@ logEach( '%f', x4 );
357357
## See Also
358358

359359
- <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>
360+
- <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>
360361

361362
</section>
362363

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

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

378+
<!-- <related-links> -->
379+
380+
[@stdlib/random/strided/rayleigh]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided/rayleigh
381+
382+
<!-- </related-links> -->
383+
377384
</section>
378385

379386
<!-- /.links -->

lib/node_modules/@stdlib/random/base/chi/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -398,6 +398,14 @@ for ( i = 0; i < 100; i++ ) {
398398

399399
<section class="related">
400400

401+
* * *
402+
403+
## See Also
404+
405+
- <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>
406+
- <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>
407+
- <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>
408+
401409
</section>
402410

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

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

421+
<!-- <related-links> -->
422+
423+
[@stdlib/random/array/chi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/chi
424+
425+
[@stdlib/random/iter/chi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/chi
426+
427+
[@stdlib/random/streams/chi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/chi
428+
429+
<!-- </related-links> -->
430+
413431
</section>
414432

415433
<!-- /.links -->

lib/node_modules/@stdlib/random/base/erlang/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -413,6 +413,14 @@ for ( i = 0; i < 100; i++ ) {
413413

414414
<section class="related">
415415

416+
* * *
417+
418+
## See Also
419+
420+
- <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>
421+
- <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>
422+
- <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>
423+
416424
</section>
417425

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

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

436+
<!-- <related-links> -->
437+
438+
[@stdlib/random/array/erlang]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/erlang
439+
440+
[@stdlib/random/iter/erlang]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/erlang
441+
442+
[@stdlib/random/streams/erlang]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/erlang
443+
444+
<!-- </related-links> -->
445+
428446
</section>
429447

430448
<!-- /.links -->

lib/node_modules/@stdlib/random/base/gumbel/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -401,6 +401,14 @@ for ( i = 0; i < 100; i++ ) {
401401

402402
<section class="related">
403403

404+
* * *
405+
406+
## See Also
407+
408+
- <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>
409+
- <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>
410+
- <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>
411+
404412
</section>
405413

406414
<!-- /.related -->
@@ -413,6 +421,16 @@ for ( i = 0; i < 100; i++ ) {
413421

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

424+
<!-- <related-links> -->
425+
426+
[@stdlib/random/array/gumbel]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/gumbel
427+
428+
[@stdlib/random/iter/gumbel]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/gumbel
429+
430+
[@stdlib/random/streams/gumbel]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/gumbel
431+
432+
<!-- </related-links> -->
433+
416434
</section>
417435

418436
<!-- /.links -->

lib/node_modules/@stdlib/random/base/poisson/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -411,6 +411,14 @@ for ( i = 0; i < 100; i++ ) {
411411

412412
<section class="related">
413413

414+
* * *
415+
416+
## See Also
417+
418+
- <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>
419+
- <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>
420+
- <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>
421+
414422
</section>
415423

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

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

436+
<!-- <related-links> -->
437+
438+
[@stdlib/random/array/poisson]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/poisson
439+
440+
[@stdlib/random/iter/poisson]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/poisson
441+
442+
[@stdlib/random/streams/poisson]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/poisson
443+
444+
<!-- </related-links> -->
445+
428446
</section>
429447

430448
<!-- /.links -->

0 commit comments

Comments
 (0)