@stdlib/dist-iter-flat v0.0.96

Iterators

Iterator utilities.

Usage

var iterators = require( '@stdlib/dist-iter-flat' );

iterators.<name>( [...args] )

Provides an interface to the iterator utility aliased according to name. Supported utilities may be determined by inspecting the enumerable property list

var objectKeys = require( '@stdib/utils/keys' );

var props = objectKeys( iterators );
// returns [ ... ]

For example, to use to the iterErf() iterator,

var src = iterators.array2iterator( [ -1.0, -0.5, 0.0, 0.5, 1.0 ] );
var it = iterators.iterErf( src );

To discover supported arguments for each iterator API, consult the documentation for the individual iterator.

Notes

• This package contains bundles exposing a flat namespace. A flat namespace uses the global alias namespace, where each package has a unique alias (e.g., iterators.iterErf).

• This package contains distributable files for use in browser environments or as shared ("vendored") libraries in server environments. Each distributable file is a standalone UMD bundle which, if no recognized module system is present, will expose bundle contents to the global scope.

• Each minified bundle has a corresponding gzip-compressed bundle. The gzip compression level for each compressed bundle is 9, which is the highest (and most optimal) compression level. Deciding between uncompressed and compressed bundles depends on the application and whether compression is handled elsewhere in the application stack (e.g., nginx, CDN, et cetera).

• While you are strongly encouraged to vendor bundles and host with a CDN/provider which can provide availability guarantees, especially for production applications, bundles are available via unpkg for quick demos, proof-of-concepts, and instructional material. For example,

  <script type="text/javascript" src="https://unpkg.com/@stdlib/dist-iter-flat"></script>

  Please be mindful that unpkg is a free, best-effort service relying on donated infrastructure which does not provide any availability guarantees. Under no circumstances should you abuse or misuse the service. You have been warned.

• If you intend on embedding a standalone bundle within another bundle, you may need to rename require calls within the standalone bundle before bundling in order to maintain scoped module resolution. For example, if you plan on using browserify to generate a bundle containing embedded bundles, browserify plugins exist to "de-require" those bundles prior to bundling.

• The bundles in this package contains all stdlib iterator, and iterator related, utilities.

Examples

var iterators = require( '@stdlib/dist-iter-flat' );

var arr = [ -1.0, 0.5, 0.0, 0.5, 1.0 ];
var it = iterators.iterErf( iterators.array2iterator( arr ) );

var v;
while ( true ) {
    v = it.next();
    if ( v.done ) {
        break;
    }
    console.log( v.value );
}

To include the bundle in a webpage,

<script type="text/javascript" src="/path/to/@stdlib/dist-iter-flat/build/bundle.min.js"></script>

If no recognized module system is present, access bundle contents via the global scope.

<script type="text/javascript">
    // If no recognized module system present, exposed to global scope:
    var iterErf = stdlib_iter_flat.iterErf;
</script>