Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -459,6 +459,7 @@ A total of 41 issues were closed in this release:
 
 <details>
 
+-   [`6a4f52a`](https://github.com/stdlib-js/stdlib/commit/6a4f52a9c96dbdc023c2d85eaf1c33d8749a4202) - **docs:** correct domain of inverse coversed cosine _(by Karan Anand)_
 -   [`3dd8cb3`](https://github.com/stdlib-js/stdlib/commit/3dd8cb379ea22c4a92d610d146cdd662d3187e27) - **chore:** minor clean-up _(by Philipp Burckhardt)_
 -   [`f51b7b2`](https://github.com/stdlib-js/stdlib/commit/f51b7b2ea5c3cceca335f3089fba079d4290bde7) - **test:** update tests to match valid domain of acovercos _(by Karan Anand)_
 -   [`e525deb`](https://github.com/stdlib-js/stdlib/commit/e525debf09ec10ada9ec72ea4674ee9fd8e049cb) - **fix:** use correct inverse coversed cosine formula _(by Karan Anand)_

base/special/acovercos/README.md

@@ -131,8 +131,8 @@ logEachMap( 'acovercos(%0.4f) = %0.4f', x, acovercos );
 Computes the [inverse coversed cosine][inverse-coversed-cosine] of a double-precision floating-point number.
 
 ```c
-double out = stdlib_base_acovercos( -3.141592653589793/2.0 );
-// returns ~-0.6075
+double out = stdlib_base_acovercos( 3.141592653589793/2.0 );
+// returns ~0.6075
 ```
 
 The function accepts the following arguments:

iter/special/acovercos/README.md

@@ -47,18 +47,18 @@ Returns an [iterator][mdn-iterator-protocol] which iteratively computes the [inv
 ```javascript
 var array2iterator = require( '@stdlib/array/to-iterator' );
 
-var x = [ 0.0, -3.141592653589793/2.0, -3.141592653589793/6.0 ];
+var x = [ 0.0, 3.141592653589793/2.0, 3.141592653589793/6.0 ];
 var it = iterAcovercos( array2iterator( x ) );
 // returns <Object>
 
 var r = it.next().value;
-// returns ~1.5708
+// returns ~-1.5708
 
 r = it.next().value;
-// returns ~-0.6075
+// returns ~0.6075
 
 r = it.next().value;
-// returns ~0.4966
+// returns ~-0.4966
 
 // ...
 ```
@@ -78,7 +78,7 @@ The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the
 
 ## Notes
 
--   The domain of inverse coversed cosine is restricted to `[-2,0]`. If an iterated value is outside of the domain, the returned [iterator][mdn-iterator-protocol] returns `NaN`.
+-   The domain of inverse coversed cosine is restricted to `[0,2]`. If an iterated value is outside of the domain, the returned [iterator][mdn-iterator-protocol] returns `NaN`.
 -   If an iterated value is non-numeric (including `NaN`), the returned [iterator][mdn-iterator-protocol] returns `NaN`. If non-numeric iterated values are possible, you are advised to provide an [`iterator`][mdn-iterator-protocol] which type checks and handles non-numeric values accordingly.
 -   If an environment supports `Symbol.iterator` **and** a provided [iterator][mdn-iterator-protocol] is iterable, the returned [iterator][mdn-iterator-protocol] is iterable.
 
@@ -99,7 +99,7 @@ var uniform = require( '@stdlib/random/iter/uniform' );
 var iterAcovercos = require( '@stdlib/math/iter/special/acovercos' );
 
 // Create a seeded iterator for generating pseudorandom numbers:
-var rand = uniform( -2.0, 0.0, {
+var rand = uniform( 0.0, 2.0, {
     'seed': 1234,
     'iter': 10
 });

iter/special/acovercos/benchmark/benchmark.js

@@ -35,7 +35,7 @@ bench( pkg, function benchmark( b ) {
 	var iter;
 	var i;
 
-	rand = uniform( -2.0, 0.0 );
+	rand = uniform( 0.0, 2.0 );
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
@@ -58,7 +58,7 @@ bench( pkg+'::iteration', function benchmark( b ) {
 	var z;
 	var i;
 
-	rand = uniform( -2.0, 0.0 );
+	rand = uniform( 0.0, 2.0 );
 	iter = iterAcovercos( rand );
 
 	b.tic();

iter/special/acovercos/docs/repl.txt

@@ -2,7 +2,7 @@
 {{alias}}( iterator )
     Returns an iterator which iteratively computes the inverse coversed cosine.
 
-    The domain of inverse coversed cosine is restricted to [-2,0]. If an
+    The domain of inverse coversed cosine is restricted to [0,2]. If an
     iterated value is outside of the domain, the returned iterator returns
     `NaN`.
 
@@ -29,7 +29,7 @@
 
     Examples
     --------
-    > var it = {{alias}}( {{alias:@stdlib/random/iter/uniform}}( -2.0, 0.0 ) );
+    > var it = {{alias}}( {{alias:@stdlib/random/iter/uniform}}( 0.0, 2.0 ) );
     > var r = it.next().value
     <number>
     > r = it.next().value

iter/special/acovercos/docs/types/index.d.ts

@@ -30,7 +30,7 @@ type Iterator = Iter | IterableIterator;
 *
 * ## Notes
 *
-* -   The domain of inverse coversed cosine is restricted to `[-2,0]`. If an iterated value is outside of the domain, the returned iterator returns `NaN`.
+* -   The domain of inverse coversed cosine is restricted to `[0,2]`. If an iterated value is outside of the domain, the returned iterator returns `NaN`.
 * -   If an environment supports `Symbol.iterator` **and** a provided iterator is iterable, the returned iterator is iterable.
 *
 * @param iterator - input iterator
@@ -39,7 +39,7 @@ type Iterator = Iter | IterableIterator;
 * @example
 * var uniform = require( '@stdlib/random/iter/uniform' );
 *
-* var iter = iterAcovercos( uniform( -2.0, 0.0 ) );
+* var iter = iterAcovercos( uniform( 0.0, 2.0 ) );
 *
 * var r = iter.next().value;
 * // returns <number>

iter/special/acovercos/examples/index.js

@@ -22,7 +22,7 @@ var uniform = require( '@stdlib/random/iter/uniform' );
 var iterAcovercos = require( './../lib' );
 
 // Create a seeded iterator for generating pseudorandom numbers:
-var rand = uniform( -2.0, 0.0, {
+var rand = uniform( 0.0, 2.0, {
 	'seed': 1234,
 	'iter': 10
 });

iter/special/acovercos/lib/index.js

@@ -27,7 +27,7 @@
 * var uniform = require( '@stdlib/random/iter/uniform' );
 * var iterAcovercos = require( '@stdlib/math/iter/special/acovercos' );
 *
-* var iter = iterAcovercos( uniform( -2.0, 0.0 ) );
+* var iter = iterAcovercos( uniform( 0.0, 2.0 ) );
 *
 * var r = iter.next().value;
 * // returns <number>

iter/special/acovercos/lib/main.js

@@ -31,7 +31,7 @@ var acovercos = require( './../../../../base/special/acovercos' );
 *
 * ## Notes
 *
-* -   The domain of inverse coversed cosine is restricted to `[-2,0]`. If an iterated value is outside of the domain, the returned iterator returns `NaN`.
+* -   The domain of inverse coversed cosine is restricted to `[0,2]`. If an iterated value is outside of the domain, the returned iterator returns `NaN`.
 * -   If an environment supports `Symbol.iterator` **and** a provided iterator is iterable, the returned iterator is iterable.
 *
 * @param {Iterator} iterator - input iterator
@@ -41,7 +41,7 @@ var acovercos = require( './../../../../base/special/acovercos' );
 * @example
 * var uniform = require( '@stdlib/random/iter/uniform' );
 *
-* var iter = iterAcovercos( uniform( -2.0, 0.0 ) );
+* var iter = iterAcovercos( uniform( 0.0, 2.0 ) );
 *
 * var r = iter.next().value;
 * // returns <number>

strided/special/acovercos-by/README.md

@@ -47,11 +47,11 @@ function accessor( v ) {
     return v;
 }
 
-var x = [ 0.0, -1.57, -0.5, -1.0, -1.25 ];
+var x = [ 0.0, 1.57, 0.5, 1.0, 1.25 ];
 var y = [ 0.0, 0.0, 0.0, 0.0, 0.0 ];
 
 acovercosBy( x.length, x, 1, y, 1, accessor );
-// y => [ ~1.571, ~-0.607, ~0.524, 0.0, ~-0.253 ]
+// y => [ ~-1.571, ~0.607, ~-0.524, 0.0, ~0.253 ]
 ```
 
 The function accepts the following arguments:
@@ -85,11 +85,11 @@ var context = {
     'count': 0
 };
 
-var x = [ 0.0, -1.57, -0.5, -1.0, -1.25 ];
+var x = [ 0.0, 1.57, 0.5, 1.0, 1.25 ];
 var y = [ 0.0, 0.0, 0.0, 0.0, 0.0 ];
 
 acovercosBy( x.length, x, 1, y, 1, accessor, context );
-// y => [ ~1.571, ~-0.607, ~0.524, 0.0, ~-0.253 ]
+// y => [ ~-1.571, ~0.607, ~-0.524, 0.0, ~0.253 ]
 
 var cnt = context.count;
 // returns 5
@@ -102,11 +102,11 @@ function accessor( v ) {
     return v;
 }
 
-var x = [ 0.0, -1.57, -0.5, -1.0, -1.25, -0.67 ];
+var x = [ 0.0, 1.57, 0.5, 1.0, 1.25, 0.67 ];
 var y = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
 
 acovercosBy( 3, x, 2, y, -1, accessor );
-// y => [ ~-0.253, ~0.524, ~1.571, 0.0, 0.0, 0.0 ]
+// y => [ ~0.253, ~-0.524, ~-1.571, 0.0, 0.0, 0.0 ]
 ```
 
 Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
@@ -119,15 +119,15 @@ function accessor( v ) {
 }
 
 // Initial arrays...
-var x0 = new Float64Array( [ 0.0, -1.57, -0.5, -1.0, -1.25, -0.67 ] );
+var x0 = new Float64Array( [ 0.0, 1.57, 0.5, 1.0, 1.25, 0.67 ] );
 var y0 = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
 
 // Create offset views...
 var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
 var y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*3 ); // start at 4th element
 
 acovercosBy( 3, x1, -2, y1, 1, accessor );
-// y0 => <Float64Array>[ 0.0, 0.0, 0.0, ~0.336, 0.0, ~-0.607 ]
+// y0 => <Float64Array>[ 0.0, 0.0, 0.0, ~-0.336, 0.0, ~0.607 ]
 ```
 
 #### acovercosBy.ndarray( N, x, strideX, offsetX, y, strideY, offsetY, clbk\[, thisArg] )
@@ -139,11 +139,11 @@ function accessor( v ) {
     return v;
 }
 
-var x = [ 0.0, -1.57, -0.5, -1.0, -1.25 ];
+var x = [ 0.0, 1.57, 0.5, 1.0, 1.25 ];
 var y = [ 0.0, 0.0, 0.0, 0.0, 0.0 ];
 
 acovercosBy.ndarray( x.length, x, 1, 0, y, 1, 0, accessor );
-// y => [ ~1.571, ~-0.607, ~0.524, 0.0, ~-0.253 ]
+// y => [ ~-1.571, ~0.607, ~-0.524, 0.0, ~0.253 ]
 ```
 
 The function accepts the following additional arguments:
@@ -158,11 +158,11 @@ function accessor( v ) {
     return v;
 }
 
-var x = [ 0.0, -1.57, -0.5, -1.0, -1.25, -0.67 ];
+var x = [ 0.0, 1.57, 0.5, 1.0, 1.25, 0.67 ];
 var y = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
 
 acovercosBy.ndarray( 3, x, 2, 1, y, -1, y.length-1, accessor );
-// y => [ 0.0, 0.0, 0.0, ~0.336, 0.0, ~-0.607 ]
+// y => [ 0.0, 0.0, 0.0, ~-0.336, 0.0, ~0.607 ]
 ```
 
 </section>
@@ -180,7 +180,7 @@ acovercosBy.ndarray( 3, x, 2, 1, y, -1, y.length-1, accessor );
         // No-op...
     }
 
-    var x = [ 0.0, -1.57, -0.5, -1.0, -1.25 ];
+    var x = [ 0.0, 1.57, 0.5, 1.0, 1.25 ];
     var y = [ 0.0, 0.0, 0.0, 0.0, 0.0 ];
 
     acovercosBy( x.length, x, 1, y, 1, accessor );
@@ -211,7 +211,7 @@ function accessor( v, i ) {
     return v;
 }
 
-var x = filledarrayBy( 10, 'generic', uniform( -2.0, 0.0 ) );
+var x = filledarrayBy( 10, 'generic', uniform( 0.0, 2.0 ) );
 console.log( x );
 
 var y = filledarray( null, 10, 'generic' );