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 evaluates the hyperbolic tangent for each iterated value.
npm install @stdlib/mathiterspecialtanh
var iterTanh = require( '@stdlib/mathiterspecialtanh' );
Returns an iterator which iteratively evaluates the hyperbolic tangent.
var array2iterator = require( '@stdlib/arraytoiterator' );
var it = iterTanh( array2iterator( [ 0.0, 2.0 ] ) );
// returns <Object>
var v = it.next().value;
// returns 0.0
v = it.next().value;
// returns ~0.964
// ...
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.
 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 iterTanh = require( '@stdlib/mathiterspecialtanh' );
// Create a seeded iterator for generating pseudorandom numbers:
var rand = uniform( 4.0, 4.0, {
'seed': 1234,
'iter': 10
});
// Create an iterator which consumes the pseudorandom number iterator:
var it = iterTanh( rand );
// Perform manual iteration...
var v;
while ( true ) {
v = it.next();
if ( v.done ) {
break;
}
console.log( v.value );
}

@stdlib/mathbase/special/tanh
: compute the hyperbolic tangent of a doubleprecision floatingpoint number. 
@stdlib/mathiter/special/cosh
: create an iterator which computes the hyperbolic cosine for each iterated value. 
@stdlib/mathiter/special/sinh
: create an iterator which evaluates the hyperbolic sine for each iterated value. 
@stdlib/mathiter/special/tan
: create an iterator which evaluates the tangent for 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.