iterBeta
Create an iterator which iteratively evaluates the beta function.
Usage
var iterBeta = require( '@stdlib/math/iter/special/beta' );
iterBeta( x, y )
Returns an iterator which iteratively evaluates the beta function.
var array2iterator = require( '@stdlib/array/to-iterator' );
var x = array2iterator( [ 1.0, 5.0, 4.0 ] );
var y = array2iterator( [ 1.0, 0.2, 1.0 ] );
var it = iterBeta( x, y );
// returns <Object>
var r = it.next().value;
// returns 1.0
r = it.next().value;
// returns ~3.382
r = it.next().value;
// returns 0.25
// ...
The returned iterator protocol-compliant object has the following properties:
- next: function which returns an iterator protocol-compliant object containing the next iterated value (if one exists) assigned to a
valueproperty and adoneproperty having abooleanvalue indicating whether the iterator is finished. - return: function which closes an iterator and returns a single (optional) argument in an iterator protocol-compliant object.
If provided a numeric value as an iterator argument, the value is broadcast as an infinite iterator which always returns the provided value.
var array2iterator = require( '@stdlib/array/to-iterator' );
var x = array2iterator( [ 1.0, 5.0 ] );
var it = iterBeta( x, 2.0 );
// returns <Object>
var v = it.next().value;
// returns 0.5
v = it.next().value;
// returns ~0.0333
var bool = it.next().done;
// returns true
Notes
- If an iterated value is non-numeric (including
NaN), the returned iterator returnsNaN. If non-numeric iterated values are possible, you are advised to provide aniteratorwhich 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.iteratorand a provided iterator is iterable, the returned iterator is iterable.
Examples
var uniform = require( '@stdlib/random/iter/uniform' );
var iterBeta = require( '@stdlib/math/iter/special/beta' );
// Create seeded iterators for generating pseudorandom numbers:
var x = uniform( 0.0, 2.0, {
'seed': 1234,
'iter': 10
});
var y = uniform( 0.0, 2.0, {
'seed': 4567,
'iter': 10
});
// Create an iterator which consumes the pseudorandom number iterators:
var it = iterBeta( x, y );
// Perform manual iteration...
var r;
while ( true ) {
r = it.next();
if ( r.done ) {
break;
}
console.log( r.value );
}