Create an iterator which evaluates the hyperbolic tangent for each iterated value.
npm install @stdlib/math-iter-special-tanhWe 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, well-written, studied, documented, tested, measured, and high-quality 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!
About stdlib...
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Create an [iterator][mdn-iterator-protocol] which evaluates the [hyperbolic tangent][@stdlib/math/base/special/tanh] for each iterated value.
``bash`
npm install @stdlib/math-iter-special-tanh
`javascript`
var iterTanh = require( '@stdlib/math-iter-special-tanh' );
#### iterTanh( iterator )
Returns an [iterator][mdn-iterator-protocol] which iteratively evaluates the [hyperbolic tangent][@stdlib/math/base/special/tanh].
`javascript
var array2iterator = require( '@stdlib/array-to-iterator' );
var it = iterTanh( array2iterator( [ 0.0, 2.0 ] ) );
// returns
var v = it.next().value;
// returns 0.0
v = it.next().value;
// returns ~0.964
// ...
`
The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the following properties:
- next: function which returns an [iterator][mdn-iterator-protocol] 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][mdn-iterator-protocol] and returns a single (optional) argument in an [iterator][mdn-iterator-protocol] protocol-compliant object.
- 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.Symbol.iterator
- If an environment supports and a provided [iterator][mdn-iterator-protocol] is iterable, the returned [iterator][mdn-iterator-protocol] is iterable.
`javascript
var uniform = require( '@stdlib/random-iter-uniform' );
var iterTanh = require( '@stdlib/math-iter-special-tanh' );
// 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/math-base/special/tanh][@stdlib/math/base/special/tanh]: compute the hyperbolic tangent of a double-precision floating-point number.
- [@stdlib/math-iter/special/cosh][@stdlib/math/iter/special/cosh]: create an iterator which computes the hyperbolic cosine for each iterated value.
- [@stdlib/math-iter/special/sinh][@stdlib/math/iter/special/sinh]: create an iterator which evaluates the hyperbolic sine for each iterated value.
- [@stdlib/math-iter/special/tan][@stdlib/math/iter/special/tan]: create an iterator which evaluates the tangent for each iterated value.
*
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
See [LICENSE][stdlib-license].
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/math-iter-special-tanh.svg
[npm-url]: https://npmjs.org/package/@stdlib/math-iter-special-tanh
[test-image]: https://github.com/stdlib-js/math-iter-special-tanh/actions/workflows/test.yml/badge.svg?branch=v0.2.3
[test-url]: https://github.com/stdlib-js/math-iter-special-tanh/actions/workflows/test.yml?query=branch:v0.2.3
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-iter-special-tanh/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/math-iter-special-tanh?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/math-iter-special-tanh/tree/deno
[deno-readme]: https://github.com/stdlib-js/math-iter-special-tanh/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/math-iter-special-tanh/tree/umd
[umd-readme]: https://github.com/stdlib-js/math-iter-special-tanh/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/math-iter-special-tanh/tree/esm
[esm-readme]: https://github.com/stdlib-js/math-iter-special-tanh/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/math-iter-special-tanh/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-iter-special-tanh/main/LICENSE
[mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol
[@stdlib/math/base/special/tanh]: https://www.npmjs.com/package/@stdlib/math-base-special-tanh
[@stdlib/math/iter/special/cosh]: https://www.npmjs.com/package/@stdlib/math-iter-special-cosh
[@stdlib/math/iter/special/sinh]: https://www.npmjs.com/package/@stdlib/math-iter-special-sinh
[@stdlib/math/iter/special/tan]: https://www.npmjs.com/package/@stdlib/math-iter-special-tan