Skip to content

Commit d7ff4d9

Browse files
authored
docs: update namespace table of contents
PR-URL: #7116 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 2385da4 commit d7ff4d9

File tree

1 file changed

+6
-0
lines changed
  • lib/node_modules/@stdlib/ndarray/base

1 file changed

+6
-0
lines changed

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ var o = ns;
6060
- <span class="signature">[`bytesPerElement( dtype )`][@stdlib/ndarray/base/bytes-per-element]</span><span class="delimiter">: </span><span class="description">return the number of bytes per element provided an underlying array data type.</span>
6161
- <span class="signature">[`char2dtype( [ch] )`][@stdlib/ndarray/base/char2dtype]</span><span class="delimiter">: </span><span class="description">return the data type string associated with a provided single letter character abbreviation.</span>
6262
- <span class="signature">[`clampIndex( idx, max )`][@stdlib/ndarray/base/clamp-index]</span><span class="delimiter">: </span><span class="description">restrict an index to the interval `[0,max]`.</span>
63+
- <span class="signature">[`countTruthy( arrays )`][@stdlib/ndarray/base/count-truthy]</span><span class="delimiter">: </span><span class="description">count the number of truthy elements in an ndarray.</span>
6364
- <span class="signature">[`ndarray( dtype, buffer, shape, strides, offset, order )`][@stdlib/ndarray/base/ctor]</span><span class="delimiter">: </span><span class="description">create a multidimensional array.</span>
6465
- <span class="signature">[`data( x )`][@stdlib/ndarray/base/data-buffer]</span><span class="delimiter">: </span><span class="description">return the underlying data buffer of a provided ndarray.</span>
6566
- <span class="signature">[`dtypeChar( [dtype] )`][@stdlib/ndarray/base/dtype-char]</span><span class="delimiter">: </span><span class="description">return the single letter abbreviation for an underlying array data type.</span>
@@ -153,6 +154,7 @@ var o = ns;
153154
- <span class="signature">[`unaryReduceStrided1dDispatchFactory( table, idtypes, odtypes, policies )`][@stdlib/ndarray/base/unary-reduce-strided1d-dispatch-factory]</span><span class="delimiter">: </span><span class="description">create a function for performing a reduction on an input ndarray.</span>
154155
- <span class="signature">[`unaryReduceStrided1dDispatch( table, idtypes, odtypes, policies )`][@stdlib/ndarray/base/unary-reduce-strided1d-dispatch]</span><span class="delimiter">: </span><span class="description">constructor for performing a reduction on an input ndarray.</span>
155156
- <span class="signature">[`unaryReduceStrided1d( fcn, arrays, dims[, options] )`][@stdlib/ndarray/base/unary-reduce-strided1d]</span><span class="delimiter">: </span><span class="description">perform a reduction over a list of specified dimensions in an input ndarray via a one-dimensional strided array reduction function and assign results to a provided output ndarray.</span>
157+
- <span class="signature">[`unaryReduceSubarrayBy( fcn, arrays, dims[, options], clbk[, thisArg] )`][@stdlib/ndarray/base/unary-reduce-subarray-by]</span><span class="delimiter">: </span><span class="description">perform a reduction over a list of specified dimensions in an input ndarray according to a callback function and assign results to a provided output ndarray.</span>
156158
- <span class="signature">[`unaryReduceSubarray( fcn, arrays, dims[, options] )`][@stdlib/ndarray/base/unary-reduce-subarray]</span><span class="delimiter">: </span><span class="description">perform a reduction over a list of specified dimensions in an input ndarray and assign results to a provided output ndarray.</span>
157159
- <span class="signature">[`unaryStrided1dDispatchFactory( table, idtypes, odtypes, policies[, options] )`][@stdlib/ndarray/base/unary-strided1d-dispatch-factory]</span><span class="delimiter">: </span><span class="description">create a function for applying a strided function an input ndarray.</span>
158160
- <span class="signature">[`unaryStrided1dDispatch( table, idtypes, odtypes, policies[, options] )`][@stdlib/ndarray/base/unary-strided1d-dispatch]</span><span class="delimiter">: </span><span class="description">constructor for applying a strided function to an input ndarray.</span>
@@ -253,6 +255,8 @@ console.log( objectKeys( ns ) );
253255

254256
[@stdlib/ndarray/base/clamp-index]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/clamp-index
255257

258+
[@stdlib/ndarray/base/count-truthy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/count-truthy
259+
256260
[@stdlib/ndarray/base/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/ctor
257261

258262
[@stdlib/ndarray/base/data-buffer]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/data-buffer
@@ -439,6 +443,8 @@ console.log( objectKeys( ns ) );
439443

440444
[@stdlib/ndarray/base/unary-reduce-strided1d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/unary-reduce-strided1d
441445

446+
[@stdlib/ndarray/base/unary-reduce-subarray-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/unary-reduce-subarray-by
447+
442448
[@stdlib/ndarray/base/unary-reduce-subarray]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/unary-reduce-subarray
443449

444450
[@stdlib/ndarray/base/unary-strided1d-dispatch-factory]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/unary-strided1d-dispatch-factory

0 commit comments

Comments
 (0)