iterAcoth

Create an iterator which iteratively computes the inverse hyperbolic cotangent.

Installation

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

Usage

var iterAcoth = require( '@stdlib/math-iter-special-acoth' );

iterAcoth( iterator )

Returns an iterator which iteratively computes the inverse hyperbolic cotangent.

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

var it = iterAcoth( array2iterator( [ 2.0, 1.0 ] ) );
// returns <Object>

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

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

// ...

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 inverse hyperbolic cotangent is restricted to (-inf,-1] and [1,inf). 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 iterAcoth = require( '@stdlib/math-iter-special-acoth' );

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

// Create an iterator which consumes the pseudorandom number iterator:
var it = iterAcoth( 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/acoth: compute the inverse hyperbolic cotangent.
• @stdlib/math-iter/special/acosh: create an iterator which computes the hyperbolic arccosine of each iterated value.
• @stdlib/math-iter/special/acot: create an iterator which computes the inverse cotangent of each iterated value.
• @stdlib/math-iter/special/asinh: create an iterator which computes the hyperbolic arcsine of each iterated value.
• @stdlib/math-iter/special/atanh: create an iterator which computes the hyperbolic arctangent of 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.