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

Export assignment iterAvercos

• iterAvercos(iterator: Iterator): Iterator

• Returns an iterator which iteratively computes the inverse versed cosine.

  Notes

  • The domain of inverse versed cosine is restricted to [-2,0]. 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

  • iterator: Iterator

    input iterator

  Returns Iterator

  iterator

  Example

  var uniform = require( '@stdlib/random/iter/uniform' );
  
  var iter = iterAvercos( uniform( -2.0, 0.0 ) );
  
  var r = iter.next().value;
  // returns <number>
  
  r = iter.next().value;
  // returns <number>
  
  r = iter.next().value;
  // returns <number>
  
  // ...