Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions lib/node_modules/@stdlib/assert/is-constantcase/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,13 @@ true

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/assert/is-string`][@stdlib/assert/is-string]</span><span class="delimiter">: </span><span class="description">test if a value is a string.</span>
- <span class="package-name">[`@stdlib/assert/is-camelcase`][@stdlib/assert/is-camelcase]</span><span class="delimiter">: </span><span class="description">test if a value is a camelcase string.</span>

</section>

<!-- /.related -->
Expand All @@ -187,6 +194,10 @@ true

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

[@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

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

</section>
Expand Down
18 changes: 18 additions & 0 deletions lib/node_modules/@stdlib/constants/float32/sign-mask/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,14 @@ Macro for the mask for the sign bit of a [single-precision floating-point number

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/constants/float32/exponent-mask`][@stdlib/constants/float32/exponent-mask]</span><span class="delimiter">: </span><span class="description">mask for the exponent of a single-precision floating-point number.</span>
- <span class="package-name">[`@stdlib/constants/float32/significand-mask`][@stdlib/constants/float32/significand-mask]</span><span class="delimiter">: </span><span class="description">mask for the significand of a single-precision floating-point number.</span>
- <span class="package-name">[`@stdlib/constants/float32/abs-mask`][@stdlib/constants/float32/abs-mask]</span><span class="delimiter">: </span><span class="description">mask for excluding the sign bit of a single-precision floating-point number.</span>

</section>

<!-- /.related -->
Expand All @@ -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

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

[@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

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

</section>

<!-- /.links -->
14 changes: 14 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/asind/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,14 @@ int main( void ) {

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/math/base/special/asin`][@stdlib/math/base/special/asin]</span><span class="delimiter">: </span><span class="description">compute the arcsine of a double-precision floating-point number.</span>
- <span class="package-name">[`@stdlib/math/base/special/asinh`][@stdlib/math/base/special/asinh]</span><span class="delimiter">: </span><span class="description">compute the hyperbolic arcsine of a double-precision floating-point number.</span>
- <span class="package-name">[`@stdlib/math/base/special/atand`][@stdlib/math/base/special/atand]</span><span class="delimiter">: </span><span class="description">compute the arctangent(in degrees) of a double-precision floating-point number.</span>

</section>

<!-- /.related -->
Expand All @@ -190,6 +198,12 @@ int main( void ) {

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

[@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

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

</section>
Expand Down
14 changes: 14 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/atand/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,14 @@ int main( void ) {

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/math/base/special/atan`][@stdlib/math/base/special/atan]</span><span class="delimiter">: </span><span class="description">compute the arctangent of a double-precision floating-point number.</span>
- <span class="package-name">[`@stdlib/math/base/special/atanh`][@stdlib/math/base/special/atanh]</span><span class="delimiter">: </span><span class="description">compute the hyperbolic arctangent of a double-precision floating-point number.</span>
- <span class="package-name">[`@stdlib/math/base/special/acosd`][@stdlib/math/base/special/acosd]</span><span class="delimiter">: </span><span class="description">compute the arccosine (in degrees) of a double-precision floating-point number.</span>

</section>

<!-- /.related -->
Expand All @@ -169,6 +177,12 @@ int main( void ) {

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

[@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

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

</section>
Expand Down
18 changes: 18 additions & 0 deletions lib/node_modules/@stdlib/math/strided/ops/add-by/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,14 @@ console.log( z );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/math/strided/ops/add`][@stdlib/math/strided/ops/add]</span><span class="delimiter">: </span><span class="description">element-wise addition of two strided arrays.</span>
- <span class="package-name">[`@stdlib/math/strided/ops/mul-by`][@stdlib/math/strided/ops/mul-by]</span><span class="delimiter">: </span><span class="description">element-wise multiplication of two strided arrays via a callback function.</span>
- <span class="package-name">[`@stdlib/math/strided/ops/sub-by`][@stdlib/math/strided/ops/sub-by]</span><span class="delimiter">: </span><span class="description">element-wise subtraction of two strided arrays via a callback function.</span>

</section>

<!-- /.related -->
Expand All @@ -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

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

[@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

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

</section>

<!-- /.links -->
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/math/strided/special/cbrt-by/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,12 @@ console.log( y );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/math/strided/special/cbrt`][@stdlib/math/strided/special/cbrt]</span><span class="delimiter">: </span><span class="description">compute the cube root of each element in a strided array.</span>

</section>

<!-- /.related -->
Expand All @@ -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

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

[@stdlib/math/strided/special/cbrt]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/special/cbrt

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

</section>

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

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

</section>

Expand All @@ -374,6 +375,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/bernoulli]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided/bernoulli

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

</section>

<!-- /.links -->
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/string/base/ends-with/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,12 @@ bool = endsWith( str, 'fair', -34 );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/string/base/starts-with`][@stdlib/string/base/starts-with]</span><span class="delimiter">: </span><span class="description">test if a string starts with the characters of another string.</span>

</section>

<!-- /.related -->
Expand All @@ -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

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

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

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

</section>

<!-- /.links -->
6 changes: 6 additions & 0 deletions lib/node_modules/@stdlib/string/base/first/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,8 @@ str = first( 'The Last of the Mohicans', 5 );

- <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/base/first-grapheme-cluster`][@stdlib/string/base/first-grapheme-cluster]</span><span class="delimiter">: </span><span class="description">return the first grapheme cluster (i.e., user-perceived character) of a string.</span>
- <span class="package-name">[`@stdlib/string/base/last`][@stdlib/string/base/last]</span><span class="delimiter">: </span><span class="description">return the last UTF-16 code unit of a string.</span>
- <span class="package-name">[`@stdlib/string/base/remove-first`][@stdlib/string/base/remove-first]</span><span class="delimiter">: </span><span class="description">remove the first UTF-16 code unit 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>
Expand All @@ -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

