Create an iterator which iteratively evaluates the natural logarithm.
var iterLn = require( '@stdlib/math/iter/special/ln' );Returns an iterator which iteratively evaluates the natural logarithm.
var array2iterator = require( '@stdlib/array/to-iterator' );
var it = iterLn( array2iterator( [ 4.0, 0.0 ] ) );
// returns <Object>
var r = it.next().value;
// returns ~1.386
r = it.next().value;
// returns -Infinity
// ...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 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. - If an environment supports
Symbol.iteratorand a provided iterator is iterable, the returned iterator is iterable.
var uniform = require( '@stdlib/random/iter/uniform' );
var iterLn = require( '@stdlib/math/iter/special/ln' );
// Create a seeded iterator for generating pseudorandom numbers:
var rand = uniform( 0.0, 100.0, {
'seed': 1234,
'iter': 10
});
// Create an iterator which consumes the pseudorandom number iterator:
var it = iterLn( rand );
// Perform manual iteration...
var r;
while ( true ) {
r = it.next();
if ( r.done ) {
break;
}
console.log( r.value );
}@stdlib/math/base/special/ln: evaluate the natural logarithm of a double-precision floating-point number.@stdlib/math/iter/special/exp: create an iterator which evaluates the natural exponential function for each iterated value.@stdlib/math/iter/special/log10: create an iterator which evaluates the common logarithm (logarithm with base 10) for each iterated value.@stdlib/math/iter/special/log1p: create an iterator which evaluates the natural logarithm of 1+x for each iterated value.@stdlib/math/iter/special/log2: create an iterator which evaluates the binary logarithm for each iterated value.