Skip to content

Commit aa0fe46

Browse files
stdlib-botstdlib-bot
committed
docs: update related packages sections
1 parent d278dc9 commit aa0fe46

File tree

6 files changed

+76
-0
lines changed

6 files changed

+76
-0
lines changed

‎lib/node_modules/@stdlib/array/from-scalar/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,12 @@ x = array2scalar( {} );
121121

122122
<section class="related">
123123

124+
* * *
125+
126+
## See Also
127+
128+
- <span class="package-name">[`@stdlib/array/from-iterator`][@stdlib/array/from-iterator]</span><span class="delimiter">: </span><span class="description">create (or fill) an array from an iterator.</span>
129+
124130
</section>
125131

126132
<!-- /.related -->
@@ -133,6 +139,12 @@ x = array2scalar( {} );
133139

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

142+
<!-- <related-links> -->
143+
144+
[@stdlib/array/from-iterator]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/from-iterator
145+
146+
<!-- </related-links> -->
147+
136148
</section>
137149

138150
<!-- /.links -->

‎lib/node_modules/@stdlib/array/to-fancy/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -505,6 +505,13 @@ z = y[ i ];
505505

506506
<section class="related">
507507

508+
* * *
509+
510+
## See Also
511+
512+
- <span class="package-name">[`@stdlib/array/slice`][@stdlib/array/slice]</span><span class="delimiter">: </span><span class="description">return a shallow copy of a portion of an array.</span>
513+
- <span class="package-name">[`@stdlib/ndarray/fancy`][@stdlib/ndarray/fancy]</span><span class="delimiter">: </span><span class="description">fancy multidimensional array constructor.</span>
514+
508515
</section>
509516

510517
<!-- /.related -->
@@ -535,6 +542,14 @@ z = y[ i ];
535542

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

545+
<!-- <related-links> -->
546+
547+
[@stdlib/array/slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/slice
548+
549+
[@stdlib/ndarray/fancy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/fancy
550+
551+
<!-- </related-links> -->
552+
538553
</section>
539554

540555
<!-- /.links -->

‎lib/node_modules/@stdlib/ndarray/slice/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -321,6 +321,7 @@ var a8 = ndarray2array( y8 );
321321
## See Also
322322

323323
- <span class="package-name">[`@stdlib/ndarray/array`][@stdlib/ndarray/array]</span><span class="delimiter">: </span><span class="description">multidimensional arrays.</span>
324+
- <span class="package-name">[`@stdlib/ndarray/at`][@stdlib/ndarray/at]</span><span class="delimiter">: </span><span class="description">return an ndarray element.</span>
324325
- <span class="package-name">[`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]</span><span class="delimiter">: </span><span class="description">multidimensional array constructor.</span>
325326
- <span class="package-name">[`@stdlib/ndarray/slice-assign`][@stdlib/ndarray/slice-assign]</span><span class="delimiter">: </span><span class="description">assign element values from a broadcasted input ndarray to corresponding elements in an output ndarray view.</span>
326327
- <span class="package-name">[`@stdlib/ndarray/slice-dimension`][@stdlib/ndarray/slice-dimension]</span><span class="delimiter">: </span><span class="description">return a read-only view of an input ndarray when sliced along a specified dimension.</span>
@@ -343,6 +344,8 @@ var a8 = ndarray2array( y8 );
343344

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

347+
[@stdlib/ndarray/at]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/at
348+
346349
[@stdlib/ndarray/slice-assign]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/slice-assign
347350

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

‎lib/node_modules/@stdlib/random/base/improved-ziggurat/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -375,6 +375,13 @@ for ( i = 0; i < 100; i++ ) {
375375

376376
<section class="related">
377377

378+
* * *
379+
380+
## See Also
381+
382+
- <span class="package-name">[`@stdlib/random/iter/improved-ziggurat`][@stdlib/random/iter/improved-ziggurat]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a standard normal distribution using the Improved Ziggurat algorithm.</span>
383+
- <span class="package-name">[`@stdlib/random/streams/improved-ziggurat`][@stdlib/random/streams/improved-ziggurat]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating pseudorandom numbers drawn from a standard normal distribution using the Improved Ziggurat algorithm.</span>
384+
378385
</section>
379386

380387
<!-- /.related -->
@@ -393,6 +400,14 @@ for ( i = 0; i < 100; i++ ) {
393400

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

403+
<!-- <related-links> -->
404+
405+
[@stdlib/random/iter/improved-ziggurat]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/improved-ziggurat
406+
407+
[@stdlib/random/streams/improved-ziggurat]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/improved-ziggurat
408+
409+
<!-- </related-links> -->
410+
396411
</section>
397412

398413
<!-- /.links -->

‎lib/node_modules/@stdlib/random/base/laplace/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/laplace`][@stdlib/random/array/laplace]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a Laplace (double exponential) distribution.</span>
409+
- <span class="package-name">[`@stdlib/random/iter/laplace`][@stdlib/random/iter/laplace]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a Laplace distribution.</span>
410+
- <span class="package-name">[`@stdlib/random/streams/laplace`][@stdlib/random/streams/laplace]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating pseudorandom numbers drawn from a Laplace (double exponential) 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/laplace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/laplace
427+
428+
[@stdlib/random/iter/laplace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/laplace
429+
430+
[@stdlib/random/streams/laplace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/laplace
431+
432+
<!-- </related-links> -->
433+
416434
</section>
417435

418436
<!-- /.links -->

‎lib/node_modules/@stdlib/random/strided/chi/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -356,6 +356,13 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );
356356

357357
<section class="related">
358358

359+
* * *
360+
361+
## See Also
362+
363+
- <span class="package-name">[`@stdlib/random/base/chi`][@stdlib/random/base/chi]</span><span class="delimiter">: </span><span class="description">Chi distributed pseudorandom numbers.</span>
364+
- <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>
365+
359366
</section>
360367

361368
<!-- /.related -->
@@ -370,6 +377,12 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );
370377

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

380+
<!-- <related-links> -->
381+
382+
[@stdlib/random/array/chi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/chi
383+
384+
<!-- </related-links> -->
385+
373386
</section>
374387

375388
<!-- /.links -->

0 commit comments

Comments
 (0)