time-to-botec

main.js (2452B)

---

 /**
 * @license Apache-2.0
 *
 * Copyright (c) 2020 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
 'use strict';
 
 // MODULES //
 
 var iterMap2 = require( './../../../../iter/tools/map2' );
 var atan2 = require( './../../../../base/special/atan2' );
 
 
 // MAIN //
 
 /**
 * 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)`.
 *
 * ## Notes
 *
 * -   If provided a numeric value as an iterator argument, the value is broadcast as an **infinite** iterator which **always** returns the provided value.
 * -   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.
 * -   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 all provided iterators are iterable, the returned iterator is iterable.
 *
 * @param {(Iterator|number)} y - input iterator
 * @param {(Iterator|number)} x - input iterator
 * @throws {TypeError} first argument must be either an iterator protocol-compliant object or a number
 * @throws {TypeError} second argument must be either an iterator protocol-compliant object or a number
 * @returns {Iterator} iterator
 *
 * @example
 * var uniform = require( '@stdlib/random/iter/uniform' );
 *
 * var x = uniform( -2.0, 2.0 );
 * var y = uniform( -2.0, 2.0 );
 *
 * var iter = iterAtan2( y, x );
 *
 * var r = iter.next().value;
 * // returns <number>
 *
 * r = iter.next().value;
 * // returns <number>
 *
 * r = iter.next().value;
 * // returns <number>
 *
 * // ...
 */
 function iterAtan2( y, x ) {
 	return iterMap2( y, x, atan2 );
 }
 
 
 // EXPORTS //
 
 module.exports = iterAtan2;