time-to-botec

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

repl.txt (892B)


      1 
      2 {{alias}}( [mean] )
      3     Returns an accumulator function which incrementally computes a corrected
      4     sample standard deviation.
      5 
      6     If provided a value, the accumulator function returns an updated corrected
      7     sample standard deviation. If not provided a value, the accumulator function
      8     returns the current corrected sample standard deviation.
      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     Parameters
     14     ----------
     15     mean: number (optional)
     16         Known mean.
     17 
     18     Returns
     19     -------
     20     acc: Function
     21         Accumulator function.
     22 
     23     Examples
     24     --------
     25     > var accumulator = {{alias}}();
     26     > var s = accumulator()
     27     null
     28     > s = accumulator( 2.0 )
     29     0.0
     30     > s = accumulator( -5.0 )
     31     ~4.95
     32     > s = accumulator()
     33     ~4.95
     34 
     35     See Also
     36     --------
     37