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

Export assignment iterBeta

• iterBeta(y: Iterator | number, x: Iterator | number): Iterator

• Returns an iterator which iteratively evaluates the beta function.

  Notes

  • If provided a numeric value as an iterator argument, the value is broadcast as an infinite iterator which always returns the provided value.
  • If an iterated value is non-numeric (including NaN), the returned iterator returns NaN. If non-numeric iterated values are possible, you are advised to provide an iterator which type checks and handles non-numeric values accordingly.
  • The length of the returned iterator is equal to the length of the shortest provided iterator. In other words, the returned iterator ends once one of the provided iterators ends.
  • If an environment supports Symbol.iterator and all provided iterators are iterable, the returned iterator is iterable.

  Parameters

  • y: Iterator | number

    input iterator

  • x: Iterator | number

    input iterator

  Returns Iterator

  iterator

  Example

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