External module "stats/iter/mmin/docs/types/index.d"

Export assignment itermmin

• itermmin(iterator: Iterator, W: number): Iterator

• Returns an iterator which iteratively computes a moving minimum value.

  Notes

  • The W parameter defines the number of iterated values over which to compute the moving minimum value.
  • As W values are needed to fill the window buffer, the first W-1 returned values are calculated from smaller sample sizes. Until the window is full, each returned value is calculated from all previously iterated values.
  • If an environment supports Symbol.iterator, the returned iterator is iterable.

  throws

  second argument must be a positive integer

  Parameters

  • iterator: Iterator

    input iterator

  • W: number

    window size

  Returns Iterator

  iterator

  Example

  var runif = require( `@stdlib/random/iter/uniform` );
  
  var rand = runif( -10.0, 10.0, {
      'iter': 100
  });
  
  var it = itermmin( rand, 3 );
  
  var v = it.next().value;
  // returns <number>
  
  v = it.next().value;
  // returns <number>
  
  v = it.next().value;
  // returns <number>
  
  // ...