time-to-botec/squiggle/node_modules/@stdlib/math/iter/special/cos/README.md

iterCos

Create an iterator which iteratively computes the cosine.

Usage

var iterCos = require( '@stdlib/math/iter/special/cos' );

iterCos( iterator )

Returns an iterator which iteratively computes the cosine.

var array2iterator = require( '@stdlib/array/to-iterator' );

var src = [ 0.0, 3.141592653589793/4.0, -3.141592653589793/6.0 ];
var it = iterCos( array2iterator( src ) );
// returns <Object>

var r = it.next().value;
// returns ~1.0

r = it.next().value;
// returns ~0.707

r = it.next().value;
// returns ~0.866

// ...

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 a done property having a boolean 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

• If an iterated value is non-numeric (including NaN), the returned iterator returns NaN. If non-numeric iterated values are possible, you are advised to provide an iterator 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 iterCos = require( '@stdlib/math/iter/special/cos' );

// 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 = iterCos( rand );

// Perform manual iteration...
var r;
while ( true ) {
    r = it.next();
    if ( r.done ) {
        break;
    }
    console.log( r.value );
}