Skip to content

Commit 85b305e

Browse files
github-actions[bot]Planeshifter
github-actions[bot]
and
Planeshifter
authored
Update namespace table of contents (#504)
Co-authored-by: Planeshifter <Planeshifter@users.noreply.github.com>
1 parent a67b3ec commit 85b305e

File tree

21 files changed

+429
-17
lines changed

21 files changed

+429
-17
lines changed

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

Lines changed: 66 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ The namespace contains functions to create arrays pre-filled with spaced values:
9494

9595
- <span class="signature">[`datespace( start, stop[, length][, opts] )`][@stdlib/array/datespace]</span><span class="delimiter">: </span><span class="description">generate an array of linearly spaced dates.</span>
9696
- <span class="signature">[`incrspace( start, stop[, increment] )`][@stdlib/array/incrspace]</span><span class="delimiter">: </span><span class="description">generate a linearly spaced numeric array using a provided increment.</span>
97-
- <span class="signature">[`linspace( start, stop[, length] )`][@stdlib/array/linspace]</span><span class="delimiter">: </span><span class="description">generate a linearly spaced numeric array.</span>
97+
- <span class="signature">[`linspace( start, stop, length[, options] )`][@stdlib/array/linspace]</span><span class="delimiter">: </span><span class="description">generate a linearly spaced array over a specified interval.</span>
9898
- <span class="signature">[`logspace( a, b[, length] )`][@stdlib/array/logspace]</span><span class="delimiter">: </span><span class="description">generate a logarithmically spaced numeric array.</span>
9999

100100
</div>
@@ -108,8 +108,14 @@ You can use the following functions to retrieve a list of available data types:
108108
<div class="namespace-toc">
109109

110110
- <span class="signature">[`arrayDataTypes()`][@stdlib/array/dtypes]</span><span class="delimiter">: </span><span class="description">list of array data types.</span>
111-
- <span class="signature">[`typedarrayComplexDataTypes()`][@stdlib/array/typed-complex-dtypes]</span><span class="delimiter">: </span><span class="description">list of complex typed array data types.</span>
111+
- <span class="signature">[`complexarrayDataTypes()`][@stdlib/array/typed-complex-dtypes]</span><span class="delimiter">: </span><span class="description">list of complex typed array data types.</span>
112112
- <span class="signature">[`typedarrayDataTypes()`][@stdlib/array/typed-dtypes]</span><span class="delimiter">: </span><span class="description">list of typed array data types.</span>
113+
- <span class="signature">[`floatarrayDataTypes()`][@stdlib/array/typed-float-dtypes]</span><span class="delimiter">: </span><span class="description">list of typed array floating-point data types.</span>
114+
- <span class="signature">[`intarrayDataTypes()`][@stdlib/array/typed-integer-dtypes]</span><span class="delimiter">: </span><span class="description">list of typed array integer data types.</span>
115+
- <span class="signature">[`realarrayDataTypes()`][@stdlib/array/typed-real-dtypes]</span><span class="delimiter">: </span><span class="description">list of typed array data types.</span>
116+
- <span class="signature">[`realarrayFloatDataTypes()`][@stdlib/array/typed-real-float-dtypes]</span><span class="delimiter">: </span><span class="description">list of typed array real-valued floating-point data types.</span>
117+
- <span class="signature">[`intarraySignedDataTypes()`][@stdlib/array/typed-signed-integer-dtypes]</span><span class="delimiter">: </span><span class="description">list of typed array signed integer data types.</span>
118+
- <span class="signature">[`intarrayUnsignedDataTypes()`][@stdlib/array/typed-unsigned-integer-dtypes]</span><span class="delimiter">: </span><span class="description">list of typed array unsigned integer data types.</span>
113119

114120
</div>
115121

@@ -127,8 +133,14 @@ Furthermore, the namespace contains utility functions to retrieve a given constr
127133
<div class="namespace-toc">
128134

129135
- <span class="signature">[`arrayCtors( dtype )`][@stdlib/array/ctors]</span><span class="delimiter">: </span><span class="description">array constructors.</span>
130-
- <span class="signature">[`typedarrayComplexCtors( dtype )`][@stdlib/array/typed-complex-ctors]</span><span class="delimiter">: </span><span class="description">complex typed array constructors.</span>
136+
- <span class="signature">[`complexarrayCtors( dtype )`][@stdlib/array/typed-complex-ctors]</span><span class="delimiter">: </span><span class="description">complex typed array constructors.</span>
131137
- <span class="signature">[`typedarrayCtors( dtype )`][@stdlib/array/typed-ctors]</span><span class="delimiter">: </span><span class="description">typed array constructors.</span>
138+
- <span class="signature">[`floatarrayCtors( dtype )`][@stdlib/array/typed-float-ctors]</span><span class="delimiter">: </span><span class="description">floating-point typed array constructors.</span>
139+
- <span class="signature">[`intarrayCtors( dtype )`][@stdlib/array/typed-integer-ctors]</span><span class="delimiter">: </span><span class="description">integer-valued typed array constructors.</span>
140+
- <span class="signature">[`realarrayCtors( dtype )`][@stdlib/array/typed-real-ctors]</span><span class="delimiter">: </span><span class="description">typed array constructors.</span>
141+
- <span class="signature">[`realarrayFloatCtors( dtype )`][@stdlib/array/typed-real-float-ctors]</span><span class="delimiter">: </span><span class="description">real-valued floating-point typed array constructors.</span>
142+
- <span class="signature">[`intarraySignedCtors( dtype )`][@stdlib/array/typed-signed-integer-ctors]</span><span class="delimiter">: </span><span class="description">signed integer typed array constructors.</span>
143+
- <span class="signature">[`intarrayUnsignedCtors( dtype )`][@stdlib/array/typed-unsigned-integer-ctors]</span><span class="delimiter">: </span><span class="description">unsigned integer typed array constructors.</span>
132144

133145
</div>
134146

@@ -148,6 +160,7 @@ Lastly, the namespace contains various other functions for dealing with arrays,
148160

149161
<div class="namespace-toc">
150162

163+
- <span class="signature">[`base`][@stdlib/array/base]</span><span class="delimiter">: </span><span class="description">base (i.e., lower-level) array utilities.</span>
151164
- <span class="signature">[`Complex128Array()`][@stdlib/array/complex128]</span><span class="delimiter">: </span><span class="description">128-bit complex number array.</span>
152165
- <span class="signature">[`Complex64Array()`][@stdlib/array/complex64]</span><span class="delimiter">: </span><span class="description">64-bit complex number array.</span>
153166
- <span class="signature">[`convertArraySame( x, y )`][@stdlib/array/convert-same]</span><span class="delimiter">: </span><span class="description">convert an array to the same data type as a second input array.</span>
@@ -157,8 +170,12 @@ Lastly, the namespace contains various other functions for dealing with arrays,
157170
- <span class="signature">[`filledarrayBy()`][@stdlib/array/filled-by]</span><span class="delimiter">: </span><span class="description">create a filled array according to a provided callback function.</span>
158171
- <span class="signature">[`filledarray()`][@stdlib/array/filled]</span><span class="delimiter">: </span><span class="description">create a filled array.</span>
159172
- <span class="signature">[`iterator2array( iterator[, out][, mapFcn[, thisArg]] )`][@stdlib/array/from-iterator]</span><span class="delimiter">: </span><span class="description">create (or fill) an array from an iterator.</span>
173+
- <span class="signature">[`afullLike( x, value[, dtype] )`][@stdlib/array/full-like]</span><span class="delimiter">: </span><span class="description">create a filled array having the same length and data type as a provided array.</span>
174+
- <span class="signature">[`afull( length, value[, dtype] )`][@stdlib/array/full]</span><span class="delimiter">: </span><span class="description">create a filled array having a specified length.</span>
160175
- <span class="signature">[`arrayMinDataType( value )`][@stdlib/array/min-dtype]</span><span class="delimiter">: </span><span class="description">determine the minimum array data type of the closest "kind" necessary for storing a provided scalar value.</span>
161176
- <span class="signature">[`arrayNextDataType( [dtype] )`][@stdlib/array/next-dtype]</span><span class="delimiter">: </span><span class="description">return the next larger array data type of the same kind.</span>
177+
- <span class="signature">[`aonesLike( x[, dtype] )`][@stdlib/array/ones-like]</span><span class="delimiter">: </span><span class="description">create an array filled with ones and having the same length and data type as a provided array.</span>
178+
- <span class="signature">[`aones( length[, dtype] )`][@stdlib/array/ones]</span><span class="delimiter">: </span><span class="description">create an array filled with ones and having a specified length.</span>
162179
- <span class="signature">[`typedarraypool()`][@stdlib/array/pool]</span><span class="delimiter">: </span><span class="description">allocate typed arrays from a typed array memory pool.</span>
163180
- <span class="signature">[`arrayPromotionRules( [dtype1, dtype2] )`][@stdlib/array/promotion-rules]</span><span class="delimiter">: </span><span class="description">return the array data type with the smallest size and closest "kind" to which array data types can be **safely** cast.</span>
164181
- <span class="signature">[`reviveTypedArray( key, value )`][@stdlib/array/reviver]</span><span class="delimiter">: </span><span class="description">revive a JSON-serialized typed array.</span>
@@ -174,6 +191,10 @@ Lastly, the namespace contains various other functions for dealing with arrays,
174191
- <span class="signature">[`stridedarray2iterator( N, src, stride, offset[, mapFcn[, thisArg]] )`][@stdlib/array/to-strided-iterator]</span><span class="delimiter">: </span><span class="description">create an iterator from a strided array-like object.</span>
175192
- <span class="signature">[`arrayview2iteratorRight( src[, begin[, end]][, mapFcn[, thisArg]] )`][@stdlib/array/to-view-iterator-right]</span><span class="delimiter">: </span><span class="description">create an iterator from an array-like object view, iterating from right to left.</span>
176193
- <span class="signature">[`arrayview2iterator( src[, begin[, end]][, mapFcn[, thisArg]] )`][@stdlib/array/to-view-iterator]</span><span class="delimiter">: </span><span class="description">create an iterator from an array-like object view.</span>
194+
- <span class="signature">[`complexarray()`][@stdlib/array/typed-complex]</span><span class="delimiter">: </span><span class="description">create a complex number typed array.</span>
195+
- <span class="signature">[`realarray()`][@stdlib/array/typed-real]</span><span class="delimiter">: </span><span class="description">create a typed array.</span>
196+
- <span class="signature">[`azerosLike( x[, dtype] )`][@stdlib/array/zeros-like]</span><span class="delimiter">: </span><span class="description">create a zero-filled array having the same length and data type as a provided array.</span>
197+
- <span class="signature">[`azeros( length[, dtype] )`][@stdlib/array/zeros]</span><span class="delimiter">: </span><span class="description">create a zero-filled array having a specified length.</span>
177198

178199
</div>
179200

@@ -216,6 +237,8 @@ console.log( objectKeys( ns ) );
216237

217238
<!-- <toc-links> -->
218239

240+
[@stdlib/array/base]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base
241+
219242
[@stdlib/array/complex128]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/complex128
220243

221244
[@stdlib/array/complex64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/complex64
@@ -234,10 +257,18 @@ console.log( objectKeys( ns ) );
234257

235258
[@stdlib/array/from-iterator]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/from-iterator
236259

260+
[@stdlib/array/full-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/full-like
261+
262+
[@stdlib/array/full]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/full
263+
237264
[@stdlib/array/min-dtype]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/min-dtype
238265

239266
[@stdlib/array/next-dtype]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/next-dtype
240267

268+
[@stdlib/array/ones-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/ones-like
269+
270+
[@stdlib/array/ones]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/ones
271+
241272
[@stdlib/array/pool]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/pool
242273

243274
[@stdlib/array/promotion-rules]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/promotion-rules
@@ -268,18 +299,50 @@ console.log( objectKeys( ns ) );
268299

269300
[@stdlib/array/to-view-iterator]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/to-view-iterator
270301

302+
[@stdlib/array/typed-complex]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/typed-complex
303+
304+
[@stdlib/array/typed-real]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/typed-real
305+
306+
[@stdlib/array/zeros-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/zeros-like
307+
308+
[@stdlib/array/zeros]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/zeros
309+
271310
[@stdlib/array/ctors]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/ctors
272311

273312
[@stdlib/array/typed-complex-ctors]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/typed-complex-ctors
274313

275314
[@stdlib/array/typed-ctors]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/typed-ctors
276315

316+
[@stdlib/array/typed-float-ctors]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/typed-float-ctors
317+
318+
[@stdlib/array/typed-integer-ctors]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/typed-integer-ctors
319+
320+
[@stdlib/array/typed-real-ctors]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/typed-real-ctors
321+
322+
[@stdlib/array/typed-real-float-ctors]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/typed-real-float-ctors
323+
324+
[@stdlib/array/typed-signed-integer-ctors]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/typed-signed-integer-ctors
325+
326+
[@stdlib/array/typed-unsigned-integer-ctors]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/typed-unsigned-integer-ctors
327+
277328
[@stdlib/array/dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/dtypes
278329

279330
[@stdlib/array/typed-complex-dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/typed-complex-dtypes
280331

281332
[@stdlib/array/typed-dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/typed-dtypes
282333

334+
[@stdlib/array/typed-float-dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/typed-float-dtypes
335+
336+
[@stdlib/array/typed-integer-dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/typed-integer-dtypes
337+
338+
[@stdlib/array/typed-real-dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/typed-real-dtypes
339+
340+
[@stdlib/array/typed-real-float-dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/typed-real-float-dtypes
341+
342+
[@stdlib/array/typed-signed-integer-dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/typed-signed-integer-dtypes
343+
344+
[@stdlib/array/typed-unsigned-integer-dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/typed-unsigned-integer-dtypes
345+
283346
[@stdlib/array/datespace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/datespace
284347

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

‎lib/node_modules/@stdlib/array/base/README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,21 @@ The namespace exports the following:
4343

4444
<!-- <toc pattern="*"> -->
4545

46+
<div class="namespace-toc">
47+
48+
- <span class="signature">[`arraylike2object( x )`][@stdlib/array/base/arraylike2object]</span><span class="delimiter">: </span><span class="description">convert an array-like object to an object likely to have the same "shape".</span>
49+
- <span class="signature">[`copy( x )`][@stdlib/array/base/copy]</span><span class="delimiter">: </span><span class="description">copy the elements of an array-like object to a new "generic" array.</span>
50+
- <span class="signature">[`filledBy( len, clbk[, thisArg] )`][@stdlib/array/base/filled-by]</span><span class="delimiter">: </span><span class="description">create a filled "generic" array according to a provided callback function.</span>
51+
- <span class="signature">[`filled( value, len )`][@stdlib/array/base/filled]</span><span class="delimiter">: </span><span class="description">create a filled "generic" array.</span>
52+
- <span class="signature">[`incrspace( start, stop, increment )`][@stdlib/array/base/incrspace]</span><span class="delimiter">: </span><span class="description">generate a linearly spaced numeric array according to a provided increment.</span>
53+
- <span class="signature">[`linspace( start, stop, length )`][@stdlib/array/base/linspace]</span><span class="delimiter">: </span><span class="description">generate a linearly spaced numeric array.</span>
54+
- <span class="signature">[`logspace( a, b, length )`][@stdlib/array/base/logspace]</span><span class="delimiter">: </span><span class="description">generate a logarithmically spaced numeric array.</span>
55+
- <span class="signature">[`ones( len )`][@stdlib/array/base/ones]</span><span class="delimiter">: </span><span class="description">create a "generic" array filled with ones.</span>
56+
- <span class="signature">[`unitspace( start, stop, increment )`][@stdlib/array/base/unitspace]</span><span class="delimiter">: </span><span class="description">generate a linearly spaced numeric array whose elements increment by 1.</span>
57+
- <span class="signature">[`zeros( len )`][@stdlib/array/base/zeros]</span><span class="delimiter">: </span><span class="description">create a zero-filled "generic" array.</span>
58+
59+
</div>
60+
4661
<!-- </toc> -->
4762

4863
</section>
@@ -80,6 +95,30 @@ console.log( objectKeys( ns ) );
8095

8196
<section class="links">
8297

98+
<!-- <toc-links> -->
99+
100+
[@stdlib/array/base/arraylike2object]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/arraylike2object
101+
102+
[@stdlib/array/base/copy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/copy
103+
104+
[@stdlib/array/base/filled-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filled-by
105+
106+
[@stdlib/array/base/filled]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filled
107+
108+
[@stdlib/array/base/incrspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/incrspace
109+
110+
[@stdlib/array/base/linspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/linspace
111+
112+
[@stdlib/array/base/logspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/logspace
113+
114+
[@stdlib/array/base/ones]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/ones
115+
116+
[@stdlib/array/base/unitspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/unitspace
117+
118+
[@stdlib/array/base/zeros]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zeros
119+
120+
<!-- </toc-links> -->
121+
83122
</section>
84123

85124
<!-- /.links -->

0 commit comments

Comments
 (0)