repl.txt (1458B)
1 2 {{alias}}( y, x ) 3 Returns an iterator which iteratively computes the angle in the plane (in 4 radians) between the positive x-axis and the ray from (0,0) to the point 5 (x,y). 6 7 The length of the returned iterator is equal to the length of the shortest 8 provided iterator. In other words, the returned iterator ends once *one* of 9 the provided iterators ends. 10 11 If provided a numeric value as an iterator argument, the value is broadcast 12 as an infinite iterator which always returns the provided value. 13 14 If an environment supports Symbol.iterator and provided iterators are 15 iterable, the returned iterator is iterable. 16 17 Parameters 18 ---------- 19 y: Object|number 20 Input iterator. 21 22 x: Object|number 23 Input iterator. 24 25 Returns 26 ------- 27 iterator: Object 28 Iterator. 29 30 iterator.next(): Function 31 Returns an iterator protocol-compliant object containing the next 32 iterated value (if one exists) and a boolean flag indicating whether the 33 iterator is finished. 34 35 iterator.return( [value] ): Function 36 Finishes an iterator and returns a provided value. 37 38 Examples 39 -------- 40 > var x = {{alias:@stdlib/random/iter/uniform}}( -2.0, 2.0 ); 41 > var y = {{alias:@stdlib/random/iter/uniform}}( -2.0, 2.0 ); 42 > var it = {{alias}}( y, x ); 43 > var r = it.next().value 44 <number> 45 > r = it.next().value 46 <number> 47 48 See Also 49 -------- 50