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