docs: update related packages sections

PR-URL: #1179 Reviewed-by: Philipp Burckhardt <[email protected]>
stdlib-js · Dec 12, 2023 · 1879534 · 1879534 · stdlib-bot · Dec 12, 2023
1 parent db54218
commit 1879534
Show file tree

Hide file tree

Showing 11 changed files with 115 additions and 0 deletions.
diff --git a/lib/node_modules/@stdlib/assert/is-complex128ndarray-like/README.md b/lib/node_modules/@stdlib/assert/is-complex128ndarray-like/README.md
@@ -83,6 +83,13 @@ out = isComplex128ndarrayLike( null );
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/assert/is-complex64ndarray-like`][@stdlib/assert/is-complex64ndarray-like]</span><span class="delimiter">: </span><span class="description">test if a value is an 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>
+
 </section>
 
 <!-- /.related -->
@@ -93,6 +100,14 @@ out = isComplex128ndarrayLike( null );
 
 [@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
 
+<!-- <related-links> -->
+
+[@stdlib/assert/is-complex64ndarray-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-complex64ndarray-like
+
+[@stdlib/assert/is-ndarray-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-ndarray-like
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/lib/node_modules/@stdlib/blas/base/gaxpy/README.md b/lib/node_modules/@stdlib/blas/base/gaxpy/README.md
@@ -184,6 +184,8 @@ console.log( y );
 
 <!-- <related-links> -->
 
+
+
 <!-- </related-links> -->
 
 </section>

diff --git a/lib/node_modules/@stdlib/math/base/ops/mul/README.md b/lib/node_modules/@stdlib/math/base/ops/mul/README.md
@@ -196,6 +196,7 @@ int main( void ) {
 ## 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>
+-   <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/sub`][@stdlib/math/base/ops/sub]</span><span class="delimiter">: </span><span class="description">subtract two double-precision floating-point numbers.</span>
 
 </section>
