Skip to content

Commit

Permalink
docs: update related packages sections
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Nov 27, 2023
1 parent 5d698ee commit 55c35db
Show file tree
Hide file tree
Showing 17 changed files with 128 additions and 12 deletions.
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/math/base/ops/add/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,7 @@ int main( void ) {

## See Also

- <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/mul`][@stdlib/math/base/ops/mul]</span><span class="delimiter">: </span><span class="description">multiply 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>

Expand All @@ -208,6 +209,8 @@ int main( void ) {

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

[@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/mul]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/mul

[@stdlib/math/base/ops/sub]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/sub
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ for ( i = 0; i < 100; i++ ) {
## See Also

- <span class="package-name">[`@stdlib/math/base/special/log1p`][@stdlib/math/base/special/log1p]</span><span class="delimiter">: </span><span class="description">evaluate the natural logarithm of 1+x.</span>
- <span class="package-name">[`@stdlib/math/base/special/xlogy`][@stdlib/math/base/special/xlogy]</span><span class="delimiter">: </span><span class="description">compute `x * ln(y)` so that the result is `0` if `x = 0`.</span>
- <span class="package-name">[`@stdlib/math/base/special/xlogy`][@stdlib/math/base/special/xlogy]</span><span class="delimiter">: </span><span class="description">compute `x \* ln(y)` so that the result is `0` if `x = 0`.</span>

</section>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ while ( true ) {

## See Also

- <span class="package-name">[`@stdlib/math/base/special/log1mexp`][@stdlib/math/base/special/log1mexp]</span><span class="delimiter">: </span><span class="description">evaluate the natural logarithm of 1-exp(-|x|).</span>
- <span class="package-name">[`@stdlib/math/base/special/log1mexp`][@stdlib/math/base/special/log1mexp]</span><span class="delimiter">: </span><span class="description">evaluate the natural logarithm of 1-exp(-\|x\|).</span>
- <span class="package-name">[`@stdlib/math/iter/special/log`][@stdlib/math/iter/special/log]</span><span class="delimiter">: </span><span class="description">create an iterator which computes the base `b` logarithm.</span>
- <span class="package-name">[`@stdlib/math/iter/special/log1p`][@stdlib/math/iter/special/log1p]</span><span class="delimiter">: </span><span class="description">create an iterator which evaluates the natural logarithm of 1+x for each iterated value.</span>
- <span class="package-name">[`@stdlib/math/iter/special/log1pexp`][@stdlib/math/iter/special/log1pexp]</span><span class="delimiter">: </span><span class="description">create an iterator which evaluates the natural logarithm of 1+exp(x) for each iterated value.</span>
Expand Down
2 changes: 2 additions & 0 deletions lib/node_modules/@stdlib/ndarray/iter/to-array-each/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,8 @@ while ( true ) {

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



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

</section>
Expand Down
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/number/float32/base/signbit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,12 @@ for ( i = 0; i < 100; i++ ) {

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/number/float64/base/signbit`][@stdlib/number/float64/base/signbit]</span><span class="delimiter">: </span><span class="description">return a boolean indicating if the sign bit for a double-precision floating-point number is on (true) or off (false).</span>

</section>

