# iterAtanh
> Create an [iterator][mdn-iterator-protocol] which iteratively computes the [hyperbolic arctangent][@stdlib/math/base/special/atanh].
## Usage
```javascript
var iterAtanh = require( '@stdlib/math/iter/special/atanh' );
```
#### iterAtanh( iterator )
Returns an [iterator][mdn-iterator-protocol] which iteratively computes the [hyperbolic arctangent][@stdlib/math/base/special/atanh].
```javascript
var array2iterator = require( '@stdlib/array/to-iterator' );
var it = iterAtanh( array2iterator( [ 0.0, 0.5, 0.9 ] ) );
// returns
## Notes
- The domain of hyperbolic arctangent is restricted to `[-1,1]`. If an iterated value is outside of the domain, the returned [iterator][mdn-iterator-protocol] returns `NaN`.
- If an iterated value is non-numeric (including `NaN`), the returned [iterator][mdn-iterator-protocol] returns `NaN`. If non-numeric iterated values are possible, you are advised to provide an [`iterator`][mdn-iterator-protocol] which type checks and handles non-numeric values accordingly.
- If an environment supports `Symbol.iterator` **and** a provided [iterator][mdn-iterator-protocol] is iterable, the returned [iterator][mdn-iterator-protocol] is iterable.
## Examples
```javascript
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 );
}
```
[mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol
[@stdlib/math/base/special/atanh]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/special/atanh