@stdlib/math-iter-special-atanh
v0.2.2
Published
Create an iterator which computes the hyperbolic arctangent of each iterated value.
Downloads
50
Readme
iterAtanh
Create an iterator which iteratively computes the hyperbolic arctangent.
Installation
npm install @stdlib/math-iter-special-atanh
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 adone
property having aboolean
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 returnsNaN
. - If an iterated value is non-numeric (including
NaN
), the returned iterator returnsNaN
. If non-numeric iterated values are possible, you are advised to provide aniterator
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 );
}
See Also
@stdlib/math-base/special/atanh
: compute the hyperbolic arctangent of a double-precision floating-point number.@stdlib/math-iter/special/acosh
: create an iterator which computes the hyperbolic arccosine 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/atan
: create an iterator which computes the 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.