Skip to content

Commit

Permalink
docs: update links and fix headings
Browse files Browse the repository at this point in the history
  • Loading branch information
kgryte committed Nov 9, 2023
1 parent 8c8e3d1 commit 7db5611
Show file tree
Hide file tree
Showing 37 changed files with 1,189 additions and 718 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,12 @@ console.log( str );

<section class="related">

* * *

## See Also

- <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>

</section>

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

<section class="links">

[@stdlib/strided/dtypes]: /~https://github.com/stdlib-js/stdlib
[@stdlib/strided/dtypes]: /~https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/dtypes

[@stdlib/ndarray/promotion-rules]: /~https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/promotion-rules

<!-- <related-links> -->

[@stdlib/strided/base/binary-signature-callbacks]: /~https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/binary-signature-callbacks

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

</section>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,12 @@ var clbks = callbacks( table, sigs );

<section class="related">

* * *

## See Also

- <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>

</section>

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

<section class="links">

[@stdlib/ndarray/promotion-rules]: /~https://github.com/stdlib-js/stdlib
[@stdlib/ndarray/promotion-rules]: /~https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/promotion-rules

<!-- <related-links> -->

[@stdlib/strided/base/binary-dtype-signatures]: /~https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/binary-dtype-signatures

<!-- </related-links> -->

</section>

Expand Down
736 changes: 383 additions & 353 deletions lib/node_modules/@stdlib/strided/base/binary/README.md

Large diffs are not rendered by default.

