|
||
---|---|---|
.. | ||
docs | ||
lib | ||
package.json | ||
README.md |
iterCospi
Create an iterator which computes the cosine of each iterated value times π.
Usage
var iterCospi = require( '@stdlib/math/iter/special/cospi' );
iterCospi( iterator )
Returns an iterator which computes the cosine of each iterated value times π.
var array2iterator = require( '@stdlib/array/to-iterator' );
var src = [ 0.0, 0.5, 0.1 ];
var it = iterCospi( array2iterator( src ) );
// returns <Object>
var r = it.next().value;
// returns 1.0
r = it.next().value;
// returns 0.0
r = it.next().value;
// returns ~0.951
// ...
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
- Computes
cos(πx)
more accurately thancos(pi*x)
, especially for largex
. - 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 randu = require( '@stdlib/random/iter/randu' );
var iterCospi = require( '@stdlib/math/iter/special/cospi' );
// Create a seeded iterator for generating pseudorandom numbers:
var rand = randu({
'seed': 1234,
'iter': 10
});
// Create an iterator which consumes the pseudorandom number iterator:
var it = iterCospi( rand );
// Perform manual iteration...
var r;
while ( true ) {
r = it.next();
if ( r.done ) {
break;
}
console.log( r.value );
}