@stdlib/math-iter-special-signum NPM

iterSignum

$NPM version$ $Build Status$ $Coverage Status$

Create an iterator which iteratively evaluates the signum function.

Installation

npm install @stdlib/math-iter-special-signum

Usage

var iterSignum = require( '@stdlib/math-iter-special-signum' );

iterSignum( iterator )

Returns an iterator which iteratively evaluates the signum function.

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

var it = iterSignum( array2iterator( [ 4.0, -1.5, 0.0, -0.0 ] ) );
// returns <Object>

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

r = it.next().value;
// returns -1

r = it.next().value;
// returns 0

r = it.next().value;
// returns -0

// ...

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 uniform = require( '@stdlib/random-iter-uniform' );
var iterSignum = require( '@stdlib/math-iter-special-signum' );

// Create a seeded iterator for generating pseudorandom numbers:
var rand = uniform( -2.0, 2.0, {
    'seed': 1234,
    'iter': 10
});

// Create an iterator which consumes the pseudorandom number iterator:
var it = iterSignum( rand );

// Perform manual iteration...
var r;
while ( true ) {
    r = it.next();
    if ( r.done ) {
        break;
    }
    console.log( r.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.