diff --git a/lib/node_modules/@stdlib/array/fixed-endian-factory/README.md b/lib/node_modules/@stdlib/array/fixed-endian-factory/README.md index ab659bbc55ba..c92a71895e80 100644 --- a/lib/node_modules/@stdlib/array/fixed-endian-factory/README.md +++ b/lib/node_modules/@stdlib/array/fixed-endian-factory/README.md @@ -692,7 +692,7 @@ var out = arr.map( fcn, context ); var count = context.count; // returns 3; ``` - + #### TypedArray.prototype.reduce( reducerFn\[, initialValue] ) @@ -758,7 +758,7 @@ var arr = new Float64ArrayFE( 'little-endian', [ 1.0, 0.0, 1.0 ] ); var out = arr.reduceRight( reducer ); // returns 0.0 ``` - + The reducer function is provided four arguments: - **acc**: accumulated result. @@ -784,7 +784,7 @@ var arr = new Float64ArrayFE( 'little-endian', [ 1.0, 0.0, 1.0 ] ); var out = arr.reduceRight( reducer, 0 ); // returns 2 ``` - + #### TypedArrayFE.prototype.set( arr\[, offset] ) @@ -947,7 +947,7 @@ var out = arr.with( 0, 0.0 ); var v = out.get( 0 ); // returns 0.0 ``` - + diff --git a/lib/node_modules/@stdlib/assert/is-same-array/README.md b/lib/node_modules/@stdlib/assert/is-same-array/README.md index fa926e36cc7c..ee9255858e32 100644 --- a/lib/node_modules/@stdlib/assert/is-same-array/README.md +++ b/lib/node_modules/@stdlib/assert/is-same-array/README.md @@ -96,6 +96,8 @@ out = isSameArray( x, y ); ## See Also - [`@stdlib/assert/is-array`][@stdlib/assert/is-array]: test if a value is an array. +- [`@stdlib/assert/is-equal-array`][@stdlib/assert/is-equal-array]: test if two arguments are both generic arrays and have equal values. +- [`@stdlib/assert/is-same-array-like`][@stdlib/assert/is-same-array-like]: test if two arguments are both array-like and have the same values. - [`@stdlib/assert/is-same-value`][@stdlib/assert/is-same-value]: test if two arguments are the same value. @@ -112,6 +114,10 @@ out = isSameArray( x, y ); [@stdlib/assert/is-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-array +[@stdlib/assert/is-equal-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-equal-array + +[@stdlib/assert/is-same-array-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-same-array-like + diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumors/README.md b/lib/node_modules/@stdlib/blas/ext/base/gapxsumors/README.md index c1b502e4cbee..a79be6a84319 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/gapxsumors/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/gapxsumors/README.md @@ -170,10 +170,10 @@ console.log( v ); ## See Also -- [`@stdlib/blas/ext/base/dapxsumors`][@stdlib/blas/ext/base/dapxsumors]: adds a constant to each double-precision floating-point strided array element and computes the sum using ordinary recursive summation. -- [`@stdlib/blas/ext/base/gapxsum`][@stdlib/blas/ext/base/gapxsum]: adds a constant to each strided array element and computes the sum. +- [`@stdlib/blas/ext/base/dapxsumors`][@stdlib/blas/ext/base/dapxsumors]: add a scalar constant to each double-precision floating-point strided array element and compute the sum using ordinary recursive summation. +- [`@stdlib/blas/ext/base/gapxsum`][@stdlib/blas/ext/base/gapxsum]: add a constant to each strided array element and compute the sum. - [`@stdlib/blas/ext/base/gsumors`][@stdlib/blas/ext/base/gsumors]: calculate the sum of strided array elements using ordinary recursive summation. -- [`@stdlib/blas/ext/base/sapxsumors`][@stdlib/blas/ext/base/sapxsumors]: adds a constant to each single-precision floating-point strided array element and computes the sum using ordinary recursive summation. +- [`@stdlib/blas/ext/base/sapxsumors`][@stdlib/blas/ext/base/sapxsumors]: add a constant to each single-precision floating-point strided array element and compute the sum using ordinary recursive summation. diff --git a/lib/node_modules/@stdlib/iter/strided/README.md b/lib/node_modules/@stdlib/iter/strided/README.md index 6d1a8dcf5599..5d3bf19f0362 100644 --- a/lib/node_modules/@stdlib/iter/strided/README.md +++ b/lib/node_modules/@stdlib/iter/strided/README.md @@ -178,7 +178,7 @@ while ( true ) { ## See Also -- [`@stdlib/iter/advance`][@stdlib/iter/advance]: advances an iterator. +- [`@stdlib/iter/advance`][@stdlib/iter/advance]: advance an iterator. - [`@stdlib/iter/nth`][@stdlib/iter/nth]: return the nth iterated value. - [`@stdlib/iter/strided-by`][@stdlib/iter/strided-by]: create an iterator which steps according to a provided callback function. diff --git a/lib/node_modules/@stdlib/math/base/assert/is-nonpositive-finite/README.md b/lib/node_modules/@stdlib/math/base/assert/is-nonpositive-finite/README.md index fbc57c28d95d..aaa22b0cf9ab 100644 --- a/lib/node_modules/@stdlib/math/base/assert/is-nonpositive-finite/README.md +++ b/lib/node_modules/@stdlib/math/base/assert/is-nonpositive-finite/README.md @@ -176,6 +176,14 @@ int main( void ) {
+* * * + +## See Also + +- [`@stdlib/math/base/assert/is-negative-finite`][@stdlib/math/base/assert/is-negative-finite]: test if a double-precision floating-point numeric value is a negative finite number. +- [`@stdlib/math/base/assert/is-positive-finite`][@stdlib/math/base/assert/is-positive-finite]: test if a double-precision floating-point numeric value is a positive finite number. +- [`@stdlib/math/base/assert/is-nonnegative-finite`][@stdlib/math/base/assert/is-nonnegative-finite]: test if a numeric value is a nonnegative finite number. +
@@ -186,6 +194,12 @@ int main( void ) { +[@stdlib/math/base/assert/is-negative-finite]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/assert/is-negative-finite + +[@stdlib/math/base/assert/is-positive-finite]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/assert/is-positive-finite + +[@stdlib/math/base/assert/is-nonnegative-finite]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/assert/is-nonnegative-finite + diff --git a/lib/node_modules/@stdlib/math/base/special/kernel-log1p/README.md b/lib/node_modules/@stdlib/math/base/special/kernel-log1p/README.md index 37b1ae9406f2..d491232c9445 100644 --- a/lib/node_modules/@stdlib/math/base/special/kernel-log1p/README.md +++ b/lib/node_modules/@stdlib/math/base/special/kernel-log1p/README.md @@ -174,6 +174,12 @@ int main( void ) {
+* * * + +## See Also + +- [`@stdlib/math/base/special/log1p`][@stdlib/math/base/special/log1p]: evaluate the natural logarithm of 1+x. +
@@ -188,6 +194,8 @@ int main( void ) { +[@stdlib/math/base/special/log1p]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/log1p + diff --git a/lib/node_modules/@stdlib/math/base/special/rcbrt/README.md b/lib/node_modules/@stdlib/math/base/special/rcbrt/README.md index 7de83c93e533..37f5f95d9da9 100644 --- a/lib/node_modules/@stdlib/math/base/special/rcbrt/README.md +++ b/lib/node_modules/@stdlib/math/base/special/rcbrt/README.md @@ -190,6 +190,12 @@ int main( void ) {
+* * * + +## See Also + +- [`@stdlib/math/base/special/cbrt`][@stdlib/math/base/special/cbrt]: compute the cube root of a double-precision floating-point number. +
@@ -202,6 +208,8 @@ int main( void ) { +[@stdlib/math/base/special/cbrt]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/cbrt + diff --git a/lib/node_modules/@stdlib/math/strided/special/ahavercos-by/README.md b/lib/node_modules/@stdlib/math/strided/special/ahavercos-by/README.md index 941caec95a50..123ef74cf986 100644 --- a/lib/node_modules/@stdlib/math/strided/special/ahavercos-by/README.md +++ b/lib/node_modules/@stdlib/math/strided/special/ahavercos-by/README.md @@ -229,6 +229,12 @@ console.log( y );
+* * * + +## See Also + +- [`@stdlib/math/strided/special/ahaversin-by`][@stdlib/math/strided/special/ahaversin-by]: compute the inverse half-value versed sine of each element retrieved from an input strided array via a callback function. +
@@ -243,6 +249,12 @@ console.log( y ); [@stdlib/math/base/special/ahavercos]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/ahavercos + + +[@stdlib/math/strided/special/ahaversin-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/special/ahaversin-by + + + diff --git a/lib/node_modules/@stdlib/random/array/weibull/README.md b/lib/node_modules/@stdlib/random/array/weibull/README.md index ad0143688863..b509d12e6277 100644 --- a/lib/node_modules/@stdlib/random/array/weibull/README.md +++ b/lib/node_modules/@stdlib/random/array/weibull/README.md @@ -359,6 +359,7 @@ logEach( '%f', x4 ); ## See Also - [`@stdlib/random/base/weibull`][@stdlib/random/base/weibull]: Weibull distributed pseudorandom numbers. +- [`@stdlib/random/strided/weibull`][@stdlib/random/strided/weibull]: fill a strided array with pseudorandom numbers drawn from a Weibull distribution. @@ -376,6 +377,12 @@ logEach( '%f', x4 ); [@stdlib/array/float64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float64 + + +[@stdlib/random/strided/weibull]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided/weibull + + + diff --git a/lib/node_modules/@stdlib/string/base/first-code-point/README.md b/lib/node_modules/@stdlib/string/base/first-code-point/README.md index e535d9f6e57d..779615df945a 100644 --- a/lib/node_modules/@stdlib/string/base/first-code-point/README.md +++ b/lib/node_modules/@stdlib/string/base/first-code-point/README.md @@ -88,6 +88,8 @@ str = firstCodePoint( 'अनुच्छेद', 1 ); - [`@stdlib/string/base/first`][@stdlib/string/base/first]: return the first UTF-16 code unit of a string. - [`@stdlib/string/base/first-grapheme-cluster`][@stdlib/string/base/first-grapheme-cluster]: return the first grapheme cluster (i.e., user-perceived character) of a string. +- [`@stdlib/string/base/last-code-point`][@stdlib/string/base/last-code-point]: return the last Unicode code point of a string. +- [`@stdlib/string/base/remove-first-code-point`][@stdlib/string/base/remove-first-code-point]: remove the first Unicode code point of a string. - [`@stdlib/string/first`][@stdlib/string/first]: return the first character(s) of a string. @@ -104,6 +106,10 @@ str = firstCodePoint( 'अनुच्छेद', 1 ); [@stdlib/string/base/first-grapheme-cluster]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/first-grapheme-cluster +[@stdlib/string/base/last-code-point]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/last-code-point + +[@stdlib/string/base/remove-first-code-point]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/remove-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/base/first-grapheme-cluster/README.md b/lib/node_modules/@stdlib/string/base/first-grapheme-cluster/README.md index 7a59aab2632f..cd14d9933c9b 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 @@ -91,6 +91,8 @@ str = firstGraphemeCluster( '🐶🐮🐷🐰🐸', 10 ); - [`@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/base/last-grapheme-cluster`][@stdlib/string/base/last-grapheme-cluster]: return the last grapheme cluster (i.e., user-perceived character) of a string. +- [`@stdlib/string/base/remove-first-grapheme-cluster`][@stdlib/string/base/remove-first-grapheme-cluster]: remove the first grapheme cluster (i.e., user-perceived character) of a string. - [`@stdlib/string/first`][@stdlib/string/first]: return the first character(s) of a string. @@ -107,6 +109,10 @@ str = firstGraphemeCluster( '🐶🐮🐷🐰🐸', 10 ); [@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/base/last-grapheme-cluster]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/last-grapheme-cluster + +[@stdlib/string/base/remove-first-grapheme-cluster]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/remove-first-grapheme-cluster + [@stdlib/string/first]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/first diff --git a/lib/node_modules/@stdlib/utils/some-own-by/README.md b/lib/node_modules/@stdlib/utils/some-own-by/README.md index 69db603abc67..165225506522 100644 --- a/lib/node_modules/@stdlib/utils/some-own-by/README.md +++ b/lib/node_modules/@stdlib/utils/some-own-by/README.md @@ -219,6 +219,11 @@ bool = someOwnBy( obj, 5, threshold ); ## See Also +- [`@stdlib/utils/any-own-by`][@stdlib/utils/any-own-by]: test whether whether any 'own' property of a provided object satisfies a predicate function. +- [`@stdlib/utils/every-own-by`][@stdlib/utils/every-own-by]: test whether all own properties of an object pass a test implemented by a predicate function. +- [`@stdlib/utils/some-by`][@stdlib/utils/some-by]: test whether a collection contains at least `n` elements which pass a test implemented by a predicate function. +- [`@stdlib/utils/some-in-by`][@stdlib/utils/some-in-by]: test whether an object contains at least n properties (own and inherited) which pass a test implemented by a predicate function. + @@ -231,6 +236,14 @@ bool = someOwnBy( obj, 5, threshold ); +[@stdlib/utils/any-own-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/any-own-by + +[@stdlib/utils/every-own-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/every-own-by + +[@stdlib/utils/some-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/some-by + +[@stdlib/utils/some-in-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/some-in-by +