15 changes: 15 additions & 0 deletions lib/node_modules/@stdlib/strided/base/cmap/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -349,6 +349,13 @@ int main( void ) {
<section class="related">
* * *
## See Also
- <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>
- <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>
</section>
<!-- /.related -->
Expand All @@ -359,6 +366,14 @@ int main( void ) {
[@stdlib/array/complex64]: /~https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/complex64
<!-- <related-links> -->
[@stdlib/strided/base/zmap]: /~https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/zmap
[@stdlib/strided/base/unary]: /~https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/unary
<!-- </related-links> -->
</section>
<!-- /.links -->
15 changes: 15 additions & 0 deletions lib/node_modules/@stdlib/strided/base/dmap/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -291,6 +291,13 @@ int main( void ) {
<section class="related">
* * *
## See Also
- <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>
- <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>
</section>
<!-- /.related -->
Expand All @@ -301,6 +308,14 @@ int main( void ) {
[@stdlib/array/float64]: /~https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float64
<!-- <related-links> -->
[@stdlib/strided/base/smap]: /~https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/smap
[@stdlib/strided/base/unary]: /~https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/unary
<!-- </related-links> -->
</section>
<!-- /.links -->
15 changes: 15 additions & 0 deletions lib/node_modules/@stdlib/strided/base/dmap2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -303,6 +303,13 @@ int main( void ) {
<section class="related">
* * *
## See Also
- <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>
- <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>
</section>
<!-- /.related -->
Expand All @@ -313,6 +320,14 @@ int main( void ) {
[@stdlib/array/float64]: /~https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float64
<!-- <related-links> -->
[@stdlib/strided/base/smap2]: /~https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/smap2
[@stdlib/strided/base/binary]: /~https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/binary
<!-- </related-links> -->
</section>
<!-- /.links -->
21 changes: 21 additions & 0 deletions lib/node_modules/@stdlib/strided/base/dmskmap/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -319,6 +319,15 @@ int main( void ) {
<section class="related">
* * *
## See Also
- <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>
- <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>
- <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>
- <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>
</section>
<!-- /.related -->
Expand All @@ -331,6 +340,18 @@ int main( void ) {
[@stdlib/array/uint8]: /~https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/uint8
<!-- <related-links> -->
[@stdlib/strided/base/dmap]: /~https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/dmap
[@stdlib/strided/base/dmskmap2]: /~https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/dmskmap2
[@stdlib/strided/base/mskunary]: /~https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/mskunary
[@stdlib/strided/base/smskmap]: /~https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/smskmap
<!-- </related-links> -->
</section>
<!-- /.links -->
18 changes: 18 additions & 0 deletions lib/node_modules/@stdlib/strided/base/dmskmap2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -328,6 +328,14 @@ int main( void ) {
<section class="related">
* * *
## See Also
- <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>
- <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>
- <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>
</section>
<!-- /.related -->
Expand All @@ -340,6 +348,16 @@ int main( void ) {
[@stdlib/array/uint8]: /~https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/uint8
<!-- <related-links> -->
[@stdlib/strided/base/dmap2]: /~https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/dmap2
[@stdlib/strided/base/dmskmap]: /~https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/dmskmap
[@stdlib/strided/base/smskmap2]: /~https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/smskmap2
<!-- </related-links> -->
</section>
<!-- /.links -->
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ A `StridedArrayFcn` function should accept the following arguments:
<!-- lint disable maximum-heading-length -->
#### stdlib_strided_function_allocate( *name, nin, nout, *functions, nfunctions, *types, *data[] )
#### stdlib_strided_function_allocate( \_name, nin, nout, \_functions, nfunctions, \_types, \_data\[] )
Returns a pointer to a dynamically allocated strided array function object.
Expand Down Expand Up @@ -233,7 +233,7 @@ struct StridedFunctionObject * stdlib_strided_function_allocate( const char *nam
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.
#### stdlib_strided_function_free( *obj )
#### stdlib_strided_function_free( \*obj )
Frees a strided array function object's allocated memory.
Expand Down Expand Up @@ -287,7 +287,7 @@ The function accepts the following arguments:
void stdlib_strided_function_free( struct StridedFunctionObject *obj )
```
#### stdlib_strided_function_dispatch_index_of( *obj, *types )
#### stdlib_strided_function_dispatch_index_of( \_obj, \_types )
Returns the first index of a function whose signature satisfies a provided list of array types.
Expand Down
15 changes: 15 additions & 0 deletions lib/node_modules/@stdlib/strided/base/map-by/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,13 @@ console.log( y );

<section class="related">

* * *

## See Also

- <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>
- <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>

</section>

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

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

<!-- <related-links> -->

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

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

<!-- </related-links> -->

</section>

<!-- /.links -->
15 changes: 15 additions & 0 deletions lib/node_modules/@stdlib/strided/base/map-by2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,13 @@ console.log( z );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/strided/base/map-by`][@stdlib/strided/base/map-by]</span><span class="delimiter">: </span><span class="description">apply a unary function to each element retrieved from a strided input array according to a callback function and assign results to a strided output array.</span>
- <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>

</section>

<!-- /.related -->
Expand All @@ -280,6 +287,14 @@ console.log( z );

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

<!-- <related-links> -->

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

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

<!-- </related-links> -->

</section>

<!-- /.links -->
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,12 @@ console.log( str );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/strided/base/mskunary-signature-callbacks`][@stdlib/strided/base/mskunary-signature-callbacks]</span><span class="delimiter">: </span><span class="description">assign callbacks to masked unary interfaces according to type promotion rules.</span>

</section>

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

<section class="links">

[@stdlib/strided/dtypes]: /~https://github.com/stdlib-js/stdlib
[@stdlib/strided/dtypes]: /~https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/dtypes

[@stdlib/ndarray/promotion-rules]: /~https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/promotion-rules

<!-- <related-links> -->

[@stdlib/strided/base/mskunary-signature-callbacks]: /~https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/mskunary-signature-callbacks

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

</section>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,12 @@ var clbks = callbacks( table, sigs );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/strided/base/mskunary-dtype-signatures`][@stdlib/strided/base/mskunary-dtype-signatures]</span><span class="delimiter">: </span><span class="description">generate a list of masked unary interface signatures from strided array data types.</span>

</section>

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

<section class="links">

[@stdlib/ndarray/promotion-rules]: /~https://github.com/stdlib-js/stdlib
[@stdlib/ndarray/promotion-rules]: /~https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/promotion-rules

<!-- <related-links> -->

[@stdlib/strided/base/mskunary-dtype-signatures]: /~https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/mskunary-dtype-signatures

<!-- </related-links> -->

</section>

Expand Down
Loading

0 comments on commit 7db5611

Please sign in to comment.