Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Type aliases

Functions

Type aliases

Iterator

Iterator: Iter | IterableIterator

Functions

Export assignment itercugmean

  • Returns an iterator which iteratively computes a cumulative arithmetic geometric mean.

    Notes

    • If provided a negative value, the iterated value is NaN for all future invocations.
    • If an environment supports Symbol.iterator, the returned iterator is iterable.

    Parameters

    Returns Iterator

    iterator

    Example

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