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
8 changes: 4 additions & 4 deletions lib/node_modules/@stdlib/array/fixed-endian-factory/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -692,7 +692,7 @@ var out = arr.map( fcn, context );
var count = context.count;
// returns 3;
```

<a name="method-reduce"></a>

#### TypedArray.prototype.reduce( reducerFn\[, initialValue] )
Expand Down Expand Up @@ -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.
Expand All @@ -784,7 +784,7 @@ var arr = new Float64ArrayFE( 'little-endian', [ 1.0, 0.0, 1.0 ] );
var out = arr.reduceRight( reducer, 0 );
// returns 2
```

<a name="method-set"></a>

#### TypedArrayFE.prototype.set( arr\[, offset] )
Expand Down Expand Up @@ -947,7 +947,7 @@ var out = arr.with( 0, 0.0 );
var v = out.get( 0 );
// returns 0.0
```

</section>

<!-- /.usage -->
Expand Down
6 changes: 6 additions & 0 deletions lib/node_modules/@stdlib/assert/is-same-array/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,8 @@ out = isSameArray( x, y );
## See Also

- <span class="package-name">[`@stdlib/assert/is-array`][@stdlib/assert/is-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array.</span>
- <span class="package-name">[`@stdlib/assert/is-equal-array`][@stdlib/assert/is-equal-array]</span><span class="delimiter">: </span><span class="description">test if two arguments are both generic arrays and have equal values.</span>
- <span class="package-name">[`@stdlib/assert/is-same-array-like`][@stdlib/assert/is-same-array-like]</span><span class="delimiter">: </span><span class="description">test if two arguments are both array-like and have the same values.</span>
- <span class="package-name">[`@stdlib/assert/is-same-value`][@stdlib/assert/is-same-value]</span><span class="delimiter">: </span><span class="description">test if two arguments are the same value.</span>

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

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

</section>
Expand Down
6 changes: 3 additions & 3 deletions lib/node_modules/@stdlib/blas/ext/base/gapxsumors/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,10 +170,10 @@ console.log( v );

## See Also

- <span class="package-name">[`@stdlib/blas/ext/base/dapxsumors`][@stdlib/blas/ext/base/dapxsumors]</span><span class="delimiter">: </span><span class="description">adds a constant to each double-precision floating-point strided array element and computes the sum using ordinary recursive summation.</span>
- <span class="package-name">[`@stdlib/blas/ext/base/gapxsum`][@stdlib/blas/ext/base/gapxsum]</span><span class="delimiter">: </span><span class="description">adds a constant to each strided array element and computes the sum.</span>
- <span class="package-name">[`@stdlib/blas/ext/base/dapxsumors`][@stdlib/blas/ext/base/dapxsumors]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each double-precision floating-point strided array element and compute the sum using ordinary recursive summation.</span>
- <span class="package-name">[`@stdlib/blas/ext/base/gapxsum`][@stdlib/blas/ext/base/gapxsum]</span><span class="delimiter">: </span><span class="description">add a constant to each strided array element and compute the sum.</span>
- <span class="package-name">[`@stdlib/blas/ext/base/gsumors`][@stdlib/blas/ext/base/gsumors]</span><span class="delimiter">: </span><span class="description">calculate the sum of strided array elements using ordinary recursive summation.</span>
- <span class="package-name">[`@stdlib/blas/ext/base/sapxsumors`][@stdlib/blas/ext/base/sapxsumors]</span><span class="delimiter">: </span><span class="description">adds a constant to each single-precision floating-point strided array element and computes the sum using ordinary recursive summation.</span>
- <span class="package-name">[`@stdlib/blas/ext/base/sapxsumors`][@stdlib/blas/ext/base/sapxsumors]</span><span class="delimiter">: </span><span class="description">add a constant to each single-precision floating-point strided array element and compute the sum using ordinary recursive summation.</span>

</section>

Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/iter/strided/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ while ( true ) {

## See Also

- <span class="package-name">[`@stdlib/iter/advance`][@stdlib/iter/advance]</span><span class="delimiter">: </span><span class="description">advances an iterator.</span>
- <span class="package-name">[`@stdlib/iter/advance`][@stdlib/iter/advance]</span><span class="delimiter">: </span><span class="description">advance an iterator.</span>
- <span class="package-name">[`@stdlib/iter/nth`][@stdlib/iter/nth]</span><span class="delimiter">: </span><span class="description">return the nth iterated value.</span>
- <span class="package-name">[`@stdlib/iter/strided-by`][@stdlib/iter/strided-by]</span><span class="delimiter">: </span><span class="description">create an iterator which steps according to a provided callback function.</span>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,14 @@ int main( void ) {

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/math/base/assert/is-negative-finite`][@stdlib/math/base/assert/is-negative-finite]</span><span class="delimiter">: </span><span class="description">test if a double-precision floating-point numeric value is a negative finite number.</span>
- <span class="package-name">[`@stdlib/math/base/assert/is-positive-finite`][@stdlib/math/base/assert/is-positive-finite]</span><span class="delimiter">: </span><span class="description">test if a double-precision floating-point numeric value is a positive finite number.</span>
- <span class="package-name">[`@stdlib/math/base/assert/is-nonnegative-finite`][@stdlib/math/base/assert/is-nonnegative-finite]</span><span class="delimiter">: </span><span class="description">test if a numeric value is a nonnegative finite number.</span>

