time-to-botec

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

repl.txt (839B)


      1 
      2 {{alias}}()
      3     Returns an accumulator function which incrementally computes a geometric
      4     mean.
      5 
      6     If provided a value, the accumulator function returns an updated geometric
      7     mean. If not provided a value, the accumulator function returns the current
      8     geometric mean.
      9 
     10     If provided `NaN` or a value which, when used in computations, results in
     11     `NaN`, the accumulated value is `NaN` for all future invocations.
     12 
     13     If provided a negative value, the accumulated value is `NaN` for all future
     14     invocations.
     15 
     16     Returns
     17     -------
     18     acc: Function
     19         Accumulator function.
     20 
     21     Examples
     22     --------
     23     > var accumulator = {{alias}}();
     24     > var v = accumulator()
     25     null
     26     > v = accumulator( 2.0 )
     27     2.0
     28     > v = accumulator( 5.0 )
     29     ~3.16
     30     > v = accumulator()
     31     ~3.16
     32 
     33     See Also
     34     --------
     35