Skip to content

acoth

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

acoth

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
benchmark
benchmark
 
 
docs
docs
 
 
examples
examples
 
 
lib
lib
 
 
test
test
 
 
README.md
README.md
 
 
package.json
package.json
 
 

README.md

iterAcoth

Create an iterator which iteratively computes the inverse hyperbolic cotangent.

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