<!-- /.related -->
Expand All @@ -96,6 +102,12 @@ for ( i = 0; i < 100; i++ ) {

[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985

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

[@stdlib/number/float64/base/signbit]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/float64/base/signbit

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

</section>

<!-- /.links -->
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/number/float64/base/normalize/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,12 @@ int main( void ) {
<section class="related">
* * *
## See Also
- <span class="package-name">[`@stdlib/number/float32/base/normalize`][@stdlib/number/float32/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 -->
Expand All @@ -236,6 +242,12 @@ int main( void ) {
<section class="links">
<!-- <related-links> -->
[@stdlib/number/float32/base/normalize]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/float32/base/normalize
<!-- </related-links> -->
</section>
<!-- /.links -->
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/os/platform/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ $ platform

## See Also

- <span class="package-name">[`@stdlib/os/arch`][@stdlib/os/arch]</span><span class="delimiter">: </span><span class="description">operating system CPU architecture.</span>
- <span class="package-name">[`@stdlib/os/arch`][@stdlib/os/arch]</span><span class="delimiter">: </span><span class="description">operating system CPU architecture for which the JavaScript runtime binary was compiled.</span>

</section>

Expand Down
13 changes: 13 additions & 0 deletions lib/node_modules/@stdlib/random/array/gamma/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -331,6 +331,13 @@ logEach( '%f', x4 );

<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/strided/gamma`][@stdlib/random/strided/gamma]</span><span class="delimiter">: </span><span class="description">fill a strided array with pseudorandom numbers drawn from a gamma distribution.</span>

</section>

<!-- /.related -->
Expand All @@ -347,6 +354,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/gamma]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided/gamma

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

</section>

<!-- /.links -->
13 changes: 13 additions & 0 deletions lib/node_modules/@stdlib/random/array/invgamma/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -331,6 +331,13 @@ logEach( '%f', x4 );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/random/base/invgamma`][@stdlib/random/base/invgamma]</span><span class="delimiter">: </span><span class="description">inverse gamma distributed pseudorandom numbers.</span>
- <span class="package-name">[`@stdlib/random/strided/invgamma`][@stdlib/random/strided/invgamma]</span><span class="delimiter">: </span><span class="description">fill a strided array with pseudorandom numbers drawn from an inverse gamma distribution.</span>

</section>

<!-- /.related -->
Expand All @@ -347,6 +354,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/invgamma]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided/invgamma

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

</section>

<!-- /.links -->
16 changes: 16 additions & 0 deletions lib/node_modules/@stdlib/random/array/randu/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,14 @@ logEach( '%f', x4 );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/random/array/uniform`][@stdlib/random/array/uniform]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a continuous uniform distribution.</span>
- <span class="package-name">[`@stdlib/random/base/randu`][@stdlib/random/base/randu]</span><span class="delimiter">: </span><span class="description">uniformly distributed pseudorandom numbers between 0 and 1.</span>
- <span class="package-name">[`@stdlib/random/strided/randu`][@stdlib/random/strided/randu]</span><span class="delimiter">: </span><span class="description">fill a strided array with uniformly distributed pseudorandom numbers between 0 and 1.</span>

</section>

<!-- /.related -->
Expand All @@ -267,6 +275,14 @@ logEach( '%f', x4 );

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

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

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

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

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

</section>

<!-- /.links -->
13 changes: 13 additions & 0 deletions lib/node_modules/@stdlib/random/strided/betaprime/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/betaprime`][@stdlib/random/base/betaprime]</span><span class="delimiter">: </span><span class="description">beta prime distributed pseudorandom numbers.</span>
- <span class="package-name">[`@stdlib/random/array/betaprime`][@stdlib/random/array/betaprime]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a beta prime distribution.</span>

</section>

<!-- /.related -->
Expand All @@ -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/betaprime]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/betaprime

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

</section>

<!-- /.links -->
19 changes: 19 additions & 0 deletions lib/node_modules/@stdlib/random/strided/minstd/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,15 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/random/base/minstd`][@stdlib/random/base/minstd]</span><span class="delimiter">: </span><span class="description">A linear congruential pseudorandom number generator (LCG) based on Park and Miller.</span>
- <span class="package-name">[`@stdlib/random/array/minstd`][@stdlib/random/array/minstd]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers generated using a linear congruential pseudorandom number generator (LCG).</span>
- <span class="package-name">[`@stdlib/random/strided/minstd-shuffle`][@stdlib/random/strided/minstd-shuffle]</span><span class="delimiter">: </span><span class="description">fill a strided array with pseudorandom numbers generated using a linear congruential pseudorandom number generator (LCG) whose output is shuffled.</span>
- <span class="package-name">[`@stdlib/random/strided/randu`][@stdlib/random/strided/randu]</span><span class="delimiter">: </span><span class="description">fill a strided array with uniformly distributed pseudorandom numbers between 0 and 1.</span>

</section>

<!-- /.related -->
Expand All @@ -237,6 +246,16 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );

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

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

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

[@stdlib/random/strided/minstd-shuffle]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided/minstd-shuffle

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

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

</section>

<!-- /.links -->
Original file line number Diff line number Diff line change
Expand Up @@ -55,16 +55,12 @@ The namespace contains the following functions for calculating distribution prop

<!-- <toc pattern="*+(entropy|kurtosis|mean|median|mode|skewness|stdev|variance)*"> -->



<!-- </toc> -->

The namespace contains a constructor function for creating a [truncated normal][truncated-normal-distribution] distribution object.

<!-- <toc pattern="*ctor*"> -->



<!-- </toc> -->

</section>
Expand Down
4 changes: 0 additions & 4 deletions lib/node_modules/@stdlib/stats/base/min/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,14 +186,10 @@ console.log( v );

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

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

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

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

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

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

</section>
Expand Down
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/stats/base/smskmax/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,7 @@ console.log( v );
- <span class="package-name">[`@stdlib/stats/base/smax`][@stdlib/stats/base/smax]</span><span class="delimiter">: </span><span class="description">calculate the maximum value of a single-precision floating-point strided array.</span>
- <span class="package-name">[`@stdlib/stats/base/smskmin`][@stdlib/stats/base/smskmin]</span><span class="delimiter">: </span><span class="description">calculate the minimum value of a single-precision floating-point strided array according to a mask.</span>
- <span class="package-name">[`@stdlib/stats/base/snanmax`][@stdlib/stats/base/snanmax]</span><span class="delimiter">: </span><span class="description">calculate the maximum value of a single-precision floating-point strided array, ignoring NaN values.</span>
- <span class="package-name">[`@stdlib/stats/base/snanmskmax`][@stdlib/stats/base/snanmskmax]</span><span class="delimiter">: </span><span class="description">calculate the maximum value of a single-precision floating-point strided array according to a mask, ignoring NaN values.</span>

</section>

Expand Down Expand Up @@ -222,6 +223,8 @@ console.log( v );

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

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

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

</section>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,14 @@ str = firstGraphemeCluster( '🐶🐮🐷🐰🐸', 10 );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/string/base/first`][@stdlib/string/base/first]</span><span class="delimiter">: </span><span class="description">return the first UTF-16 code unit of a string.</span>
- <span class="package-name">[`@stdlib/string/base/first-code-point`][@stdlib/string/base/first-code-point]</span><span class="delimiter">: </span><span class="description">return the first Unicode code point of a string.</span>
- <span class="package-name">[`@stdlib/string/first`][@stdlib/string/first]</span><span class="delimiter">: </span><span class="description">return the first character(s) of a string.</span>

</section>

<!-- /.related -->
Expand All @@ -93,6 +101,16 @@ str = firstGraphemeCluster( '🐶🐮🐷🐰🐸', 10 );

<section class="links">

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

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

[@stdlib/string/base/first-code-point]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/first-code-point

[@stdlib/string/first]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/first

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

</section>

<!-- /.links -->
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ limitations under the License.
var substringAfterLast = require( '@stdlib/string/substring-after-last' );
```

#### substringAfterLast( str, search\[, fromIndex] )
#### substringAfterLast( str, search\[, fromIndex] )

Returns the part of a string after the last occurrence of a specified substring.

Expand Down

0 comments on commit 55c35db

Please sign in to comment.