time-to-botec/js/node_modules/@stdlib/math/iter/special/atanh/README.md

iterAtanh

Create an iterator which iteratively computes the hyperbolic arctangent.

Usage

var iterAtanh = require( '@stdlib/math/iter/special/atanh' );

iterAtanh( iterator )

Returns an iterator which iteratively computes the hyperbolic arctangent.

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

var it = iterAtanh( array2iterator( [ 0.0, 0.5, 0.9 ] ) );
// returns <Object>

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

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

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

// ...

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

• The domain of hyperbolic arctangent is restricted to [-1,1]. If an iterated value is outside of the domain, the returned iterator returns NaN.
• 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 iterAtanh = require( '@stdlib/math/iter/special/atanh' );

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

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

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