repl.txt (1329B)
1 2 {{alias}}( iterator, fcn[, options] ) 3 Returns an iterator which invokes a unary function accepting a single 4 numeric argument for each iterated value. 5 6 When invoked, the input function is provided one argument: 7 8 - value: iterated value 9 10 If an environment supports Symbol.iterator and a provided iterator is 11 iterable, the returned iterator is iterable. 12 13 Parameters 14 ---------- 15 iterator: Object 16 Input iterator. 17 18 fcn: Function 19 Function to invoke for each iterated value. 20 21 options: Object (optional) 22 Options. 23 24 options.invalid: any (optional) 25 Return value when an input iterator yields a non-numeric value. Default: 26 NaN. 27 28 Returns 29 ------- 30 iterator: Object 31 Iterator. 32 33 iterator.next(): Function 34 Returns an iterator protocol-compliant object containing the next 35 iterated value (if one exists) and a boolean flag indicating whether the 36 iterator is finished. 37 38 iterator.return( [value] ): Function 39 Finishes an iterator and returns a provided value. 40 41 Examples 42 -------- 43 > var it = {{alias}}( {{alias:@stdlib/random/iter/randu}}(), {{alias:@stdlib/math/base/special/sin}} ); 44 > var r = it.next().value 45 <number> 46 > r = it.next().value 47 <number> 48 49 See Also 50 -------- 51