@stdlib/math-iter-sequences-fourth-powers
v0.2.2
Published
Create an iterator which generates a sequence of fourth powers.
Downloads
38
Readme
iterFourthPowersSeq
Create an iterator which generates a sequence of fourth powers.
Installation
npm install @stdlib/math-iter-sequences-fourth-powers
Usage
var iterFourthPowersSeq = require( '@stdlib/math-iter-sequences-fourth-powers' );
iterFourthPowersSeq( [options] )
Returns an iterator which generates a sequence of fourth powers.
var it = iterFourthPowersSeq();
// returns <Object>
var v = it.next().value;
// returns 0
v = it.next().value;
// returns 1
v = it.next().value;
// returns 16
v = it.next().value;
// returns 81
v = it.next().value;
// returns 256
// ...
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.
The function supports the following options
:
- iter: number of iterations. Default:
9741
.
By default, the function returns a finite iterator to avoid exceeding the maximum safe double-precision floating-point integer. To adjust the number of iterations, set the iter
option.
var opts = {
'iter': 2
};
var it = iterFourthPowersSeq( opts );
// returns <Object>
var v = it.next().value;
// returns 0
v = it.next().value;
// returns 1
var bool = it.next().done;
// returns true
Notes
- If an environment supports
Symbol.iterator
, the returned iterator is iterable.
Examples
var iterFourthPowersSeq = require( '@stdlib/math-iter-sequences-fourth-powers' );
// Create an iterator:
var opts = {
'iter': 100
};
var it = iterFourthPowersSeq( opts );
// Perform manual iteration...
var v;
while ( true ) {
v = it.next();
if ( v.done ) {
break;
}
console.log( v.value );
}
See Also
@stdlib/math-iter/sequences/cubes
: create an iterator which generates a sequence of cubes.@stdlib/math-iter/sequences/fifth-powers
: create an iterator which generates a sequence of fifth powers.@stdlib/math-iter/sequences/squares
: create an iterator which generates a sequence of squares.
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.