diff --git a/lib/node_modules/@stdlib/assert/is-constantcase/README.md b/lib/node_modules/@stdlib/assert/is-constantcase/README.md index b0503d9e7dc2..b672206d862f 100644 --- a/lib/node_modules/@stdlib/assert/is-constantcase/README.md +++ b/lib/node_modules/@stdlib/assert/is-constantcase/README.md @@ -173,6 +173,13 @@ true
+* * * + +## See Also + +- [`@stdlib/assert/is-string`][@stdlib/assert/is-string]: test if a value is a string. +- [`@stdlib/assert/is-camelcase`][@stdlib/assert/is-camelcase]: test if a value is a camelcase string. +
@@ -187,6 +194,10 @@ true +[@stdlib/assert/is-string]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-string + +[@stdlib/assert/is-camelcase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-camelcase + diff --git a/lib/node_modules/@stdlib/constants/float32/sign-mask/README.md b/lib/node_modules/@stdlib/constants/float32/sign-mask/README.md index 5f99c6b2fe90..47b88c847026 100644 --- a/lib/node_modules/@stdlib/constants/float32/sign-mask/README.md +++ b/lib/node_modules/@stdlib/constants/float32/sign-mask/README.md @@ -150,6 +150,14 @@ Macro for the mask for the sign bit of a [single-precision floating-point number
+* * * + +## See Also + +- [`@stdlib/constants/float32/exponent-mask`][@stdlib/constants/float32/exponent-mask]: mask for the exponent of a single-precision floating-point number. +- [`@stdlib/constants/float32/significand-mask`][@stdlib/constants/float32/significand-mask]: mask for the significand of a single-precision floating-point number. +- [`@stdlib/constants/float32/abs-mask`][@stdlib/constants/float32/abs-mask]: mask for excluding the sign bit of a single-precision floating-point number. +
@@ -160,6 +168,16 @@ Macro for the mask for the sign bit of a [single-precision floating-point number [ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985 + + +[@stdlib/constants/float32/exponent-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/exponent-mask + +[@stdlib/constants/float32/significand-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/significand-mask + +[@stdlib/constants/float32/abs-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/abs-mask + + + diff --git a/lib/node_modules/@stdlib/math/base/special/asind/README.md b/lib/node_modules/@stdlib/math/base/special/asind/README.md index 79f9cb91d479..9508356afe1e 100644 --- a/lib/node_modules/@stdlib/math/base/special/asind/README.md +++ b/lib/node_modules/@stdlib/math/base/special/asind/README.md @@ -178,6 +178,14 @@ int main( void ) {
+* * * + +## See Also + +- [`@stdlib/math/base/special/asin`][@stdlib/math/base/special/asin]: compute the arcsine of a double-precision floating-point number. +- [`@stdlib/math/base/special/asinh`][@stdlib/math/base/special/asinh]: compute the hyperbolic arcsine of a double-precision floating-point number. +- [`@stdlib/math/base/special/atand`][@stdlib/math/base/special/atand]: compute the arctangent(in degrees) of a double-precision floating-point number. +
@@ -190,6 +198,12 @@ int main( void ) { +[@stdlib/math/base/special/asin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/asin + +[@stdlib/math/base/special/asinh]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/asinh + +[@stdlib/math/base/special/atand]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/atand + diff --git a/lib/node_modules/@stdlib/math/base/special/atand/README.md b/lib/node_modules/@stdlib/math/base/special/atand/README.md index 2fbe93c8bc4e..ac3f3e3ed7cc 100644 --- a/lib/node_modules/@stdlib/math/base/special/atand/README.md +++ b/lib/node_modules/@stdlib/math/base/special/atand/README.md @@ -157,6 +157,14 @@ int main( void ) {
+* * * + +## See Also + +- [`@stdlib/math/base/special/atan`][@stdlib/math/base/special/atan]: compute the arctangent of a double-precision floating-point number. +- [`@stdlib/math/base/special/atanh`][@stdlib/math/base/special/atanh]: compute the hyperbolic arctangent of a double-precision floating-point number. +- [`@stdlib/math/base/special/acosd`][@stdlib/math/base/special/acosd]: compute the arccosine (in degrees) of a double-precision floating-point number. +
@@ -169,6 +177,12 @@ int main( void ) { +[@stdlib/math/base/special/atan]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/atan + +[@stdlib/math/base/special/atanh]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/atanh + +[@stdlib/math/base/special/acosd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/acosd + diff --git a/lib/node_modules/@stdlib/math/strided/ops/add-by/README.md b/lib/node_modules/@stdlib/math/strided/ops/add-by/README.md index 84f1b8c9ab84..697dee4dc22b 100644 --- a/lib/node_modules/@stdlib/math/strided/ops/add-by/README.md +++ b/lib/node_modules/@stdlib/math/strided/ops/add-by/README.md @@ -241,6 +241,14 @@ console.log( z );
+* * * + +## See Also + +- [`@stdlib/math/strided/ops/add`][@stdlib/math/strided/ops/add]: element-wise addition of two strided arrays. +- [`@stdlib/math/strided/ops/mul-by`][@stdlib/math/strided/ops/mul-by]: element-wise multiplication of two strided arrays via a callback function. +- [`@stdlib/math/strided/ops/sub-by`][@stdlib/math/strided/ops/sub-by]: element-wise subtraction of two strided arrays via a callback function. +
@@ -255,6 +263,16 @@ console.log( z ); [@stdlib/math/base/ops/add]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/add + + +[@stdlib/math/strided/ops/add]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/ops/add + +[@stdlib/math/strided/ops/mul-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/ops/mul-by + +[@stdlib/math/strided/ops/sub-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/ops/sub-by + + + diff --git a/lib/node_modules/@stdlib/math/strided/special/cbrt-by/README.md b/lib/node_modules/@stdlib/math/strided/special/cbrt-by/README.md index 9690993806b3..dd9165a1cca7 100644 --- a/lib/node_modules/@stdlib/math/strided/special/cbrt-by/README.md +++ b/lib/node_modules/@stdlib/math/strided/special/cbrt-by/README.md @@ -229,6 +229,12 @@ console.log( y );
+* * * + +## See Also + +- [`@stdlib/math/strided/special/cbrt`][@stdlib/math/strided/special/cbrt]: compute the cube root of each element in a strided array. +
@@ -243,6 +249,12 @@ console.log( y ); [@stdlib/math/base/special/cbrt]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/cbrt + + +[@stdlib/math/strided/special/cbrt]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/special/cbrt + + + diff --git a/lib/node_modules/@stdlib/random/array/bernoulli/README.md b/lib/node_modules/@stdlib/random/array/bernoulli/README.md index 8f56adb66e2a..f779235c137f 100644 --- a/lib/node_modules/@stdlib/random/array/bernoulli/README.md +++ b/lib/node_modules/@stdlib/random/array/bernoulli/README.md @@ -357,6 +357,7 @@ logEach( '%f', x4 ); ## See Also - [`@stdlib/random/base/bernoulli`][@stdlib/random/base/bernoulli]: Bernoulli distributed pseudorandom numbers. +- [`@stdlib/random/strided/bernoulli`][@stdlib/random/strided/bernoulli]: fill a strided array with pseudorandom numbers drawn from a Bernoulli distribution. @@ -374,6 +375,12 @@ logEach( '%f', x4 ); [@stdlib/array/float64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float64 + + +[@stdlib/random/strided/bernoulli]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided/bernoulli + + + diff --git a/lib/node_modules/@stdlib/string/base/ends-with/README.md b/lib/node_modules/@stdlib/string/base/ends-with/README.md index 154f8f4af47c..7b3af68d3d1b 100644 --- a/lib/node_modules/@stdlib/string/base/ends-with/README.md +++ b/lib/node_modules/@stdlib/string/base/ends-with/README.md @@ -128,6 +128,12 @@ bool = endsWith( str, 'fair', -34 );
+* * * + +## See Also + +- [`@stdlib/string/base/starts-with`][@stdlib/string/base/starts-with]: test if a string starts with the characters of another string. +
@@ -138,6 +144,12 @@ bool = endsWith( str, 'fair', -34 ); [mdn-string-endswith]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/endsWith + + +[@stdlib/string/base/starts-with]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/starts-with + + + diff --git a/lib/node_modules/@stdlib/string/base/first/README.md b/lib/node_modules/@stdlib/string/base/first/README.md index 6889b5cd7939..d3b2ff89ed82 100644 --- a/lib/node_modules/@stdlib/string/base/first/README.md +++ b/lib/node_modules/@stdlib/string/base/first/README.md @@ -85,6 +85,8 @@ str = first( 'The Last of the Mohicans', 5 ); - [`@stdlib/string/base/first-code-point`][@stdlib/string/base/first-code-point]: return the first Unicode code point 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`][@stdlib/string/base/last]: return the last UTF-16 code unit of a string. +- [`@stdlib/string/base/remove-first`][@stdlib/string/base/remove-first]: remove the first UTF-16 code unit of a string. - [`@stdlib/string/first`][@stdlib/string/first]: return the first character(s) of a string. @@ -101,6 +103,10 @@ str = first( 'The Last of the Mohicans', 5 ); [@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]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/last + +[@stdlib/string/base/remove-first]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/remove-first + [@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/replace-before-last/README.md b/lib/node_modules/@stdlib/string/base/replace-before-last/README.md index cbfaf3d65442..03876383e5a4 100644 --- a/lib/node_modules/@stdlib/string/base/replace-before-last/README.md +++ b/lib/node_modules/@stdlib/string/base/replace-before-last/README.md @@ -129,6 +129,14 @@ out = replaceBeforeLast( str, 'xyz', 'foo', str.length );
+* * * + +## See Also + +- [`@stdlib/string/base/replace-after-last`][@stdlib/string/base/replace-after-last]: replace the substring after the last occurrence of a specified search string. +- [`@stdlib/string/base/replace-after`][@stdlib/string/base/replace-after]: replace the substring after the first occurrence of a specified search string. +- [`@stdlib/string/base/replace-before`][@stdlib/string/base/replace-before]: replace the substring before the first occurrence of a specified search string. +
@@ -137,6 +145,16 @@ out = replaceBeforeLast( str, 'xyz', 'foo', str.length );
+ + +[@stdlib/string/base/replace-after-last]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/replace-after-last + +[@stdlib/string/base/replace-after]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/replace-after + +[@stdlib/string/base/replace-before]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/replace-before + + +
diff --git a/lib/node_modules/@stdlib/string/base/reverse/README.md b/lib/node_modules/@stdlib/string/base/reverse/README.md index 466cf4bc5f8e..9000fc0ca4d0 100644 --- a/lib/node_modules/@stdlib/string/base/reverse/README.md +++ b/lib/node_modules/@stdlib/string/base/reverse/README.md @@ -76,6 +76,13 @@ str = reverse( 'The Last of the Mohicans' );
+* * * + +## See Also + +- [`@stdlib/string/base/reverse-code-points`][@stdlib/string/base/reverse-code-points]: reverse the Unicode code points of a string. +- [`@stdlib/string/base/reverse-grapheme-clusters`][@stdlib/string/base/reverse-grapheme-clusters]: reverse the grapheme clusters (i.e., user-perceived characters) of a string. +
@@ -84,6 +91,14 @@ str = reverse( 'The Last of the Mohicans' );
+ + +[@stdlib/string/base/reverse-code-points]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/reverse-code-points + +[@stdlib/string/base/reverse-grapheme-clusters]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/reverse-grapheme-clusters + + +
diff --git a/lib/node_modules/@stdlib/string/first/README.md b/lib/node_modules/@stdlib/string/first/README.md index c9065788d0f9..c52ae82058f3 100644 --- a/lib/node_modules/@stdlib/string/first/README.md +++ b/lib/node_modules/@stdlib/string/first/README.md @@ -203,6 +203,7 @@ b ## See Also - [`@stdlib/string/remove-first`][@stdlib/string/remove-first]: remove the first character(s) of a string. +- [`@stdlib/string/last`][@stdlib/string/last]: return the last character(s) of a string. @@ -220,6 +221,8 @@ b [@stdlib/string/remove-first]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/remove-first +[@stdlib/string/last]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/last + diff --git a/lib/node_modules/@stdlib/utils/any-own-by/README.md b/lib/node_modules/@stdlib/utils/any-own-by/README.md index ffb4b8e2ae74..5fba1a895494 100644 --- a/lib/node_modules/@stdlib/utils/any-own-by/README.md +++ b/lib/node_modules/@stdlib/utils/any-own-by/README.md @@ -185,6 +185,15 @@ bool = anyOwnBy( obj, threshold );
+* * * + +## See Also + +- [`@stdlib/utils/any-by`][@stdlib/utils/any-by]: test whether at least one element in a collection passes a test implemented by a predicate function. +- [`@stdlib/utils/any-in-by`][@stdlib/utils/any-in-by]: test whether at least one property in an object passes a test implemented by 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-own-by`][@stdlib/utils/some-own-by]: test whether some `own` properties of a provided object satisfy a predicate function for at least `n` properties. +
@@ -197,6 +206,14 @@ bool = anyOwnBy( obj, threshold ); +[@stdlib/utils/any-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/any-by + +[@stdlib/utils/any-in-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/any-in-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-own-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/some-own-by + diff --git a/lib/node_modules/@stdlib/utils/every-own-by/README.md b/lib/node_modules/@stdlib/utils/every-own-by/README.md index dcc46a484d8d..fa3d924dc04a 100644 --- a/lib/node_modules/@stdlib/utils/every-own-by/README.md +++ b/lib/node_modules/@stdlib/utils/every-own-by/README.md @@ -185,6 +185,16 @@ var bool = everyOwnBy( obj, isPositive );
+* * * + +## 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-in-by`][@stdlib/utils/every-in-by]: test whether all properties (own and inherited) of an object pass a test implemented by a predicate function. +- [`@stdlib/utils/none-own-by`][@stdlib/utils/none-own-by]: tests whether every own property of an object fails a test implemented by a predicate function. +- [`@stdlib/utils/some-own-by`][@stdlib/utils/some-own-by]: test whether some `own` properties of a provided object satisfy a predicate function for at least `n` properties. +- [`@stdlib/utils/every-by`][@stdlib/utils/every-by]: test whether all elements in a collection pass a test implemented by a predicate function. +
@@ -197,6 +207,16 @@ var bool = everyOwnBy( obj, isPositive ); +[@stdlib/utils/any-own-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/any-own-by + +[@stdlib/utils/every-in-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/every-in-by + +[@stdlib/utils/none-own-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/none-own-by + +[@stdlib/utils/some-own-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/some-own-by + +[@stdlib/utils/every-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/every-by +