@stdlib/math-iter-special-trunc10
v0.2.2
Published
Create an iterator which rounds each iterated value to the nearest power of 10 toward zero.
Downloads
41
Readme
iterTrunc10
Create an iterator which rounds each iterated value to the nearest power of 10 toward zero.
Installation
npm install @stdlib/math-iter-special-trunc10
Usage
var iterTrunc10 = require( '@stdlib/math-iter-special-trunc10' );
iterTrunc10( iterator )
Returns an iterator which rounds each iterated value to the nearest power of 10
toward zero.
var array2iterator = require( '@stdlib/array-to-iterator' );
var it = iterTrunc10( array2iterator( [ 9.5, 13.0, -13.0 ] ) );
// returns <Object>
var r = it.next().value;
// returns 1.0
r = it.next().value;
// returns 10.0
r = it.next().value;
// returns -10.0
// ...
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
value
property and adone
property having aboolean
value indicating whether the iterator is finished. - return: function which closes an iterator and returns a single (optional) argument in an iterator protocol-compliant object.
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 aniterator
which type checks and handles non-numeric values accordingly. - If an environment supports
Symbol.iterator
and a provided iterator is iterable, the returned iterator is iterable.
Examples
var uniform = require( '@stdlib/random-iter-uniform' );
var iterTrunc10 = require( '@stdlib/math-iter-special-trunc10' );
// Create a seeded iterator for generating pseudorandom numbers:
var rand = uniform( -200.0, 200.0, {
'seed': 1234,
'iter': 10
});
// Create an iterator which consumes the pseudorandom number iterator:
var it = iterTrunc10( rand );
// Perform manual iteration...
var r;
while ( true ) {
r = it.next();
if ( r.done ) {
break;
}
console.log( r.value );
}
See Also
@stdlib/math-base/special/trunc10
: round a numeric value to the nearest power of 10 toward zero.@stdlib/math-iter/special/ceil10
: create an iterator which rounds each iterated value to the nearest power of 10 toward positive infinity.@stdlib/math-iter/special/floor10
: create an iterator which rounds each iterated value to the nearest power of 10 toward negative infinity.@stdlib/math-iter/special/round10
: create an iterator which rounds each iterated value to the nearest power of 10 on a linear scale.@stdlib/math-iter/special/trunc
: create an iterator which rounds each iterated value toward zero.
Notice
This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.