Add iterator to compute the inverse coversed sine

Author: kgryte

lib/node_modules/@stdlib/math/iter/special/acoversin/README.md

@@ -0,0 +1,143 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2020 The Stdlib Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+-->
+
+# iterAcoversin
+
+> Create an [iterator][mdn-iterator-protocol] which iteratively computes the [inverse coversed sine][@stdlib/math/base/special/acoversin].
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- Package usage documentation. -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var iterAcoversin = require( '@stdlib/math/iter/special/acoversin' );
+```
+
+#### iterAcoversin( iterator )
+
+Returns an [iterator][mdn-iterator-protocol] which iteratively computes the [inverse coversed sine][@stdlib/math/base/special/acoversin].
+
+```javascript
+var array2iterator = require( '@stdlib/array/to-iterator' );
+
+var x = [ 0.0, 3.141592653589793/2.0, 3.141592653589793/6.0 ];
+var it = iterAcoversin( array2iterator( x ) );
+// returns <Object>
+
+var r = it.next().value;
+// returns ~1.5708
+
+r = it.next().value;
+// returns ~-0.6075
+
+r = it.next().value;
+// returns ~0.4966
+
+// ...
+```
+
+The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the following properties:
+
+-   **next**: function which returns an [iterator][mdn-iterator-protocol] protocol-compliant object containing the next iterated value (if one exists) assigned to a `value` property and a `done` property having a `boolean` value indicating whether the iterator is finished.
+-   **return**: function which closes an [iterator][mdn-iterator-protocol] and returns a single (optional) argument in an [iterator][mdn-iterator-protocol] protocol-compliant object.
+
+</section>
+
+<!-- /.usage -->
+
+<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+## Notes
+
+-   The domain of inverse coverse sine is restricted to `[-2,0]`. 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.
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var uniform = require( '@stdlib/random/iter/uniform' );
+var iterAcoversin = require( '@stdlib/math/iter/special/acoversin' );
+
+// Create a seeded iterator for generating pseudorandom numbers:
+var rand = uniform( 0.0, 2.0, {
+    'seed': 1234,
+    'iter': 10
+});
+
+// Create an iterator which consumes the pseudorandom number iterator:
+var it = iterAcoversin( rand );
+
+// Perform manual iteration...
+var r;
+while ( true ) {
+    r = it.next();
+    if ( r.done ) {
+        break;
+    }
+    console.log( r.value );
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="references">
+
+</section>
+
+<!-- /.references -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol
+
+[@stdlib/math/base/special/acoversin]: https://github.com/stdlib-js/stdlib
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/math/iter/special/acoversin/benchmark/benchmark.js

@@ -0,0 +1,77 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2020 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var uniform = require( '@stdlib/random/iter/uniform' );
+var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var isIteratorLike = require( '@stdlib/assert/is-iterator-like' );
+var pkg = require( './../package.json' ).name;
+var iterAcoversin = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var rand;
+	var iter;
+	var i;
+
+	rand = uniform( 0.0, 2.0 );
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		iter = iterAcoversin( rand );
+		if ( typeof iter !== 'object' ) {
+			b.fail( 'should return an object' );
+		}
+	}
+	b.toc();
+	if ( !isIteratorLike( iter ) ) {
+		b.fail( 'should return an iterator protocol-compliant object' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
+bench( pkg+'::iteration', function benchmark( b ) {
+	var rand;
+	var iter;
+	var z;
+	var i;
+
+	rand = uniform( 0.0, 2.0 );
+	iter = iterAcoversin( rand );
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		z = iter.next().value;
+		if ( isnan( z ) ) {
+			b.fail( 'should not return NaN' );
+		}
+	}
+	b.toc();
+	if ( isnan( z ) ) {
+		b.fail( 'should not return NaN' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

lib/node_modules/@stdlib/math/iter/special/acoversin/docs/repl.txt

@@ -0,0 +1,40 @@
+
+{{alias}}( iterator )
+    Returns an iterator which iteratively computes the inverse coversed sine.
+
+    The domain of inverse coversed sine 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.
+
+    Parameters
+    ----------
+    iterator: Object
+        Input iterator.
+
+    Returns
+    -------
+    iterator: Object
+        Iterator.
+
+    iterator.next(): Function
+        Returns an iterator protocol-compliant object containing the next
+        iterated value (if one exists) and a boolean flag indicating whether the
+        iterator is finished.
+
+    iterator.return( [value] ): Function
+        Finishes an iterator and returns a provided value.
+
+    Examples
+    --------
+    > var it = {{alias}}( {{alias:@stdlib/random/iter/uniform}}( -2.0, 0.0 ) );
+    > var r = it.next().value
+    <number>
+    > r = it.next().value
+    <number>
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/math/iter/special/acoversin/docs/types/index.d.ts

@@ -0,0 +1,60 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2020 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+// TypeScript Version: 2.0
+
+/// <reference types="@stdlib/types"/>
+
+import { Iterator as Iter, IterableIterator } from '@stdlib/types/iter';
+
+// Define a union type representing both iterable and non-iterable iterators:
+type Iterator = Iter | IterableIterator;
+
+/**
+* Returns an iterator which iteratively computes the inverse coversed sine.
+*
+* ## Notes
+*
+* -   The domain of inversed coversed sine 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
+* @returns iterator
+*
+* @example
+* var uniform = require( `@stdlib/random/iter/uniform` );
+*
+* var iter = iterAcoversin( uniform( 0.0, 2.0 ) );
+*
+* var r = iter.next().value;
+* // returns <number>
+*
+* r = iter.next().value;
+* // returns <number>
+*
+* r = iter.next().value;
+* // returns <number>
+*
+* // ...
+*/
+declare function iterAcoversin( iterator: Iterator ): Iterator;
+
+
+// EXPORTS //
+
+export = iterAcoversin;

lib/node_modules/@stdlib/math/iter/special/acoversin/docs/types/test.ts

@@ -0,0 +1,68 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2020 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+import iterAcoversin = require( './index' );
+
+/**
+* Returns an iterator protocol-compliant object.
+*
+* @returns iterator protocol-compliant object
+*/
+function iterator() {
+	return {
+		'next': next
+	};
+
+	/**
+	* Implements the iterator protocol `next` method.
+	*
+	* @returns iterator protocol-compliant object
+	*/
+	function next() {
+		return {
+			'value': true,
+			'done': false
+		};
+	}
+}
+
+
+// TESTS //
+
+// The function returns an iterator...
+{
+	iterAcoversin( iterator() ); // $ExpectType Iterator
+}
+
+// The compiler throws an error if the function is provided a first argument which is not an iterator protocol-compliant object...
+{
+	iterAcoversin( '5' ); // $ExpectError
+	iterAcoversin( 5 ); // $ExpectError
+	iterAcoversin( true ); // $ExpectError
+	iterAcoversin( false ); // $ExpectError
+	iterAcoversin( null ); // $ExpectError
+	iterAcoversin( undefined ); // $ExpectError
+	iterAcoversin( [] ); // $ExpectError
+	iterAcoversin( {} ); // $ExpectError
+	iterAcoversin( ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided insufficient arguments...
+{
+	iterAcoversin(); // $ExpectError
+}