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