docs: update related packages sections

PR-URL: #1167 Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
stdlib-js · Dec 8, 2023 · d575e8b · d575e8b · stdlib-bot · Dec 8, 2023
1 parent 0e37095
commit d575e8b
Show file tree

Hide file tree

Showing 9 changed files with 130 additions and 0 deletions.
diff --git a/lib/node_modules/@stdlib/assert/is-complex128matrix-like/README.md b/lib/node_modules/@stdlib/assert/is-complex128matrix-like/README.md
@@ -83,6 +83,14 @@ out = isComplex128MatrixLike( null );
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/assert/is-complex64matrix-like`][@stdlib/assert/is-complex64matrix-like]</span><span class="delimiter">: </span><span class="description">test if a value is a 2-dimensional ndarray-like object containing single-precision complex floating-point numbers.</span>
+-   <span class="package-name">[`@stdlib/assert/is-ndarray-like`][@stdlib/assert/is-ndarray-like]</span><span class="delimiter">: </span><span class="description">test if a value is ndarray-like.</span>
+-   <span class="package-name">[`@stdlib/assert/is-matrix-like`][@stdlib/assert/is-matrix-like]</span><span class="delimiter">: </span><span class="description">test if a value is a 2-dimensional ndarray-like object.</span>
+
 </section>
 
 <!-- /.related -->
@@ -93,6 +101,16 @@ out = isComplex128MatrixLike( null );
 
 [@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
 
+<!-- <related-links> -->
+
+[@stdlib/assert/is-complex64matrix-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-complex64matrix-like
+
+[@stdlib/assert/is-ndarray-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-ndarray-like
+
+[@stdlib/assert/is-matrix-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-matrix-like
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/lib/node_modules/@stdlib/math/base/ops/add4/README.md b/lib/node_modules/@stdlib/math/base/ops/add4/README.md
@@ -196,6 +196,12 @@ int main( void ) {
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/math/base/ops/add`][@stdlib/math/base/ops/add]</span><span class="delimiter">: </span><span class="description">compute the sum of two double-precision floating-point numbers.</span>
+
 </section>
 
 <!-- /.related -->
