time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

repl.txt (1390B)


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