<!-- </related-links> -->
Expand Down
18 changes: 18 additions & 0 deletions lib/node_modules/@stdlib/string/base/replace-before-last/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,14 @@ out = replaceBeforeLast( str, 'xyz', 'foo', str.length );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/string/base/replace-after-last`][@stdlib/string/base/replace-after-last]</span><span class="delimiter">: </span><span class="description">replace the substring after the last occurrence of a specified search string.</span>
- <span class="package-name">[`@stdlib/string/base/replace-after`][@stdlib/string/base/replace-after]</span><span class="delimiter">: </span><span class="description">replace the substring after the first occurrence of a specified search string.</span>
- <span class="package-name">[`@stdlib/string/base/replace-before`][@stdlib/string/base/replace-before]</span><span class="delimiter">: </span><span class="description">replace the substring before the first occurrence of a specified search string.</span>

</section>

<!-- /.related -->
Expand All @@ -137,6 +145,16 @@ out = replaceBeforeLast( str, 'xyz', 'foo', str.length );

<section class="links">

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

[@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

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

</section>

<!-- /.links -->
15 changes: 15 additions & 0 deletions lib/node_modules/@stdlib/string/base/reverse/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,13 @@ str = reverse( 'The Last of the Mohicans' );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/string/base/reverse-code-points`][@stdlib/string/base/reverse-code-points]</span><span class="delimiter">: </span><span class="description">reverse the Unicode code points of a string.</span>
- <span class="package-name">[`@stdlib/string/base/reverse-grapheme-clusters`][@stdlib/string/base/reverse-grapheme-clusters]</span><span class="delimiter">: </span><span class="description">reverse the grapheme clusters (i.e., user-perceived characters) of a string.</span>

</section>

<!-- /.related -->
Expand All @@ -84,6 +91,14 @@ str = reverse( 'The Last of the Mohicans' );

<section class="links">

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

[@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

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

</section>

<!-- /.links -->
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/string/first/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,7 @@ b
## See Also

- <span class="package-name">[`@stdlib/string/remove-first`][@stdlib/string/remove-first]</span><span class="delimiter">: </span><span class="description">remove the first character(s) of a string.</span>
- <span class="package-name">[`@stdlib/string/last`][@stdlib/string/last]</span><span class="delimiter">: </span><span class="description">return the last character(s) of a string.</span>

</section>

Expand All @@ -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

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

</section>
Expand Down
17 changes: 17 additions & 0 deletions lib/node_modules/@stdlib/utils/any-own-by/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,15 @@ bool = anyOwnBy( obj, threshold );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/utils/any-by`][@stdlib/utils/any-by]</span><span class="delimiter">: </span><span class="description">test whether at least one element in a collection passes a test implemented by a predicate function.</span>
- <span class="package-name">[`@stdlib/utils/any-in-by`][@stdlib/utils/any-in-by]</span><span class="delimiter">: </span><span class="description">test whether at least one property in an object passes a test implemented by a predicate function.</span>
- <span class="package-name">[`@stdlib/utils/every-own-by`][@stdlib/utils/every-own-by]</span><span class="delimiter">: </span><span class="description">test whether all own properties of an object pass a test implemented by a predicate function.</span>
- <span class="package-name">[`@stdlib/utils/some-own-by`][@stdlib/utils/some-own-by]</span><span class="delimiter">: </span><span class="description">test whether some `own` properties of a provided object satisfy a predicate function for at least `n` properties.</span>

</section>

<!-- /.related -->
Expand All @@ -197,6 +206,14 @@ bool = anyOwnBy( obj, threshold );

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

[@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

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

</section>
Expand Down
20 changes: 20 additions & 0 deletions lib/node_modules/@stdlib/utils/every-own-by/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,16 @@ var bool = everyOwnBy( obj, isPositive );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/utils/any-own-by`][@stdlib/utils/any-own-by]</span><span class="delimiter">: </span><span class="description">test whether whether any 'own' property of a provided object satisfies a predicate function.</span>
- <span class="package-name">[`@stdlib/utils/every-in-by`][@stdlib/utils/every-in-by]</span><span class="delimiter">: </span><span class="description">test whether all properties (own and inherited) of an object pass a test implemented by a predicate function.</span>
- <span class="package-name">[`@stdlib/utils/none-own-by`][@stdlib/utils/none-own-by]</span><span class="delimiter">: </span><span class="description">tests whether every own property of an object fails a test implemented by a predicate function.</span>
- <span class="package-name">[`@stdlib/utils/some-own-by`][@stdlib/utils/some-own-by]</span><span class="delimiter">: </span><span class="description">test whether some `own` properties of a provided object satisfy a predicate function for at least `n` properties.</span>
- <span class="package-name">[`@stdlib/utils/every-by`][@stdlib/utils/every-by]</span><span class="delimiter">: </span><span class="description">test whether all elements in a collection pass a test implemented by a predicate function.</span>

</section>

<!-- /.related -->
Expand All @@ -197,6 +207,16 @@ var bool = everyOwnBy( obj, isPositive );

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

[@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

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

</section>
Expand Down