Skip to content

Commit 9b8f3a8

Browse files
authored
docs: update namespace table of contents
PR-URL: #6996 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent ffc0d94 commit 9b8f3a8

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

lib/node_modules/@stdlib/ndarray/base/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@ var o = ns;
8989
- <span class="signature">[`ind( idx, max, mode )`][@stdlib/ndarray/base/ind]</span><span class="delimiter">: </span><span class="description">return an index given an index mode.</span>
9090
- <span class="signature">[`ind2sub( shape, strides, offset, order, idx, mode )`][@stdlib/ndarray/base/ind2sub]</span><span class="delimiter">: </span><span class="description">convert a linear index to an array of subscripts.</span>
9191
- <span class="signature">[`iterationOrder( strides )`][@stdlib/ndarray/base/iteration-order]</span><span class="delimiter">: </span><span class="description">given a stride array, determine array iteration order.</span>
92+
- <span class="signature">[`loopOrder( shape, strides )`][@stdlib/ndarray/base/loop-interchange-order]</span><span class="delimiter">: </span><span class="description">reorder ndarray dimensions and associated strides for loop interchange.</span>
9293
- <span class="signature">[`map( arrays, fcn[, thisArg] )`][@stdlib/ndarray/base/map]</span><span class="delimiter">: </span><span class="description">apply a callback function to elements in an input ndarray and assign results to elements in an output ndarray.</span>
9394
- <span class="signature">[`maxViewBufferIndex( shape, strides, offset )`][@stdlib/ndarray/base/max-view-buffer-index]</span><span class="delimiter">: </span><span class="description">compute the maximum linear index in an underlying data buffer accessible to an array view.</span>
9495
- <span class="signature">[`maybeBroadcastArray( arr, shape )`][@stdlib/ndarray/base/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>
@@ -310,6 +311,8 @@ console.log( objectKeys( ns ) );
310311

311312
[@stdlib/ndarray/base/iteration-order]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/iteration-order
312313

314+
[@stdlib/ndarray/base/loop-interchange-order]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/loop-interchange-order
315+
313316
[@stdlib/ndarray/base/map]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/map
314317

315318
[@stdlib/ndarray/base/max-view-buffer-index]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/max-view-buffer-index

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ The namespace exports the following:
5555

5656
<div class="namespace-toc">
5757

58+
- <span class="signature">[`binary( prng, idtypes, odtypes, policies[, options] )`][@stdlib/random/tools/binary]</span><span class="delimiter">: </span><span class="description">constructor for creating ndarrays filled with pseudorandom values drawn from a binary PRNG.</span>
5859
- <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>
5960
- <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>
6061

@@ -109,6 +110,8 @@ console.log( objectKeys( ns ) );
109110

110111
<!-- <toc-links> -->
111112

113+
[@stdlib/random/tools/binary]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/tools/binary
114+
112115
[@stdlib/random/tools/unary-factory]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/tools/unary-factory
113116

114117
[@stdlib/random/tools/unary]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/tools/unary

0 commit comments

Comments
 (0)