@stdlib/math-iter-special-avercos
v0.2.2
Published
Create an iterator which computes the inverse versed cosine of each iterated value.
Downloads
70
Readme
iterAvercos
Create an iterator which iteratively computes the inverse versed cosine.
Installation
npm install @stdlib/math-iter-special-avercos
Usage
var iterAvercos = require( '@stdlib/math-iter-special-avercos' );
iterAvercos( iterator )
Returns an iterator which iteratively computes the inverse versed cosine.
var array2iterator = require( '@stdlib/array-to-iterator' );
var x = [ 0.0, -3.141592653589793/2.0, -3.141592653589793/6.0 ];
var it = iterAvercos( array2iterator( x ) );
// returns <Object>
var r = it.next().value;
// returns 0.0
r = it.next().value;
// returns ~2.1783
r = it.next().value;
// returns ~1.0742
// ...
The returned iterator protocol-compliant object has the following properties:
- next: function which returns an iterator protocol-compliant object containing the next iterated value (if one exists) assigned to a
value
property and adone
property having aboolean
value indicating whether the iterator is finished. - return: function which closes an iterator and returns a single (optional) argument in an iterator protocol-compliant object.
Notes
- The domain of inverse versed cosine is restricted to
[-2,0]
. If an iterated value is outside of the domain, the returned iterator returnsNaN
. - If an iterated value is non-numeric (including
NaN
), the returned iterator returnsNaN
. If non-numeric iterated values are possible, you are advised to provide aniterator
which type checks and handles non-numeric values accordingly. - If an environment supports
Symbol.iterator
and a provided iterator is iterable, the returned iterator is iterable.
Examples
var uniform = require( '@stdlib/random-iter-uniform' );
var iterAvercos = require( '@stdlib/math-iter-special-avercos' );
// Create a seeded iterator for generating pseudorandom numbers:
var rand = uniform( -2.0, 0.0, {
'seed': 1234,
'iter': 10
});
// Create an iterator which consumes the pseudorandom number iterator:
var it = iterAvercos( rand );
// Perform manual iteration...
var r;
while ( true ) {
r = it.next();
if ( r.done ) {
break;
}
console.log( r.value );
}
See Also
@stdlib/math-base/special/avercos
: compute the inverse versed cosine.@stdlib/math-iter/special/aversin
: create an iterator which computes the inverse versed sine of each iterated value.@stdlib/math-iter/special/versin
: create an iterator which computes the versed sine for each iterated value.
Notice
This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.