Skip to content

Commit 4a14673

Browse files
authored
docs: update namespace table of contents
PR-URL: #13121 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 8bf9161 commit 4a14673

2 files changed

Lines changed: 18 additions & 0 deletions

File tree

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ var o = ns;
4545

4646
- <span class="signature">[`hasEqualShape( x, y )`][@stdlib/ndarray/base/assert/has-equal-shape]</span><span class="delimiter">: </span><span class="description">test if two ndarrays have the same shape.</span>
4747
- <span class="signature">[`isAllowedDataTypeCast( from, to, casting )`][@stdlib/ndarray/base/assert/is-allowed-data-type-cast]</span><span class="delimiter">: </span><span class="description">determine whether an ndarray data type can be cast to another ndarray data type according to a specified casting mode.</span>
48+
- <span class="signature">[`isBinaryDataType( value )`][@stdlib/ndarray/base/assert/is-binary-data-type]</span><span class="delimiter">: </span><span class="description">test if an input value is a supported ndarray binary data type.</span>
4849
- <span class="signature">[`isBooleanDataType( value )`][@stdlib/ndarray/base/assert/is-boolean-data-type]</span><span class="delimiter">: </span><span class="description">test if an input value is a supported ndarray boolean data type.</span>
4950
- <span class="signature">[`isBooleanIndexDataType( value )`][@stdlib/ndarray/base/assert/is-boolean-index-data-type]</span><span class="delimiter">: </span><span class="description">test if an input value is a supported ndarray boolean index data type.</span>
5051
- <span class="signature">[`isBufferLengthCompatibleShape( len, shape )`][@stdlib/ndarray/base/assert/is-buffer-length-compatible-shape]</span><span class="delimiter">: </span><span class="description">determine if a buffer length is compatible with an array shape.</span>
@@ -61,6 +62,7 @@ var o = ns;
6162
- <span class="signature">[`isDataType( value )`][@stdlib/ndarray/base/assert/is-data-type]</span><span class="delimiter">: </span><span class="description">test if an input value is a supported ndarray data type.</span>
6263
- <span class="signature">[`isEqualDataType( v1, v2 )`][@stdlib/ndarray/base/assert/is-equal-data-type]</span><span class="delimiter">: </span><span class="description">test whether two values are equal ndarray data types.</span>
6364
- <span class="signature">[`isFloatingPointDataType( value )`][@stdlib/ndarray/base/assert/is-floating-point-data-type]</span><span class="delimiter">: </span><span class="description">test if an input value is a supported ndarray floating-point data type.</span>
65+
- <span class="signature">[`isGenericDataType( value )`][@stdlib/ndarray/base/assert/is-generic-data-type]</span><span class="delimiter">: </span><span class="description">test if an input value is a supported ndarray generic data type.</span>
6466
- <span class="signature">[`isIndexDataType( value )`][@stdlib/ndarray/base/assert/is-index-data-type]</span><span class="delimiter">: </span><span class="description">test if an input value is a supported ndarray index data type.</span>
6567
- <span class="signature">[`isIndexMode( value )`][@stdlib/ndarray/base/assert/is-index-mode]</span><span class="delimiter">: </span><span class="description">test if an input value is a supported ndarray index mode.</span>
6668
- <span class="signature">[`isInputCastingPolicy( value )`][@stdlib/ndarray/base/assert/is-input-casting-policy]</span><span class="delimiter">: </span><span class="description">test if an input value is a supported input ndarray casting policy.</span>
@@ -130,6 +132,8 @@ console.log( objectKeys( ns ) );
130132

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

135+
[@stdlib/ndarray/base/assert/is-binary-data-type]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/assert/is-binary-data-type
136+
133137
[@stdlib/ndarray/base/assert/is-boolean-data-type]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/assert/is-boolean-data-type
134138

135139
[@stdlib/ndarray/base/assert/is-boolean-index-data-type]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/assert/is-boolean-index-data-type
@@ -162,6 +166,8 @@ console.log( objectKeys( ns ) );
162166

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

169+
[@stdlib/ndarray/base/assert/is-generic-data-type]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/assert/is-generic-data-type
170+
165171
[@stdlib/ndarray/base/assert/is-index-data-type]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/assert/is-index-data-type
166172

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

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

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

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

56+
<div class="namespace-toc">
57+
58+
- <span class="signature">[`matrix()`][@stdlib/ndarray/matrix/ctor]</span><span class="delimiter">: </span><span class="description">create a matrix (i.e., a two-dimensional ndarray).</span>
59+
60+
</div>
61+
5662
<!-- </toc> -->
5763

5864
</section>
@@ -100,6 +106,12 @@ console.log( objectKeys( ns ) );
100106

101107
<section class="links">
102108

109+
<!-- <toc-links> -->
110+
111+
[@stdlib/ndarray/matrix/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/matrix/ctor
112+
113+
<!-- </toc-links> -->
114+
103115
</section>
104116

105117
<!-- /.links -->

0 commit comments

Comments
 (0)