About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, wellwritten, studied, documented, tested, measured, and highquality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
Create an iterator which iteratively computes the hyperbolic arctangent.
npm install @stdlib/mathiterspecialatanh
var iterAtanh = require( '@stdlib/mathiterspecialatanh' );
Returns an iterator which iteratively computes the hyperbolic arctangent.
var array2iterator = require( '@stdlib/arraytoiterator' );
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 protocolcompliant object has the following properties:

next: function which returns an iterator protocolcompliant 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 protocolcompliant object.
 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 nonnumeric (including
NaN
), the returned iterator returnsNaN
. If nonnumeric iterated values are possible, you are advised to provide aniterator
which type checks and handles nonnumeric values accordingly.  If an environment supports
Symbol.iterator
and a provided iterator is iterable, the returned iterator is iterable.
var uniform = require( '@stdlib/randomiteruniform' );
var iterAtanh = require( '@stdlib/mathiterspecialatanh' );
// 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 );
}

@stdlib/mathbase/special/atanh
: compute the hyperbolic arctangent of a doubleprecision floatingpoint number. 
@stdlib/mathiter/special/acosh
: create an iterator which computes the hyperbolic arccosine of each iterated value. 
@stdlib/mathiter/special/asinh
: create an iterator which computes the hyperbolic arcsine of each iterated value. 
@stdlib/mathiter/special/atan
: create an iterator which computes the arctangent of each iterated value.
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.
See LICENSE.
Copyright © 20162024. The Stdlib Authors.