time-to-botec

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

repl.txt (1090B)


      1 
      2 {{alias}}( W )
      3     Returns an accumulator function which incrementally computes a moving
      4     harmonic mean.
      5 
      6     The `W` parameter defines the number of values over which to compute the
      7     moving harmonic mean.
      8 
      9     If provided a value, the accumulator function returns an updated moving
     10     harmonic mean. If not provided a value, the accumulator function returns the
     11     current moving harmonic mean.
     12 
     13     As `W` values are needed to fill the window buffer, the first `W-1` returned
     14     values are calculated from smaller sample sizes. Until the window is full,
     15     each returned value is calculated from all provided values.
     16 
     17     Parameters
     18     ----------
     19     W: integer
     20         Window size.
     21 
     22     Returns
     23     -------
     24     acc: Function
     25         Accumulator function.
     26 
     27     Examples
     28     --------
     29     > var accumulator = {{alias}}( 3 );
     30     > var v = accumulator()
     31     null
     32     > v = accumulator( 2.0 )
     33     2.0
     34     > v = accumulator( 5.0 )
     35     ~2.86
     36     > v = accumulator( 3.0 )
     37     ~2.90
     38     > v = accumulator( 5.0 )
     39     ~4.09
     40     > v = accumulator()
     41     ~4.09
     42 
     43     See Also
     44     --------
     45