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!
iterAtan2
Create an iterator which iteratively computes the angle in the plane (in radians) between the positive x-axis and the ray from
(0,0)
to the point(x,y)
.
Installation
npm install @stdlib/math-iter-special-atan2
Usage
var iterAtan2 = require( '@stdlib/math-iter-special-atan2' );
iterAtan2( y, x )
Returns an iterator which iteratively computes the angle in the plane (in radians) between the positive x-axis and the ray from (0,0)
to the point (x,y)
.
var array2iterator = require( '@stdlib/array-to-iterator' );
var x = array2iterator( [ 2.0, 2.0, -1.0 ] );
var y = array2iterator( [ 2.0, 6.0, -1.0 ] );
var it = iterAtan2( y, x );
// returns <Object>
var r = it.next().value;
// returns ~0.785
r = it.next().value;
// returns ~1.249
r = it.next().value;
// returns ~-2.356
// ...
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 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 protocol-compliant object.
If provided a numeric value as an iterator
argument, the value is broadcast as an infinite iterator which always returns the provided value.
var array2iterator = require( '@stdlib/array-to-iterator' );
var y = array2iterator( [ 2.0, 6.0 ] );
var it = iterAtan2( y, 2.0 );
// returns <Object>
var v = it.next().value;
// returns ~0.785
v = it.next().value;
// returns ~1.249
var bool = it.next().done;
// returns true
Notes
- If an iterated value is non-numeric (including
NaN
), the returned iterator returnsNaN
. If non-numeric iterated values are possible, you are advised to provide aniterator
which type checks and handles non-numeric values accordingly. - The length of the returned iterator is equal to the length of the shortest provided iterator. In other words, the returned iterator ends once one of the provided iterators ends.
- 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 iterAtan2 = require( '@stdlib/math-iter-special-atan2' );
// Create seeded iterators for generating pseudorandom numbers:
var x = uniform( -2.0, 2.0, {
'seed': 1234,
'iter': 10
});
var y = uniform( -2.0, 2.0, {
'seed': 4567,
'iter': 10
});
// Create an iterator which consumes the pseudorandom number iterators:
var it = iterAtan2( y, x );
// Perform manual iteration...
var r;
while ( true ) {
r = it.next();
if ( r.done ) {
break;
}
console.log( r.value );
}
See Also
-
@stdlib/math-base/special/atan2
: compute the angle in the plane (in radians) between the positive x-axis and the ray from (0,0) to the point (x,y). -
@stdlib/math-iter/special/atan
: create an iterator which computes the arctangent 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.