Skip to content

Commit 7db5611

Browse files
kgrytekgryte
committed
docs: update links and fix headings
1 parent 8c8e3d1 commit 7db5611

File tree

37 files changed

+1189
-718
lines changed

37 files changed

+1189
-718
lines changed

‎lib/node_modules/@stdlib/strided/base/binary-dtype-signatures/README.md‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,12 @@ console.log( str );
142142

143143
<section class="related">
144144

145+
* * *
146+
147+
## See Also
148+
149+
- <span class="package-name">[`@stdlib/strided/base/binary-signature-callbacks`][@stdlib/strided/base/binary-signature-callbacks]</span><span class="delimiter">: </span><span class="description">assign callbacks to binary interfaces according to type promotion rules.</span>
150+
145151
</section>
146152

147153
<!-- /.related -->
@@ -150,9 +156,15 @@ console.log( str );
150156

151157
<section class="links">
152158

153-
[@stdlib/strided/dtypes]: https://github.com/stdlib-js/stdlib
159+
[@stdlib/strided/dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/dtypes
160+
161+
[@stdlib/ndarray/promotion-rules]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/promotion-rules
162+
163+
<!-- <related-links> -->
164+
165+
[@stdlib/strided/base/binary-signature-callbacks]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/binary-signature-callbacks
154166

155-
[@stdlib/ndarray/promotion-rules]: https://github.com/stdlib-js/stdlib
167+
<!-- </related-links> -->
156168

157169
</section>
158170

‎lib/node_modules/@stdlib/strided/base/binary-signature-callbacks/README.md‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,12 @@ var clbks = callbacks( table, sigs );
151151

152152
<section class="related">
153153

154+
* * *
155+
156+
## See Also
157+
158+
- <span class="package-name">[`@stdlib/strided/base/binary-dtype-signatures`][@stdlib/strided/base/binary-dtype-signatures]</span><span class="delimiter">: </span><span class="description">generate a list of binary interface signatures from strided array data types.</span>
159+
154160
</section>
155161

156162
<!-- /.related -->
@@ -159,7 +165,13 @@ var clbks = callbacks( table, sigs );
159165

160166
<section class="links">
161167

162-
[@stdlib/ndarray/promotion-rules]: https://github.com/stdlib-js/stdlib
168+
[@stdlib/ndarray/promotion-rules]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/promotion-rules
169+
170+
<!-- <related-links> -->
171+
172+
[@stdlib/strided/base/binary-dtype-signatures]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/binary-dtype-signatures
173+
174+
<!-- </related-links> -->
163175

164176
</section>
165177

‎lib/node_modules/@stdlib/strided/base/binary/README.md‎

Lines changed: 383 additions & 353 deletions
Large diffs are not rendered by default.

‎lib/node_modules/@stdlib/strided/base/cmap/README.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -349,6 +349,13 @@ int main( void ) {
349349
350350
<section class="related">
351351
352+
* * *
353+
354+
## See Also
355+
356+
- <span class="package-name">[`@stdlib/strided/base/zmap`][@stdlib/strided/base/zmap]</span><span class="delimiter">: </span><span class="description">apply a unary function to a double-precision complex floating-point strided input array and assign results to a double-precision complex floating-point strided output array.</span>
357+
- <span class="package-name">[`@stdlib/strided/base/unary`][@stdlib/strided/base/unary]</span><span class="delimiter">: </span><span class="description">apply a unary callback to elements in a strided input array and assign results to elements in a strided output array.</span>
358+
352359
</section>
353360
354361
<!-- /.related -->
@@ -359,6 +366,14 @@ int main( void ) {
359366
360367
[@stdlib/array/complex64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/complex64
361368
369+
<!-- <related-links> -->
370+
371+
[@stdlib/strided/base/zmap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/zmap
372+
373+
[@stdlib/strided/base/unary]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/unary
374+
375+
<!-- </related-links> -->
376+
362377
</section>
363378
364379
<!-- /.links -->

‎lib/node_modules/@stdlib/strided/base/dmap/README.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -291,6 +291,13 @@ int main( void ) {
291291
292292
<section class="related">
293293
294+
* * *
295+
296+
## See Also
297+
298+
- <span class="package-name">[`@stdlib/strided/base/smap`][@stdlib/strided/base/smap]</span><span class="delimiter">: </span><span class="description">apply a unary function to a single-precision floating-point strided input array and assign results to a single-precision floating-point strided output array.</span>
299+
- <span class="package-name">[`@stdlib/strided/base/unary`][@stdlib/strided/base/unary]</span><span class="delimiter">: </span><span class="description">apply a unary callback to elements in a strided input array and assign results to elements in a strided output array.</span>
300+
294301
</section>
295302
296303
<!-- /.related -->
@@ -301,6 +308,14 @@ int main( void ) {
301308
302309
[@stdlib/array/float64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float64
303310
311+
<!-- <related-links> -->
312+
313+
[@stdlib/strided/base/smap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/smap
314+
315+
[@stdlib/strided/base/unary]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/unary
316+
317+
<!-- </related-links> -->
318+
304319
</section>
305320
306321
<!-- /.links -->

‎lib/node_modules/@stdlib/strided/base/dmap2/README.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -303,6 +303,13 @@ int main( void ) {
303303
304304
<section class="related">
305305
306+
* * *
307+
308+
## See Also
309+
310+
- <span class="package-name">[`@stdlib/strided/base/smap2`][@stdlib/strided/base/smap2]</span><span class="delimiter">: </span><span class="description">apply a binary function to single-precision floating-point strided input arrays and assign results to a single-precision floating-point strided output array.</span>
311+
- <span class="package-name">[`@stdlib/strided/base/binary`][@stdlib/strided/base/binary]</span><span class="delimiter">: </span><span class="description">apply a binary callback to elements in strided input arrays and assign results to elements in a strided output array.</span>
312+
306313
</section>
307314
308315
<!-- /.related -->
@@ -313,6 +320,14 @@ int main( void ) {
313320
314321
[@stdlib/array/float64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float64
315322
323+
<!-- <related-links> -->
324+
325+
[@stdlib/strided/base/smap2]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/smap2
326+
327+
[@stdlib/strided/base/binary]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/binary
328+
329+
<!-- </related-links> -->
330+
316331
</section>
317332
318333
<!-- /.links -->

‎lib/node_modules/@stdlib/strided/base/dmskmap/README.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -319,6 +319,15 @@ int main( void ) {
319319
320320
<section class="related">
321321
322+
* * *
323+
324+
## See Also
325+
326+
- <span class="package-name">[`@stdlib/strided/base/dmap`][@stdlib/strided/base/dmap]</span><span class="delimiter">: </span><span class="description">apply a unary function to a double-precision floating-point strided input array and assign results to a double-precision floating-point strided output array.</span>
327+
- <span class="package-name">[`@stdlib/strided/base/dmskmap2`][@stdlib/strided/base/dmskmap2]</span><span class="delimiter">: </span><span class="description">apply a binary function to double-precision floating-point strided input arrays according to a strided mask array and assign results to a double-precision floating-point strided output array.</span>
328+
- <span class="package-name">[`@stdlib/strided/base/mskunary`][@stdlib/strided/base/mskunary]</span><span class="delimiter">: </span><span class="description">apply a unary callback to elements in a strided input array according to elements in a strided mask array and assign results to elements in a strided output array.</span>
329+
- <span class="package-name">[`@stdlib/strided/base/smskmap`][@stdlib/strided/base/smskmap]</span><span class="delimiter">: </span><span class="description">apply a unary function to a single-precision floating-point strided input array according to a strided mask array and assign results to a single-precision floating-point strided output array.</span>
330+
322331
</section>
323332
324333
<!-- /.related -->
@@ -331,6 +340,18 @@ int main( void ) {
331340
332341
[@stdlib/array/uint8]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/uint8
333342
343+
<!-- <related-links> -->
344+
345+
[@stdlib/strided/base/dmap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/dmap
346+
347+
[@stdlib/strided/base/dmskmap2]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/dmskmap2
348+
349+
[@stdlib/strided/base/mskunary]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/mskunary
350+
351+
[@stdlib/strided/base/smskmap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/smskmap
352+
353+
<!-- </related-links> -->
354+
334355
</section>
335356
336357
<!-- /.links -->

‎lib/node_modules/@stdlib/strided/base/dmskmap2/README.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -328,6 +328,14 @@ int main( void ) {
328328
329329
<section class="related">
330330
331+
* * *
332+
333+
## See Also
334+
335+
- <span class="package-name">[`@stdlib/strided/base/dmap2`][@stdlib/strided/base/dmap2]</span><span class="delimiter">: </span><span class="description">apply a binary function to double-precision floating-point strided input arrays and assign results to a double-precision floating-point strided output array.</span>
336+
- <span class="package-name">[`@stdlib/strided/base/dmskmap`][@stdlib/strided/base/dmskmap]</span><span class="delimiter">: </span><span class="description">apply a unary function to a double-precision floating-point strided input array according to a strided mask array and assign results to a double-precision floating-point strided output array.</span>
337+
- <span class="package-name">[`@stdlib/strided/base/smskmap2`][@stdlib/strided/base/smskmap2]</span><span class="delimiter">: </span><span class="description">apply a binary function to single-precision floating-point strided input arrays according to a strided mask array and assign results to a single-precision floating-point strided output array.</span>
338+
331339
</section>
332340
333341
<!-- /.related -->
@@ -340,6 +348,16 @@ int main( void ) {
340348
341349
[@stdlib/array/uint8]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/uint8
342350
351+
<!-- <related-links> -->
352+
353+
[@stdlib/strided/base/dmap2]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/dmap2
354+
355+
[@stdlib/strided/base/dmskmap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/dmskmap
356+
357+
[@stdlib/strided/base/smskmap2]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/smskmap2
358+
359+
<!-- </related-links> -->
360+
343361
</section>
344362
345363
<!-- /.links -->

‎lib/node_modules/@stdlib/strided/base/function-object/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ A `StridedArrayFcn` function should accept the following arguments:
152152
153153
<!-- lint disable maximum-heading-length -->
154154
155-
#### stdlib_strided_function_allocate( *name, nin, nout, *functions, nfunctions, *types, *data[] )
155+
#### stdlib_strided_function_allocate( \_name, nin, nout, \_functions, nfunctions, \_types, \_data\[] )
156156
157157
Returns a pointer to a dynamically allocated strided array function object.
158158
@@ -233,7 +233,7 @@ struct StridedFunctionObject * stdlib_strided_function_allocate( const char *nam
233233
234234
The function returns a pointer to a dynamically allocated strided array function or, if unable to allocate memory, a null pointer. The **user** is responsible for freeing the allocated memory.
235235
236-
#### stdlib_strided_function_free( *obj )
236+
#### stdlib_strided_function_free( \*obj )
237237
238238
Frees a strided array function object's allocated memory.
239239
@@ -287,7 +287,7 @@ The function accepts the following arguments:
287287
void stdlib_strided_function_free( struct StridedFunctionObject *obj )
288288
```
289289
290-
#### stdlib_strided_function_dispatch_index_of( *obj, *types )
290+
#### stdlib_strided_function_dispatch_index_of( \_obj, \_types )
291291
292292
Returns the first index of a function whose signature satisfies a provided list of array types.
293293

‎lib/node_modules/@stdlib/strided/base/map-by/README.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -242,6 +242,13 @@ console.log( y );
242242

243243
<section class="related">
244244

245+
* * *
246+
247+
## See Also
248+
249+
- <span class="package-name">[`@stdlib/strided/base/map-by2`][@stdlib/strided/base/map-by2]</span><span class="delimiter">: </span><span class="description">apply a binary function to each pair of elements retrieved from strided input arrays according to a callback function and assign results to a strided output array.</span>
250+
- <span class="package-name">[`@stdlib/strided/base/unary`][@stdlib/strided/base/unary]</span><span class="delimiter">: </span><span class="description">apply a unary callback to elements in a strided input array and assign results to elements in a strided output array.</span>
251+
245252
</section>
246253

247254
<!-- /.related -->
@@ -254,6 +261,14 @@ console.log( y );
254261

255262
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
256263

264+
<!-- <related-links> -->
265+
266+
[@stdlib/strided/base/map-by2]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/map-by2
267+
268+
[@stdlib/strided/base/unary]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/unary
269+
270+
<!-- </related-links> -->
271+
257272
</section>
258273

259274
<!-- /.links -->

0 commit comments

Comments
 (0)