@@ -210,6 +211,8 @@ int main( void ) {
 
 [@stdlib/math/base/ops/add]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/add
 
+[@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/sub]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/sub
 
 <!-- </related-links> -->

diff --git a/lib/node_modules/@stdlib/number/float32/base/normalize/README.md b/lib/node_modules/@stdlib/number/float32/base/normalize/README.md
@@ -241,6 +241,12 @@ int main( void ) {
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/number/float64/base/normalize`][@stdlib/number/float64/base/normalize]</span><span class="delimiter">: </span><span class="description">return a normal number `y` and exponent `exp` satisfying `x = y * 2^exp`.</span>
+
 </section>
 
 <!-- /.related -->
@@ -251,6 +257,12 @@ int main( void ) {
 
 [ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985
 
+<!-- <related-links> -->
+
+[@stdlib/number/float64/base/normalize]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/float64/base/normalize
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/lib/node_modules/@stdlib/number/float32/base/to-int32/README.md b/lib/node_modules/@stdlib/number/float32/base/to-int32/README.md
@@ -96,6 +96,12 @@ for ( i = 0; i < 500; i++ ) {
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/number/float32/base/to-uint32`][@stdlib/number/float32/base/to-uint32]</span><span class="delimiter">: </span><span class="description">convert a single-precision floating-point number to an unsigned 32-bit integer.</span>
+
 </section>
 
 <!-- /.related -->
@@ -106,6 +112,12 @@ for ( i = 0; i < 500; i++ ) {
 
 [ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985
 
+<!-- <related-links> -->
+
+[@stdlib/number/float32/base/to-uint32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/float32/base/to-uint32
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/lib/node_modules/@stdlib/number/float64/base/from-binary-string/README.md b/lib/node_modules/@stdlib/number/float64/base/from-binary-string/README.md
@@ -137,6 +137,13 @@ for ( i = 0; i < 100; i++ ) {
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/number/float32/base/from-binary-string`][@stdlib/number/float32/base/from-binary-string]</span><span class="delimiter">: </span><span class="description">create a single-precision floating-point number from a literal bit representation.</span>
+-   <span class="package-name">[`@stdlib/number/float64/base/to-binary-string`][@stdlib/number/float64/base/to-binary-string]</span><span class="delimiter">: </span><span class="description">return a string giving the literal bit representation of a double-precision floating-point number.</span>
+
 </section>
 
 <!-- /.related -->
@@ -151,6 +158,12 @@ for ( i = 0; i < 100; i++ ) {
 
 [@stdlib/number/float64/base/to-binary-string]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/float64/base/to-binary-string
 
+<!-- <related-links> -->
+
+[@stdlib/number/float32/base/from-binary-string]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/float32/base/from-binary-string
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/lib/node_modules/@stdlib/number/float64/base/signbit/README.md b/lib/node_modules/@stdlib/number/float64/base/signbit/README.md
@@ -170,6 +170,12 @@ int main( void ) {
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/number/float32/base/signbit`][@stdlib/number/float32/base/signbit]</span><span class="delimiter">: </span><span class="description">return a boolean indicating if the sign bit for a single-precision floating-point number is on (true) or off (false).</span>
+
 </section>
 
 <!-- /.related -->
@@ -180,6 +186,12 @@ int main( void ) {
 
 [ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985
 
+<!-- <related-links> -->
+
+[@stdlib/number/float32/base/signbit]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/float32/base/signbit
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/lib/node_modules/@stdlib/number/uint8/base/to-binary-string/README.md b/lib/node_modules/@stdlib/number/uint8/base/to-binary-string/README.md
@@ -114,6 +114,12 @@ for ( i = 0; i < x.length; i++ ) {
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/number/float64/base/to-binary-string`][@stdlib/number/float64/base/to-binary-string]</span><span class="delimiter">: </span><span class="description">return a string giving the literal bit representation of a double-precision floating-point number.</span>
+
 </section>
 
 <!-- /.related -->
@@ -130,6 +136,12 @@ for ( i = 0; i < x.length; i++ ) {
 
 [ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985
 
+<!-- <related-links> -->
+
+[@stdlib/number/float64/base/to-binary-string]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/float64/base/to-binary-string
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/lib/node_modules/@stdlib/random/array/exponential/README.md b/lib/node_modules/@stdlib/random/array/exponential/README.md
@@ -330,6 +330,13 @@ logEach( '%f', x4 );
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/random/base/exponential`][@stdlib/random/base/exponential]</span><span class="delimiter">: </span><span class="description">exponentially distributed pseudorandom numbers.</span>
+-   <span class="package-name">[`@stdlib/random/strided/exponential`][@stdlib/random/strided/exponential]</span><span class="delimiter">: </span><span class="description">fill a strided array with pseudorandom numbers drawn from an exponential distribution.</span>
+
 </section>
 
 <!-- /.related -->
@@ -346,6 +353,12 @@ logEach( '%f', x4 );
 
 [@stdlib/array/float64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float64
 
+<!-- <related-links> -->
+
+[@stdlib/random/strided/exponential]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided/exponential
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/lib/node_modules/@stdlib/string/base/for-each-grapheme-cluster/README.md b/lib/node_modules/@stdlib/string/base/for-each-grapheme-cluster/README.md
@@ -133,6 +133,14 @@ forEachGraphemeCluster( '\uD834\uDD1E', log );
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/string/base/for-each`][@stdlib/string/base/for-each]</span><span class="delimiter">: </span><span class="description">invoke a function for each UTF-16 code unit in a string.</span>
+-   <span class="package-name">[`@stdlib/string/base/for-each-code-point`][@stdlib/string/base/for-each-code-point]</span><span class="delimiter">: </span><span class="description">invoke a function for each Unicode code point in a string.</span>
+-   <span class="package-name">[`@stdlib/string/for-each`][@stdlib/string/for-each]</span><span class="delimiter">: </span><span class="description">invoke a function for each character in a string.</span>
+
 </section>
 
 <!-- /.related -->
@@ -141,6 +149,16 @@ forEachGraphemeCluster( '\uD834\uDD1E', log );
 
 <section class="links">
 
+<!-- <related-links> -->
+
+[@stdlib/string/base/for-each]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/for-each
+
+[@stdlib/string/base/for-each-code-point]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/for-each-code-point
+
+[@stdlib/string/for-each]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/for-each
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/lib/node_modules/@stdlib/string/camelcase/README.md b/lib/node_modules/@stdlib/string/camelcase/README.md
@@ -168,6 +168,7 @@ fooBar
 
 -   <span class="package-name">[`@stdlib/string/constantcase`][@stdlib/string/constantcase]</span><span class="delimiter">: </span><span class="description">convert a string to constant case.</span>
 -   <span class="package-name">[`@stdlib/string/kebabcase`][@stdlib/string/kebabcase]</span><span class="delimiter">: </span><span class="description">convert a string to kebab case.</span>
+-   <span class="package-name">[`@stdlib/string/pascalcase`][@stdlib/string/pascalcase]</span><span class="delimiter">: </span><span class="description">convert a string to Pascal case.</span>
 -   <span class="package-name">[`@stdlib/string/snakecase`][@stdlib/string/snakecase]</span><span class="delimiter">: </span><span class="description">convert a string to snake case.</span>
 
 </section>
@@ -188,6 +189,8 @@ fooBar
 
 [@stdlib/string/kebabcase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/kebabcase
 
+[@stdlib/string/pascalcase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/pascalcase
+
 [@stdlib/string/snakecase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/snakecase
 
 <!-- </related-links> -->
Original file line number	Diff line number	Diff line change
Expand Up		@@ -184,6 +184,8 @@ console.log( y );

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



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

		</section>
Expand Down
Package	Statements	Branches	Functions	Lines
assert/is-complex128ndarray-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\%$
blas/base/gaxpy	$\color{green}254/254$ $\color{green}+100.00\%$	$\color{green}38/38$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}254/254$ $\color{green}+100.00\%$
math/base/ops/mul	$\color{green}172/172$ $\color{green}+100.00\%$	$\color{green}5/5$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}172/172$ $\color{green}+100.00\%$
number/float32/base/normalize	$\color{green}306/306$ $\color{green}+100.00\%$	$\color{green}14/14$ $\color{green}+100.00\%$	$\color{green}3/3$ $\color{green}+100.00\%$	$\color{green}306/306$ $\color{green}+100.00\%$
number/float32/base/to-int32	$\color{green}123/123$ $\color{green}+100.00\%$	$\color{green}3/3$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}123/123$ $\color{green}+100.00\%$
number/float64/base/from-binary-string	$\color{green}258/258$ $\color{green}+100.00\%$	$\color{green}24/24$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}258/258$ $\color{green}+100.00\%$
number/float64/base/signbit	$\color{green}169/169$ $\color{green}+100.00\%$	$\color{green}7/7$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}169/169$ $\color{green}+100.00\%$
number/uint8/base/to-binary-string	$\color{green}197/197$ $\color{green}+100.00\%$	$\color{green}9/9$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}197/197$ $\color{green}+100.00\%$
random/array/exponential	$\color{green}486/486$ $\color{green}+100.00\%$	$\color{green}52/52$ $\color{green}+100.00\%$	$\color{green}11/11$ $\color{green}+100.00\%$	$\color{green}486/486$ $\color{green}+100.00\%$
string/base/for-each-grapheme-cluster	$\color{green}107/107$ $\color{green}+100.00\%$	$\color{green}5/5$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}107/107$ $\color{green}+100.00\%$
string/camelcase	$\color{green}109/109$ $\color{green}+100.00\%$	$\color{green}5/5$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}109/109$ $\color{green}+100.00\%$