Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,14 +4,15 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-05-06)
+## Unreleased (2025-05-07)
 
 <section class="commits">
 
 ### Commits
 
 <details>
 
+-   [`6a4f52a`](https://github.com/stdlib-js/stdlib/commit/6a4f52a9c96dbdc023c2d85eaf1c33d8749a4202) - **docs:** correct domain of inverse coversed cosine _(by Karan Anand)_
 -   [`f51b7b2`](https://github.com/stdlib-js/stdlib/commit/f51b7b2ea5c3cceca335f3089fba079d4290bde7) - **test:** update tests to match valid domain of acovercos _(by Karan Anand)_
 
 </details>

README.md

@@ -80,18 +80,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
 
 // ...
 ```
@@ -111,7 +111,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.
 
@@ -132,7 +132,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
 });

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();

dist/index.js.map

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

docs/repl.txt

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

docs/types/index.d.ts

@@ -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
 });

examples/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>

lib/index.js

@@ -31,7 +31,7 @@ var acovercos = require( '@stdlib/math-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( '@stdlib/math-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>