</section>

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

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

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

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

</section>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,12 @@ int main( void ) {

<section class="related">

* * *

## 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>

</section>

<!-- /.related -->
Expand All @@ -188,6 +194,8 @@ int main( void ) {

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

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

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

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

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/math/base/special/cbrt`][@stdlib/math/base/special/cbrt]</span><span class="delimiter">: </span><span class="description">compute the cube root of a double-precision floating-point number.</span>

</section>

<!-- /.related -->
Expand All @@ -202,6 +208,8 @@ int main( void ) {

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

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

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

</section>
Expand Down
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/ahaversin-by`][@stdlib/math/strided/special/ahaversin-by]</span><span class="delimiter">: </span><span class="description">compute the inverse half-value versed sine of each element retrieved from an input strided array via a callback function.</span>

</section>

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

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

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

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

</section>

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

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

</section>

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

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

</section>

<!-- /.links -->
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,8 @@ str = firstCodePoint( 'अनुच्छेद', 1 );

- <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-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-code-point`][@stdlib/string/base/last-code-point]</span><span class="delimiter">: </span><span class="description">return the last Unicode code point of a string.</span>
- <span class="package-name">[`@stdlib/string/base/remove-first-code-point`][@stdlib/string/base/remove-first-code-point]</span><span class="delimiter">: </span><span class="description">remove 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>
Expand All @@ -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

<!-- </related-links> -->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,8 @@ str = firstGraphemeCluster( '🐶🐮🐷🐰🐸', 10 );

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

<!-- </related-links> -->
Expand Down
13 changes: 13 additions & 0 deletions lib/node_modules/@stdlib/utils/some-own-by/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,11 @@ bool = someOwnBy( obj, 5, threshold );

## 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-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-by`][@stdlib/utils/some-by]</span><span class="delimiter">: </span><span class="description">test whether a collection contains at least `n` elements which pass a test implemented by a predicate function.</span>
- <span class="package-name">[`@stdlib/utils/some-in-by`][@stdlib/utils/some-in-by]</span><span class="delimiter">: </span><span class="description">test whether an object contains at least n properties (own and inherited) which pass a test implemented by a predicate function.</span>

</section>

<!-- /.related -->
Expand All @@ -231,6 +236,14 @@ bool = someOwnBy( obj, 5, threshold );

<!-- <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-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

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

</section>
Expand Down
Loading