@stdlib/math-iter-special-asinh

Create an iterator which computes the hyperbolic arcsine of each iterated value.

Usage no npm install needed!

<script type="module">
  import stdlibMathIterSpecialAsinh from 'https://cdn.skypack.dev/@stdlib/math-iter-special-asinh';
</script>

README

iterAsinh

NPM version Build Status Coverage Status

Create an iterator which iteratively computes the hyperbolic arcsine.

Installation

npm install @stdlib/math-iter-special-asinh

Usage

var iterAsinh = require( '@stdlib/math-iter-special-asinh' );

iterAsinh( iterator )

Returns an iterator which iteratively computes the hyperbolic arcsine.

var array2iterator = require( '@stdlib/array-to-iterator' );

var it = iterAsinh( array2iterator( [ 0.0, 2.0, -2.0 ] ) );
// returns <Object>

var r = it.next().value;
// returns 0.0

r = it.next().value;
// returns ~1.444

r = it.next().value;
// returns ~-1.444

// ...

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 a done property having a boolean 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

  • If an iterated value is non-numeric (including NaN), the returned iterator returns NaN. If non-numeric iterated values are possible, you are advised to provide an iterator 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 iterAsinh = require( '@stdlib/math-iter-special-asinh' );

// Create a seeded iterator for generating pseudorandom numbers:
var rand = uniform( -2.0, 2.0, {
    'seed': 1234,
    'iter': 10
});

// Create an iterator which consumes the pseudorandom number iterator:
var it = iterAsinh( rand );

// Perform manual iteration...
var r;
while ( true ) {
    r = it.next();
    if ( r.done ) {
        break;
    }
    console.log( r.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

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2022. The Stdlib Authors.