@@ -204,6 +210,12 @@ int main( void ) {
 
 <section class="links">
 
+<!-- <related-links> -->
+
+[@stdlib/math/base/ops/add]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/add
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/lib/node_modules/@stdlib/math/base/ops/cnegf/README.md b/lib/node_modules/@stdlib/math/base/ops/cnegf/README.md
@@ -251,6 +251,13 @@ int main( void ) {
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/math/base/ops/cneg`][@stdlib/math/base/ops/cneg]</span><span class="delimiter">: </span><span class="description">negate a double-precision complex floating-point number.</span>
+-   <span class="package-name">[`@stdlib/math/base/special/cabsf`][@stdlib/math/base/special/cabsf]</span><span class="delimiter">: </span><span class="description">compute the absolute value of a single-precision complex floating-point number.</span>
+
 </section>
 
 <!-- /.related -->
@@ -259,6 +266,14 @@ int main( void ) {
 
 <section class="links">
 
+<!-- <related-links> -->
+
+[@stdlib/math/base/ops/cneg]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/cneg
+
+[@stdlib/math/base/special/cabsf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/cabsf
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/lib/node_modules/@stdlib/math/base/ops/divf/README.md b/lib/node_modules/@stdlib/math/base/ops/divf/README.md
@@ -191,6 +191,15 @@ int main( void ) {
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/math/base/ops/addf`][@stdlib/math/base/ops/addf]</span><span class="delimiter">: </span><span class="description">compute the sum of two single-precision floating-point numbers.</span>
+-   <span class="package-name">[`@stdlib/math/base/ops/div`][@stdlib/math/base/ops/div]</span><span class="delimiter">: </span><span class="description">divide two double-precision floating-point numbers.</span>
+-   <span class="package-name">[`@stdlib/math/base/ops/mulf`][@stdlib/math/base/ops/mulf]</span><span class="delimiter">: </span><span class="description">multiply two single-precision floating-point numbers.</span>
+-   <span class="package-name">[`@stdlib/math/base/ops/subf`][@stdlib/math/base/ops/subf]</span><span class="delimiter">: </span><span class="description">subtract two single-precision floating-point numbers.</span>
+
 </section>
 
 <!-- /.related -->
@@ -199,6 +208,18 @@ int main( void ) {
 
 <section class="links">
 
+<!-- <related-links> -->
+
+[@stdlib/math/base/ops/addf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/addf
+
+[@stdlib/math/base/ops/div]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/div
+
+[@stdlib/math/base/ops/mulf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/mulf
+
+[@stdlib/math/base/ops/subf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/subf
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/lib/node_modules/@stdlib/math/base/special/ellipk/README.md b/lib/node_modules/@stdlib/math/base/special/ellipk/README.md
@@ -226,6 +226,7 @@ int main( void ) {
 ## See Also
 
 -   <span class="package-name">[`@stdlib/math/base/special/ellipe`][@stdlib/math/base/special/ellipe]</span><span class="delimiter">: </span><span class="description">compute the complete elliptic integral of the second kind.</span>
+-   <span class="package-name">[`@stdlib/math/base/special/ellipj`][@stdlib/math/base/special/ellipj]</span><span class="delimiter">: </span><span class="description">compute the Jacobi elliptic functions sn, cn, and dn.</span>
 
 </section>
 
@@ -245,6 +246,8 @@ int main( void ) {
 
 [@stdlib/math/base/special/ellipe]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/ellipe
 
+[@stdlib/math/base/special/ellipj]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/ellipj
+
 <!-- </related-links> -->
 
 </section>

diff --git a/lib/node_modules/@stdlib/ndarray/stride/README.md b/lib/node_modules/@stdlib/ndarray/stride/README.md
@@ -140,6 +140,17 @@ for ( i = 0; i < slices.length; i++ ) {
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/ndarray/array`][@stdlib/ndarray/array]</span><span class="delimiter">: </span><span class="description">multidimensional arrays.</span>
+-   <span class="package-name">[`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]</span><span class="delimiter">: </span><span class="description">multidimensional array constructor.</span>
+-   <span class="package-name">[`@stdlib/ndarray/offset`][@stdlib/ndarray/offset]</span><span class="delimiter">: </span><span class="description">return the index offset specifying the underlying buffer index of the first iterated ndarray element.</span>
+-   <span class="package-name">[`@stdlib/ndarray/order`][@stdlib/ndarray/order]</span><span class="delimiter">: </span><span class="description">return the layout order of a provided ndarray.</span>
+-   <span class="package-name">[`@stdlib/ndarray/shape`][@stdlib/ndarray/shape]</span><span class="delimiter">: </span><span class="description">return the shape of a provided ndarray.</span>
+-   <span class="package-name">[`@stdlib/ndarray/strides`][@stdlib/ndarray/strides]</span><span class="delimiter">: </span><span class="description">return the strides of a provided ndarray.</span>
+
 </section>
 
 <!-- /.related -->
@@ -152,6 +163,18 @@ for ( i = 0; i < slices.length; i++ ) {
 
 [@stdlib/ndarray/strides]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/strides
 
+<!-- <related-links> -->
+
+[@stdlib/ndarray/array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/array
+
+[@stdlib/ndarray/offset]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/offset
+
+[@stdlib/ndarray/order]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/order
+
+[@stdlib/ndarray/shape]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/shape
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/lib/node_modules/@stdlib/number/float64/base/exponent/README.md b/lib/node_modules/@stdlib/number/float64/base/exponent/README.md
@@ -179,6 +179,12 @@ int main( void ) {
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/number/float32/base/exponent`][@stdlib/number/float32/base/exponent]</span><span class="delimiter">: </span><span class="description">return an integer corresponding to the unbiased exponent of a single-precision floating-point number.</span>
+
 </section>
 
 <!-- /.related -->
@@ -189,6 +195,12 @@ int main( void ) {
 
 [ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985
 
+<!-- <related-links> -->
+
+[@stdlib/number/float32/base/exponent]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/float32/base/exponent
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/lib/node_modules/@stdlib/random/strided/gamma/README.md b/lib/node_modules/@stdlib/random/strided/gamma/README.md
@@ -207,6 +207,13 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/random/base/gamma`][@stdlib/random/base/gamma]</span><span class="delimiter">: </span><span class="description">gamma distributed pseudorandom numbers.</span>
+-   <span class="package-name">[`@stdlib/random/array/gamma`][@stdlib/random/array/gamma]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a gamma distribution.</span>
+
 </section>
 
 <!-- /.related -->
@@ -221,6 +228,12 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );
 
 [@stdlib/array/uint32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/uint32
 
+<!-- <related-links> -->
+
+[@stdlib/random/array/gamma]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/gamma
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/lib/node_modules/@stdlib/random/strided/normal/README.md b/lib/node_modules/@stdlib/random/strided/normal/README.md
@@ -207,6 +207,13 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/random/base/normal`][@stdlib/random/base/normal]</span><span class="delimiter">: </span><span class="description">normally distributed pseudorandom numbers.</span>
+-   <span class="package-name">[`@stdlib/random/array/normal`][@stdlib/random/array/normal]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a normal distribution.</span>
+
 </section>
 
 <!-- /.related -->
@@ -221,6 +228,12 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );
 
 [@stdlib/array/uint32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/uint32
 
+<!-- <related-links> -->
+
+[@stdlib/random/array/normal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/normal
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
Package	Statements	Branches	Functions	Lines
assert/is-complex128matrix-like	$\color{green}103/103$ $\color{green}+100.00\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}103/103$ $\color{green}+100.00\%$
math/base/ops/add4	$\color{green}176/176$ $\color{green}+100.00\%$	$\color{green}5/5$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}176/176$ $\color{green}+100.00\%$
math/base/ops/cnegf	$\color{green}277/277$ $\color{green}+100.00\%$	$\color{green}5/5$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}277/277$ $\color{green}+100.00\%$
math/base/ops/divf	$\color{green}177/177$ $\color{green}+100.00\%$	$\color{green}5/5$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}177/177$ $\color{green}+100.00\%$
math/base/special/ellipk	$\color{red}845/869$ $\color{green}+97.24\%$	$\color{red}59/71$ $\color{green}+83.10\%$	$\color{green}14/14$ $\color{green}+100.00\%$	$\color{red}845/869$ $\color{green}+97.24\%$
ndarray/stride	$\color{green}109/109$ $\color{green}+100.00\%$	$\color{green}11/11$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}109/109$ $\color{green}+100.00\%$
number/float64/base/exponent	$\color{green}173/173$ $\color{green}+100.00\%$	$\color{green}5/5$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}173/173$ $\color{green}+100.00\%$
random/strided/gamma	$\color{green}295/295$ $\color{green}+100.00\%$	$\color{green}19/19$ $\color{green}+100.00\%$	$\color{green}3/3$ $\color{green}+100.00\%$	$\color{green}295/295$ $\color{green}+100.00\%$
random/strided/normal	$\color{green}295/295$ $\color{green}+100.00\%$	$\color{green}19/19$ $\color{green}+100.00\%$	$\color{green}3/3$ $\color{green}+100.00\%$	$\color{green}295/295$ $\color{green}+100.00\%$