1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
|
{{alias}}( iter0, iter1, fcn[, options] )
Returns an iterator which invokes a binary function accepting numeric
arguments for each iterated value.
When invoked, the input function is provided two arguments:
- x: iterated value from first input iterator
- y: iterated value from second input iterator
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 provided a numeric value as an iterator argument, the value is broadcast
as an infinite iterator which always returns the provided value.
If an environment supports Symbol.iterator and provided iterators are
iterable, the returned iterator is iterable.
Parameters
----------
iter0: Object
First input iterator.
iter1: Object
Second input iterator.
fcn: Function
Function to invoke for each iterated value.
options: Object (optional)
Options.
options.invalid: any (optional)
Return value when an input iterator yields a non-numeric value. Default:
NaN.
Returns
-------
iterator: Object
Iterator.
iterator.next(): Function
Returns an iterator protocol-compliant object containing the next
iterated value (if one exists) and a boolean flag indicating whether the
iterator is finished.
iterator.return( [value] ): Function
Finishes an iterator and returns a provided value.
Examples
--------
> var it0 = {{alias:@stdlib/random/iter/randu}}();
> var it1 = {{alias:@stdlib/random/iter/randu}}();
> var it = {{alias}}( it0, it1, {{alias:@stdlib/math/base/special/copysign}} );
> var r = it.next().value
<number>
> r = it.next().value
<number>
See Also
--------
|
