Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "math/iter/special/erfinv/docs/types/index.d"

Index

Type aliases

Functions

Type aliases

Iterator

Iterator: Iter | IterableIterator

Functions

Export assignment iterErfinv

  • Returns an iterator which iteratively evaluates the inverse error function.

    Notes

    • The domain of inverse error function is restricted to [-1,1]. If an iterated value is outside of the domain, the returned iterator returns NaN.
    • If an environment supports Symbol.iterator and a provided iterator is iterable, the returned iterator is iterable.

    Parameters

    Returns Iterator

    iterator

    Example

    var uniform = require( `@stdlib/random/iter/uniform` );
    
    var iter = iterErfinv( uniform( -1.0, 1.0 ) );
    
    var r = iter.next().value;
    // returns <number>
    
    r = iter.next().value;
    // returns <number>
    
    r = iter.next().value;
    // returns <number>
    
    // ...