@stdlib/math-iter-special-sqrt

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, 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!

iterSqrt

Create an iterator which iteratively computes the principal square root.

Installation

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

Usage

var iterSqrt = require( '@stdlib/math-iter-special-sqrt' );

iterSqrt( iterator )

Returns an iterator which iteratively computes the principal square root.

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

var it = iterSqrt( array2iterator( [ 1, 4, 9 ] ) );
// returns <Object>

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

r = it.next().value;
// returns 2

r = it.next().value;
// returns 3

// ...

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 iterSqrt = require( '@stdlib/math-iter-special-sqrt' );

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

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

// Perform manual iteration...
var r;
while ( true ) {
    r = it.next();
    if ( r.done ) {
        break;
    }
    console.log( r.value );
}

---

See Also

• @stdlib/math-base/special/sqrt: compute the principal square root of a double-precision floating-point number.
• @stdlib/math-iter/special/cbrt: create an iterator which computes the cube root of each iterated value.
• @stdlib/math-iter/special/rsqrt: create an iterator which computes the reciprocal (inverse) square root of each iterated 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

---

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.