Skip to content

Commit 9d532b5

Browse files
docs: update namespace table of contents
PR-URL: #5438 Co-authored-by: Philipp Burckhardt <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]> Signed-off-by: stdlib-bot <[email protected]>
1 parent 7e8f02d commit 9d532b5

File tree

6 files changed

+24
-3
lines changed

6 files changed

+24
-3
lines changed

lib/node_modules/@stdlib/math/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ The namespace consists of the following sub-namespaces:
4545

4646
<div class="namespace-toc">
4747

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

9394
<!-- <toc-links> -->
9495

96+
[@stdlib/math/array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/array
97+
9598
[@stdlib/math/base]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base
9699

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

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,9 @@ The namespace consists of the following sub-namespaces:
4545

4646
<div class="namespace-toc">
4747

48+
- <span class="signature">[`special`][@stdlib/math/array/special]</span><span class="delimiter">: </span><span class="description">special math functions applied to arrays.</span>
49+
- <span class="signature">[`tools`][@stdlib/math/array/tools]</span><span class="delimiter">: </span><span class="description">math array function tools.</span>
50+
4851
</div>
4952

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

8790
<!-- <toc-links> -->
8891

92+
[@stdlib/math/array/special]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/array/special
93+
94+
[@stdlib/math/array/tools]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/array/tools
95+
8996
<!-- </toc-links> -->
9097

9198
</section>

lib/node_modules/@stdlib/math/array/special/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@ The namespace contains the following:
4545

4646
<div class="namespace-toc">
4747

48+
- <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>
49+
4850
</div>
4951

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

8991
<!-- <toc-links> -->
9092

93+
[@stdlib/math/array/special/abs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/array/special/abs
94+
9195
<!-- </toc-links> -->
9296

9397
</section>

lib/node_modules/@stdlib/math/array/tools/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,9 @@ The namespace contains the following:
4545

4646
<div class="namespace-toc">
4747

48+
- <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>
49+
- <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>
50+
4851
</div>
4952

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

107110
<!-- <toc-links> -->
108111

112+
[@stdlib/math/array/tools/unary-factory]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/array/tools/unary-factory
113+
114+
[@stdlib/math/array/tools/unary]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/array/tools/unary
115+
109116
<!-- </toc-links> -->
110117

111118
</section>

lib/node_modules/@stdlib/math/base/ops/README.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,6 @@ The namespace contains the following functions:
5252
- <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>
5353
- <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>
5454
- <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>
55-
- <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>
5655
- <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>
5756
- <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>
5857
- <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>
@@ -137,8 +136,6 @@ console.log( ns.imuldw( 0x80000000|0, 0x40000000|0 ) );
137136

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

140-
[@stdlib/number/float32/base/mul]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/float32/base/mul
141-
142139
[@stdlib/math/base/ops/subf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/subf
143140

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

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ var o = ns;
6161
- <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>
6262
- <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>
6363
- <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>
64+
- <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>
6465
- <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>
6566
- <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>
6667
- <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>
@@ -150,6 +151,8 @@ console.log( objectKeys( ns ) );
150151

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

154+
[@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
155+
153156
[@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
154157

155158
[@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

0 commit comments

Comments
 (0)