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

Export assignment itercumax

• itercumax(iterator: Iterator): Iterator

• Returns an iterator which iteratively computes a cumulative maximum value.

  Notes

  • If an environment supports Symbol.iterator, the returned iterator is iterable.

  Parameters

  • iterator: Iterator

    input iterator

  Returns Iterator

  iterator

  Example

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