Skip to content

Commit 7423599

Browse files
authored
docs: update namespace table of contents
PR-URL: #6917 Signed-off-by: stdlib-bot <[email protected]>
1 parent 251d680 commit 7423599

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ The namespace contains the following:
7979
- <span class="signature">[`randu( len[, options] )`][@stdlib/random/array/randu]</span><span class="delimiter">: </span><span class="description">create an array containing uniformly distributed pseudorandom numbers between `0` and `1`.</span>
8080
- <span class="signature">[`rayleigh( len, sigma[, options] )`][@stdlib/random/array/rayleigh]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a Rayleigh distribution.</span>
8181
- <span class="signature">[`t( len, v[, options] )`][@stdlib/random/array/t]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a Student's t-distribution.</span>
82+
- <span class="signature">[`tools`][@stdlib/random/array/tools]</span><span class="delimiter">: </span><span class="description">pseudorandom number generator (PRNG) array creation function tools.</span>
8283
- <span class="signature">[`triangular( len, a, b, c[, options] )`][@stdlib/random/array/triangular]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a triangular distribution.</span>
8384
- <span class="signature">[`uniform( len, a, b[, options] )`][@stdlib/random/array/uniform]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a continuous uniform distribution.</span>
8485
- <span class="signature">[`weibull( len, k, lambda[, options] )`][@stdlib/random/array/weibull]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a Weibull distribution.</span>
@@ -223,6 +224,8 @@ out = random( 10 );
223224

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

227+
[@stdlib/random/array/tools]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/tools
228+
226229
[@stdlib/random/array/triangular]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/triangular
227230

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

lib/node_modules/@stdlib/random/tools/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,13 @@ The namespace exports the following:
5353

5454
<!-- <toc pattern="*"> -->
5555

56+
<div class="namespace-toc">
57+
58+
- <span class="signature">[`unaryFactory( prng, idtypes odtypes, policies[, options] )`][@stdlib/random/tools/unary-factory]</span><span class="delimiter">: </span><span class="description">create a function for generating pseudorandom values drawn from a unary PRNG.</span>
59+
- <span class="signature">[`unary( prng, idtypes odtypes, policies[, options] )`][@stdlib/random/tools/unary]</span><span class="delimiter">: </span><span class="description">constructor for creating ndarrays filled with pseudorandom values drawn from a unary PRNG.</span>
60+
61+
</div>
62+
5663
<!-- </toc> -->
5764

5865
</section>
@@ -100,6 +107,14 @@ console.log( objectKeys( ns ) );
100107

101108
<section class="links">
102109

110+
<!-- <toc-links> -->
111+
112+
[@stdlib/random/tools/unary-factory]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/tools/unary-factory
113+
114+
[@stdlib/random/tools/unary]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/tools/unary
115+
116+
<!-- </toc-links> -->
117+
103118
</section>
104119

105120
<!-- /.links -->

0 commit comments

Comments
 (0)