From 55c35dbe8ead5f443cccdfbbd6291adfde98c86b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 27 Nov 2023 02:29:09 +0000 Subject: [PATCH] docs: update related packages sections --- .../@stdlib/math/base/ops/add/README.md | 3 +++ .../math/base/special/xlog1py/README.md | 2 +- .../math/iter/special/log1mexp/README.md | 2 +- .../ndarray/iter/to-array-each/README.md | 2 ++ .../number/float32/base/signbit/README.md | 12 ++++++++++++ .../number/float64/base/normalize/README.md | 12 ++++++++++++ .../@stdlib/os/platform/README.md | 2 +- .../@stdlib/random/array/gamma/README.md | 13 +++++++++++++ .../@stdlib/random/array/invgamma/README.md | 13 +++++++++++++ .../@stdlib/random/array/randu/README.md | 16 ++++++++++++++++ .../random/strided/betaprime/README.md | 13 +++++++++++++ .../@stdlib/random/strided/minstd/README.md | 19 +++++++++++++++++++ .../base/dists/truncated-normal/README.md | 4 ---- .../@stdlib/stats/base/min/README.md | 4 ---- .../@stdlib/stats/base/smskmax/README.md | 3 +++ .../base/first-grapheme-cluster/README.md | 18 ++++++++++++++++++ .../string/substring-after-last/README.md | 2 +- 17 files changed, 128 insertions(+), 12 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/ops/add/README.md b/lib/node_modules/@stdlib/math/base/ops/add/README.md index 77d63968ef2..42af16729b8 100644 --- a/lib/node_modules/@stdlib/math/base/ops/add/README.md +++ b/lib/node_modules/@stdlib/math/base/ops/add/README.md @@ -195,6 +195,7 @@ int main( void ) { ## See Also +- [`@stdlib/math/base/ops/div`][@stdlib/math/base/ops/div]: divide two double-precision floating-point numbers. - [`@stdlib/math/base/ops/mul`][@stdlib/math/base/ops/mul]: multiply two double-precision floating-point numbers. - [`@stdlib/math/base/ops/sub`][@stdlib/math/base/ops/sub]: subtract two double-precision floating-point numbers. @@ -208,6 +209,8 @@ int main( void ) { +[@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 diff --git a/lib/node_modules/@stdlib/math/base/special/xlog1py/README.md b/lib/node_modules/@stdlib/math/base/special/xlog1py/README.md index 78e4722e360..3a0ff28fcb6 100644 --- a/lib/node_modules/@stdlib/math/base/special/xlog1py/README.md +++ b/lib/node_modules/@stdlib/math/base/special/xlog1py/README.md @@ -101,7 +101,7 @@ for ( i = 0; i < 100; i++ ) { ## See Also - [`@stdlib/math/base/special/log1p`][@stdlib/math/base/special/log1p]: evaluate the natural logarithm of 1+x. -- [`@stdlib/math/base/special/xlogy`][@stdlib/math/base/special/xlogy]: compute `x * ln(y)` so that the result is `0` if `x = 0`. +- [`@stdlib/math/base/special/xlogy`][@stdlib/math/base/special/xlogy]: compute `x \* ln(y)` so that the result is `0` if `x = 0`. diff --git a/lib/node_modules/@stdlib/math/iter/special/log1mexp/README.md b/lib/node_modules/@stdlib/math/iter/special/log1mexp/README.md index 7d6e2a8ebc1..1fe076b4308 100644 --- a/lib/node_modules/@stdlib/math/iter/special/log1mexp/README.md +++ b/lib/node_modules/@stdlib/math/iter/special/log1mexp/README.md @@ -136,7 +136,7 @@ while ( true ) { ## See Also -- [`@stdlib/math/base/special/log1mexp`][@stdlib/math/base/special/log1mexp]: evaluate the natural logarithm of 1-exp(-|x|). +- [`@stdlib/math/base/special/log1mexp`][@stdlib/math/base/special/log1mexp]: evaluate the natural logarithm of 1-exp(-\|x\|). - [`@stdlib/math/iter/special/log`][@stdlib/math/iter/special/log]: create an iterator which computes the base `b` logarithm. - [`@stdlib/math/iter/special/log1p`][@stdlib/math/iter/special/log1p]: create an iterator which evaluates the natural logarithm of 1+x for each iterated value. - [`@stdlib/math/iter/special/log1pexp`][@stdlib/math/iter/special/log1pexp]: create an iterator which evaluates the natural logarithm of 1+exp(x) for each iterated value. diff --git a/lib/node_modules/@stdlib/ndarray/iter/to-array-each/README.md b/lib/node_modules/@stdlib/ndarray/iter/to-array-each/README.md index ea986f630a1..efb7903e958 100644 --- a/lib/node_modules/@stdlib/ndarray/iter/to-array-each/README.md +++ b/lib/node_modules/@stdlib/ndarray/iter/to-array-each/README.md @@ -158,6 +158,8 @@ while ( true ) { + + diff --git a/lib/node_modules/@stdlib/number/float32/base/signbit/README.md b/lib/node_modules/@stdlib/number/float32/base/signbit/README.md index 8504d6144ca..0f70925481c 100644 --- a/lib/node_modules/@stdlib/number/float32/base/signbit/README.md +++ b/lib/node_modules/@stdlib/number/float32/base/signbit/README.md @@ -86,6 +86,12 @@ for ( i = 0; i < 100; i++ ) {
+* * * + +## See Also + +- [`@stdlib/number/float64/base/signbit`][@stdlib/number/float64/base/signbit]: return a boolean indicating if the sign bit for a double-precision floating-point number is on (true) or off (false). +
@@ -96,6 +102,12 @@ for ( i = 0; i < 100; i++ ) { [ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985 + + +[@stdlib/number/float64/base/signbit]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/float64/base/signbit + + + diff --git a/lib/node_modules/@stdlib/number/float64/base/normalize/README.md b/lib/node_modules/@stdlib/number/float64/base/normalize/README.md index 621ed3056be..4192b437c8c 100644 --- a/lib/node_modules/@stdlib/number/float64/base/normalize/README.md +++ b/lib/node_modules/@stdlib/number/float64/base/normalize/README.md @@ -228,6 +228,12 @@ int main( void ) {
+* * * + +## See Also + +- [`@stdlib/number/float32/base/normalize`][@stdlib/number/float32/base/normalize]: return a normal number `y` and exponent `exp` satisfying `x = y \* 2^exp`. +
@@ -236,6 +242,12 @@ int main( void ) {
+ + +[@stdlib/number/float32/base/normalize]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/float32/base/normalize + + +
diff --git a/lib/node_modules/@stdlib/os/platform/README.md b/lib/node_modules/@stdlib/os/platform/README.md index 6a1f2dd9fed..46dd55f668c 100644 --- a/lib/node_modules/@stdlib/os/platform/README.md +++ b/lib/node_modules/@stdlib/os/platform/README.md @@ -112,7 +112,7 @@ $ platform ## See Also -- [`@stdlib/os/arch`][@stdlib/os/arch]: operating system CPU architecture. +- [`@stdlib/os/arch`][@stdlib/os/arch]: operating system CPU architecture for which the JavaScript runtime binary was compiled. diff --git a/lib/node_modules/@stdlib/random/array/gamma/README.md b/lib/node_modules/@stdlib/random/array/gamma/README.md index aa4b92ea67b..ce5b12c8dfa 100644 --- a/lib/node_modules/@stdlib/random/array/gamma/README.md +++ b/lib/node_modules/@stdlib/random/array/gamma/README.md @@ -331,6 +331,13 @@ logEach( '%f', x4 );
+* * * + +## See Also + +- [`@stdlib/random/base/gamma`][@stdlib/random/base/gamma]: gamma distributed pseudorandom numbers. +- [`@stdlib/random/strided/gamma`][@stdlib/random/strided/gamma]: fill a strided array with pseudorandom numbers drawn from a gamma distribution. +
@@ -347,6 +354,12 @@ logEach( '%f', x4 ); [@stdlib/array/float64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float64 + + +[@stdlib/random/strided/gamma]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided/gamma + + + diff --git a/lib/node_modules/@stdlib/random/array/invgamma/README.md b/lib/node_modules/@stdlib/random/array/invgamma/README.md index 2c89de067aa..28f5b9c06e5 100644 --- a/lib/node_modules/@stdlib/random/array/invgamma/README.md +++ b/lib/node_modules/@stdlib/random/array/invgamma/README.md @@ -331,6 +331,13 @@ logEach( '%f', x4 );
+* * * + +## See Also + +- [`@stdlib/random/base/invgamma`][@stdlib/random/base/invgamma]: inverse gamma distributed pseudorandom numbers. +- [`@stdlib/random/strided/invgamma`][@stdlib/random/strided/invgamma]: fill a strided array with pseudorandom numbers drawn from an inverse gamma distribution. +
@@ -347,6 +354,12 @@ logEach( '%f', x4 ); [@stdlib/array/float64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float64 + + +[@stdlib/random/strided/invgamma]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided/invgamma + + + diff --git a/lib/node_modules/@stdlib/random/array/randu/README.md b/lib/node_modules/@stdlib/random/array/randu/README.md index e85c1989e7d..059b9e22496 100644 --- a/lib/node_modules/@stdlib/random/array/randu/README.md +++ b/lib/node_modules/@stdlib/random/array/randu/README.md @@ -247,6 +247,14 @@ logEach( '%f', x4 );
+* * * + +## See Also + +- [`@stdlib/random/array/uniform`][@stdlib/random/array/uniform]: create an array containing pseudorandom numbers drawn from a continuous uniform distribution. +- [`@stdlib/random/base/randu`][@stdlib/random/base/randu]: uniformly distributed pseudorandom numbers between 0 and 1. +- [`@stdlib/random/strided/randu`][@stdlib/random/strided/randu]: fill a strided array with uniformly distributed pseudorandom numbers between 0 and 1. +
@@ -267,6 +275,14 @@ logEach( '%f', x4 ); [@stdlib/array/float64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float64 + + +[@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 + + + diff --git a/lib/node_modules/@stdlib/random/strided/betaprime/README.md b/lib/node_modules/@stdlib/random/strided/betaprime/README.md index d7456cdc9a3..4f232d13c0b 100644 --- a/lib/node_modules/@stdlib/random/strided/betaprime/README.md +++ b/lib/node_modules/@stdlib/random/strided/betaprime/README.md @@ -207,6 +207,13 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );
+* * * + +## See Also + +- [`@stdlib/random/base/betaprime`][@stdlib/random/base/betaprime]: beta prime distributed pseudorandom numbers. +- [`@stdlib/random/array/betaprime`][@stdlib/random/array/betaprime]: create an array containing pseudorandom numbers drawn from a beta prime distribution. +
@@ -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 + + +[@stdlib/random/array/betaprime]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/betaprime + + + diff --git a/lib/node_modules/@stdlib/random/strided/minstd/README.md b/lib/node_modules/@stdlib/random/strided/minstd/README.md index a66e0fbb55a..66efe28f088 100644 --- a/lib/node_modules/@stdlib/random/strided/minstd/README.md +++ b/lib/node_modules/@stdlib/random/strided/minstd/README.md @@ -223,6 +223,15 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );
+* * * + +## See Also + +- [`@stdlib/random/base/minstd`][@stdlib/random/base/minstd]: A linear congruential pseudorandom number generator (LCG) based on Park and Miller. +- [`@stdlib/random/array/minstd`][@stdlib/random/array/minstd]: create an array containing pseudorandom numbers generated using a linear congruential pseudorandom number generator (LCG). +- [`@stdlib/random/strided/minstd-shuffle`][@stdlib/random/strided/minstd-shuffle]: fill a strided array with pseudorandom numbers generated using a linear congruential pseudorandom number generator (LCG) whose output is shuffled. +- [`@stdlib/random/strided/randu`][@stdlib/random/strided/randu]: fill a strided array with uniformly distributed pseudorandom numbers between 0 and 1. +
@@ -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 + + +[@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 + + + diff --git a/lib/node_modules/@stdlib/stats/base/dists/truncated-normal/README.md b/lib/node_modules/@stdlib/stats/base/dists/truncated-normal/README.md index a3478e00fea..9bd3b301d1b 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/truncated-normal/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/truncated-normal/README.md @@ -55,16 +55,12 @@ The namespace contains the following functions for calculating distribution prop - - The namespace contains a constructor function for creating a [truncated normal][truncated-normal-distribution] distribution object. - - diff --git a/lib/node_modules/@stdlib/stats/base/min/README.md b/lib/node_modules/@stdlib/stats/base/min/README.md index fd24f334a9f..c2ec19b4bbb 100644 --- a/lib/node_modules/@stdlib/stats/base/min/README.md +++ b/lib/node_modules/@stdlib/stats/base/min/README.md @@ -186,14 +186,10 @@ console.log( v ); -[@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 - diff --git a/lib/node_modules/@stdlib/stats/base/smskmax/README.md b/lib/node_modules/@stdlib/stats/base/smskmax/README.md index 5ac3baba6f4..e2ad2ab9bbf 100644 --- a/lib/node_modules/@stdlib/stats/base/smskmax/README.md +++ b/lib/node_modules/@stdlib/stats/base/smskmax/README.md @@ -195,6 +195,7 @@ console.log( v ); - [`@stdlib/stats/base/smax`][@stdlib/stats/base/smax]: calculate the maximum value of a single-precision floating-point strided array. - [`@stdlib/stats/base/smskmin`][@stdlib/stats/base/smskmin]: calculate the minimum value of a single-precision floating-point strided array according to a mask. - [`@stdlib/stats/base/snanmax`][@stdlib/stats/base/snanmax]: calculate the maximum value of a single-precision floating-point strided array, ignoring NaN values. +- [`@stdlib/stats/base/snanmskmax`][@stdlib/stats/base/snanmskmax]: calculate the maximum value of a single-precision floating-point strided array according to a mask, ignoring NaN values. @@ -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 + diff --git a/lib/node_modules/@stdlib/string/base/first-grapheme-cluster/README.md b/lib/node_modules/@stdlib/string/base/first-grapheme-cluster/README.md index 1bddb7db605..7a59aab2632 100644 --- a/lib/node_modules/@stdlib/string/base/first-grapheme-cluster/README.md +++ b/lib/node_modules/@stdlib/string/base/first-grapheme-cluster/README.md @@ -85,6 +85,14 @@ str = firstGraphemeCluster( '🐶🐮🐷🐰🐸', 10 );
+* * * + +## See Also + +- [`@stdlib/string/base/first`][@stdlib/string/base/first]: return the first UTF-16 code unit of a string. +- [`@stdlib/string/base/first-code-point`][@stdlib/string/base/first-code-point]: return the first Unicode code point of a string. +- [`@stdlib/string/first`][@stdlib/string/first]: return the first character(s) of a string. +
@@ -93,6 +101,16 @@ str = firstGraphemeCluster( '🐶🐮🐷🐰🐸', 10 );
+ + +[@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 + + +
diff --git a/lib/node_modules/@stdlib/string/substring-after-last/README.md b/lib/node_modules/@stdlib/string/substring-after-last/README.md index b1796a26bab..27c1832b498 100644 --- a/lib/node_modules/@stdlib/string/substring-after-last/README.md +++ b/lib/node_modules/@stdlib/string/substring-after-last/README.md @@ -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.