External module "stats/incr/msummary/docs/types/index.d"

Export assignment incrmsummary

• incrmsummary(W: number): accumulator

• Returns an accumulator function which incrementally computes a moving statistical summary.

  Notes

  • The W parameter defines the number of values over which to compute the moving statistical summary.
  • If provided a value, the accumulator function returns an updated moving statistical summary. If not provided a value, the accumulator function returns the current moving statistical summary.
  • As W values are needed to fill the window buffer, the first W-1 returned summaries are calculated from smaller sample sizes. Until the window is full, each returned summary is calculated from all provided values.

  throws

  must provide a positive integer

  Parameters

  • W: number

    window size

  Returns accumulator

  accumulator function

  Example

  var accumulator = incrmsummary( 3 );
  
  var summary = accumulator();
  // returns {}
  
  summary = accumulator( 2.0 );
  // returns {...}
  
  summary = accumulator( -5.0 );
  // returns {...}
  
  summary = accumulator();
  // returns {...}