Skip to content

Commit

Permalink
docs: update namespace table of contents
Browse files Browse the repository at this point in the history
Signed-off-by: stdlib-bot <[email protected]>
  • Loading branch information
Planeshifter authored and stdlib-bot committed Feb 25, 2025
1 parent 962e4c7 commit 1c5fcb6
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 3 deletions.
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/math/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ The namespace consists of the following sub-namespaces:

<div class="namespace-toc">

- <span class="signature">[`array`][@stdlib/math/array]</span><span class="delimiter">: </span><span class="description">math functions applied to arrays.</span>
- <span class="signature">[`base`][@stdlib/math/base]</span><span class="delimiter">: </span><span class="description">base (i.e., lower-level) math functions.</span>
- <span class="signature">[`iter`][@stdlib/math/iter]</span><span class="delimiter">: </span><span class="description">math iterators.</span>
- <span class="signature">[`special`][@stdlib/math/special]</span><span class="delimiter">: </span><span class="description">special math functions.</span>
Expand Down Expand Up @@ -92,6 +93,8 @@ console.log( objectKeys( math ) );

<!-- <toc-links> -->

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

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

[@stdlib/math/iter]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/iter
Expand Down
7 changes: 7 additions & 0 deletions lib/node_modules/@stdlib/math/array/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@ The namespace consists of the following sub-namespaces:

<div class="namespace-toc">

- <span class="signature">[`special`][@stdlib/math/array/special]</span><span class="delimiter">: </span><span class="description">special math functions applied to arrays.</span>
- <span class="signature">[`tools`][@stdlib/math/array/tools]</span><span class="delimiter">: </span><span class="description">math array function tools.</span>

</div>

<!-- </toc> -->
Expand Down Expand Up @@ -86,6 +89,10 @@ console.log( objectKeys( ns ) );

<!-- <toc-links> -->

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

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

<!-- </toc-links> -->

</section>
Expand Down
4 changes: 4 additions & 0 deletions lib/node_modules/@stdlib/math/array/special/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ The namespace contains the following:

<div class="namespace-toc">

- <span class="signature">[`abs( x[, options] )`][@stdlib/math/array/special/abs]</span><span class="delimiter">: </span><span class="description">compute the absolute value for each element in an input array.</span>

</div>

<!-- </toc> -->
Expand Down Expand Up @@ -88,6 +90,8 @@ var out = ns.abs( x );

<!-- <toc-links> -->

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

<!-- </toc-links> -->

</section>
Expand Down
7 changes: 7 additions & 0 deletions lib/node_modules/@stdlib/math/array/tools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@ The namespace contains the following:

<div class="namespace-toc">

- <span class="signature">[`unaryFactory( fcn, idtypes, odtypes, policy )`][@stdlib/math/array/tools/unary-factory]</span><span class="delimiter">: </span><span class="description">create a function for applying a unary function to each element in an input array.</span>
- <span class="signature">[`unary( fcn, idtypes, odtypes, policy )`][@stdlib/math/array/tools/unary]</span><span class="delimiter">: </span><span class="description">constructor for applying a unary function to each element in an input array.</span>

</div>

<!-- </toc> -->
Expand Down Expand Up @@ -106,6 +109,10 @@ var out = f.apply( x );

<!-- <toc-links> -->

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

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

<!-- </toc-links> -->

</section>
Expand Down
3 changes: 0 additions & 3 deletions lib/node_modules/@stdlib/math/base/ops/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@ The namespace contains the following functions:
- <span class="signature">[`csubf( z1, z2 )`][@stdlib/math/base/ops/csubf]</span><span class="delimiter">: </span><span class="description">subtract two single-precision complex floating-point numbers.</span>
- <span class="signature">[`imul( a, b )`][@stdlib/math/base/ops/imul]</span><span class="delimiter">: </span><span class="description">perform C-like multiplication of two signed 32-bit integers.</span>
- <span class="signature">[`imuldw( a, b )`][@stdlib/math/base/ops/imuldw]</span><span class="delimiter">: </span><span class="description">compute the double word product of two signed 32-bit integers.</span>
- <span class="signature">[`mulf( x, y )`][@stdlib/number/float32/base/mul]</span><span class="delimiter">: </span><span class="description">multiply two single-precision floating-point numbers.</span>
- <span class="signature">[`subf( x, y )`][@stdlib/math/base/ops/subf]</span><span class="delimiter">: </span><span class="description">subtract two single-precision floating-point numbers.</span>
- <span class="signature">[`umul( a, b )`][@stdlib/math/base/ops/umul]</span><span class="delimiter">: </span><span class="description">perform C-like multiplication of two unsigned 32-bit integers.</span>
- <span class="signature">[`umuldw( a, b )`][@stdlib/math/base/ops/umuldw]</span><span class="delimiter">: </span><span class="description">compute the double word product of two unsigned 32-bit integers.</span>
Expand Down Expand Up @@ -137,8 +136,6 @@ console.log( ns.imuldw( 0x80000000|0, 0x40000000|0 ) );

[@stdlib/math/base/ops/imuldw]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/imuldw

[@stdlib/number/float32/base/mul]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/float32/base/mul

[@stdlib/math/base/ops/subf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/subf

[@stdlib/math/base/ops/umul]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/umul
Expand Down
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/ndarray/base/assert/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ var o = ns;
- <span class="signature">[`isMostlySafeDataTypeCast( from, to )`][@stdlib/ndarray/base/assert/is-mostly-safe-data-type-cast]</span><span class="delimiter">: </span><span class="description">determine whether an ndarray data type can be safely cast or, for floating-point data types, downcast to another ndarray data type.</span>
- <span class="signature">[`isNumericDataType( value )`][@stdlib/ndarray/base/assert/is-numeric-data-type]</span><span class="delimiter">: </span><span class="description">test if an input value is a supported ndarray numeric data type.</span>
- <span class="signature">[`isOrder( value )`][@stdlib/ndarray/base/assert/is-order]</span><span class="delimiter">: </span><span class="description">test if an input value is an ndarray order.</span>
- <span class="signature">[`isOutputDataTypePolicy( value )`][@stdlib/ndarray/base/assert/is-output-data-type-policy]</span><span class="delimiter">: </span><span class="description">test if an input value is a supported ndarray output data type policy.</span>
- <span class="signature">[`isReadOnly( arr )`][@stdlib/ndarray/base/assert/is-read-only]</span><span class="delimiter">: </span><span class="description">test if an ndarray is **read-only**.</span>
- <span class="signature">[`isRealDataType( value )`][@stdlib/ndarray/base/assert/is-real-data-type]</span><span class="delimiter">: </span><span class="description">test if an input value is a supported ndarray real-valued data type.</span>
- <span class="signature">[`isRealFloatingPointDataType( value )`][@stdlib/ndarray/base/assert/is-real-floating-point-data-type]</span><span class="delimiter">: </span><span class="description">test if an input value is a supported ndarray real-valued floating-point data type.</span>
Expand Down Expand Up @@ -150,6 +151,8 @@ console.log( objectKeys( ns ) );

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

[@stdlib/ndarray/base/assert/is-output-data-type-policy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/assert/is-output-data-type-policy

[@stdlib/ndarray/base/assert/is-read-only]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/assert/is-read-only

[@stdlib/ndarray/base/assert/is-real-data-type]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/assert/is-real-data-type
Expand Down

0 comments on commit 1c5fcb6

Please sign in to comment.