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 Dec 10, 2023
1 parent 783804d commit 47feb95
Show file tree
Hide file tree
Showing 7 changed files with 78 additions and 0 deletions.
2 changes: 2 additions & 0 deletions lib/node_modules/@stdlib/blas/base/gnrm2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,8 @@ console.log( out );

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



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

</section>
Expand Down
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/math/base/ops/mulf/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,7 @@ int main( void ) {
## See Also

- <span class="package-name">[`@stdlib/math/base/ops/addf`][@stdlib/math/base/ops/addf]</span><span class="delimiter">: </span><span class="description">compute the sum of two single-precision floating-point numbers.</span>
- <span class="package-name">[`@stdlib/math/base/ops/divf`][@stdlib/math/base/ops/divf]</span><span class="delimiter">: </span><span class="description">divide two single-precision floating-point numbers.</span>
- <span class="package-name">[`@stdlib/math/base/ops/mul`][@stdlib/math/base/ops/mul]</span><span class="delimiter">: </span><span class="description">multiply two double-precision floating-point numbers.</span>
- <span class="package-name">[`@stdlib/math/base/ops/subf`][@stdlib/math/base/ops/subf]</span><span class="delimiter">: </span><span class="description">subtract two single-precision floating-point numbers.</span>

Expand All @@ -211,6 +212,8 @@ int main( void ) {

[@stdlib/math/base/ops/addf]: https:/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/addf

[@stdlib/math/base/ops/divf]: https:/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/divf

[@stdlib/math/base/ops/mul]: https:/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/mul

[@stdlib/math/base/ops/subf]: https:/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/subf
Expand Down
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/number/float64/base/to-int32/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,12 @@ for ( i = 0; i < 500; i++ ) {

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/number/float64/base/to-uint32`][@stdlib/number/float64/base/to-uint32]</span><span class="delimiter">: </span><span class="description">convert a double-precision floating-point number to an unsigned 32-bit integer.</span>

</section>

<!-- /.related -->
Expand All @@ -103,6 +109,12 @@ for ( i = 0; i < 500; i++ ) {

[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985

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

[@stdlib/number/float64/base/to-uint32]: https:/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/float64/base/to-uint32

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

</section>

<!-- /.links -->
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,12 @@ for ( i = 0; i < 54; i++ ) {

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/number/float64/base/to-int32`][@stdlib/number/float64/base/to-int32]</span><span class="delimiter">: </span><span class="description">convert a double-precision floating-point number to a signed 32-bit integer.</span>

</section>

<!-- /.related -->
Expand All @@ -117,6 +123,12 @@ for ( i = 0; i < 54; i++ ) {

[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985

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

[@stdlib/number/float64/base/to-int32]: https:/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/float64/base/to-int32

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

</section>

<!-- /.links -->
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/number/float64/base/to-uint32/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,12 @@ for ( i = 0; i < 500; i++ ) {

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/number/float64/base/to-int32`][@stdlib/number/float64/base/to-int32]</span><span class="delimiter">: </span><span class="description">convert a double-precision floating-point number to a signed 32-bit integer.</span>

</section>

<!-- /.related -->
Expand All @@ -105,6 +111,12 @@ for ( i = 0; i < 500; i++ ) {

[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985

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

[@stdlib/number/float64/base/to-int32]: https:/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/float64/base/to-int32

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

</section>

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

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/random/base/minstd-shuffle`][@stdlib/random/base/minstd-shuffle]</span><span class="delimiter">: </span><span class="description">A linear congruential pseudorandom number generator (LCG) whose output is shuffled.</span>
- <span class="package-name">[`@stdlib/random/array/minstd-shuffle`][@stdlib/random/array/minstd-shuffle]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers generated using a linear congruential pseudorandom number generator (LCG) whose output is shuffled.</span>
- <span class="package-name">[`@stdlib/random/strided/minstd`][@stdlib/random/strided/minstd]</span><span class="delimiter">: </span><span class="description">fill a strided array with pseudorandom numbers generated using a linear congruential pseudorandom number generator (LCG).</span>
- <span class="package-name">[`@stdlib/random/strided/randu`][@stdlib/random/strided/randu]</span><span class="delimiter">: </span><span class="description">fill a strided array with uniformly distributed pseudorandom numbers between 0 and 1.</span>

</section>

<!-- /.related -->
Expand All @@ -237,6 +246,16 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );

[@stdlib/array/int32]: https:/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/int32

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

[@stdlib/random/array/minstd-shuffle]: https:/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/minstd-shuffle

[@stdlib/random/strided/minstd]: https:/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided/minstd

[@stdlib/random/strided/randu]: https:/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided/randu

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

</section>

<!-- /.links -->
18 changes: 18 additions & 0 deletions lib/node_modules/@stdlib/string/base/for-each/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,14 @@ forEach( '\uD834\uDD1E', log );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/string/base/for-each-code-point`][@stdlib/string/base/for-each-code-point]</span><span class="delimiter">: </span><span class="description">invoke a function for each Unicode code point in a string.</span>
- <span class="package-name">[`@stdlib/string/base/for-each-grapheme-cluster`][@stdlib/string/base/for-each-grapheme-cluster]</span><span class="delimiter">: </span><span class="description">invoke a function for each grapheme cluster (i.e., user-perceived character) in a string.</span>
- <span class="package-name">[`@stdlib/string/for-each`][@stdlib/string/for-each]</span><span class="delimiter">: </span><span class="description">invoke a function for each character in a string.</span>

</section>

<!-- /.related -->
Expand All @@ -141,6 +149,16 @@ forEach( '\uD834\uDD1E', log );

<section class="links">

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

[@stdlib/string/base/for-each-code-point]: https:/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/for-each-code-point

[@stdlib/string/base/for-each-grapheme-cluster]: https:/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/for-each-grapheme-cluster

[@stdlib/string/for-each]: https:/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/for-each

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

</section>

<!-- /.links -->

0 comments on commit 47feb95

Please sign in to comment.