Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update related packages sections #1315

Merged
merged 1 commit into from
Feb 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/array/from-scalar/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,12 @@ x = array2scalar( {} );

<section class="related">

* * *

## See Also

- <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>

</section>

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

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

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

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

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

</section>

<!-- /.links -->
15 changes: 15 additions & 0 deletions lib/node_modules/@stdlib/array/to-fancy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -505,6 +505,13 @@ z = y[ i ];

<section class="related">

* * *

## See Also

- <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>
- <span class="package-name">[`@stdlib/ndarray/fancy`][@stdlib/ndarray/fancy]</span><span class="delimiter">: </span><span class="description">fancy multidimensional array constructor.</span>

</section>

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

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

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

[@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

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

</section>

<!-- /.links -->
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/ndarray/slice/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -321,6 +321,7 @@ var a8 = ndarray2array( y8 );
## 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/at`][@stdlib/ndarray/at]</span><span class="delimiter">: </span><span class="description">return an ndarray element.</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/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>
- <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>
Expand All @@ -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
Expand Down
15 changes: 15 additions & 0 deletions lib/node_modules/@stdlib/random/base/improved-ziggurat/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -375,6 +375,13 @@ for ( i = 0; i < 100; i++ ) {

<section class="related">

* * *

## See Also

- <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>
- <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>

</section>

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

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

[@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

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

</section>

<!-- /.links -->
18 changes: 18 additions & 0 deletions lib/node_modules/@stdlib/random/base/laplace/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/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>
- <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>
- <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>

</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/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

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

</section>

<!-- /.links -->
13 changes: 13 additions & 0 deletions lib/node_modules/@stdlib/random/strided/chi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -356,6 +356,13 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );

<section class="related">

* * *

## See Also

- <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>
- <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>

</section>

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

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

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

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

</section>

<!-- /.links -->
Loading