File: repl.txt

package info (click to toggle)
node-stdlib 0.0.96%2Bds1%2B~cs0.0.429-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 421,476 kB
  • sloc: javascript: 1,562,831; ansic: 109,702; lisp: 49,823; cpp: 27,224; python: 7,871; sh: 6,807; makefile: 6,089; fortran: 3,102; awk: 387
file content (48 lines) | stat: -rw-r--r-- 1,361 bytes parent folder | download
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

{{alias}}( x, y )
    Returns an iterator which iteratively evaluates the beta function.

    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
    ----------
    x: Object|number
        Input iterator.

    y: Object|number
        Input iterator.

    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 x = {{alias:@stdlib/random/iter/uniform}}( 0.0, 2.0 );
    > var y = {{alias:@stdlib/random/iter/uniform}}( 0.0, 2.0 );
    > var it = {{alias}}( x, y );
    > var r = it.next().value
    <number>
    > r = it.next().value
    <number>

    See Also
    --------