Nullifying Precipitation Machine

    @stdlib/iter-replicate-by
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.7 • Public • Published

    iterReplicateBy

    NPM version Build Status Coverage Status

    Create an iterator which replicates each iterated value according to a provided function.

    Installation

    npm install @stdlib/iter-replicate-by

    Usage

    var iterReplicateBy = require( '@stdlib/iter-replicate-by' );

    iterReplicateBy( iterator, fcn[, thisArg] )

    Returns an iterator which replicates each iterated value according to a provided function.

    var array2iterator = require( '@stdlib/array-to-iterator' );
    
    function fcn( v, i ) {
        return i + 1;
    }
    
    var it = iterReplicateBy( array2iterator( [ 1, 2, 3, 4 ] ), fcn );
    // returns <Object>
    
    var v = it.next().value;
    // returns 1
    
    v = it.next().value;
    // returns 2
    
    v = it.next().value;
    // returns 2
    
    v = it.next().value;
    // returns 3
    
    v = it.next().value;
    // returns 3
    
    v = it.next().value;
    // returns 3
    
    v = it.next().value;
    // returns 4
    
    // ...

    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 a done property having a boolean 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 callback function is provided three arguments:

    • value: iterated value
    • index: source iteration index (zero-based)
    • n: iteration index (zero-based)

    To set the callback execution context, provide a thisArg.

    var array2iterator = require( '@stdlib/array-to-iterator' );
    
    function fcn( v, i ) {
        this.count += 1;
        return i + 1;
    }
    
    var ctx = {
        'count': 0
    };
    
    var it = iterReplicateBy( array2iterator( [ 1, 2, 3, 4 ] ), fcn, ctx );
    // returns <Object>
    
    var v = it.next().value;
    // returns 1
    
    v = it.next().value;
    // returns 2
    
    v = it.next().value;
    // returns 2
    
    v = it.next().value;
    // returns 3
    
    var count = ctx.count;
    // returns 3

    Notes

    • A callback function is invoked once per iterated value of the provided iterator.
    • A callback function must return an integer value. If the return value is less than or equal to 0, the returned iterator skips an iterated value and invokes the callback for the next iterated value of the provided iterator.
    • If an environment supports Symbol.iterator and a provided iterator is iterable, the returned iterator is iterable.

    Examples

    var randu = require( '@stdlib/random-iter-randu' );
    var discreteUniform = require( '@stdlib/random-base-discrete-uniform' );
    var iterReplicateBy = require( '@stdlib/iter-replicate-by' );
    
    // Create a seeded iterator for generating pseudorandom numbers:
    var rand = randu({
        'seed': 1234,
        'iter': 10
    });
    
    // Create an iterator which replicates each generated number a random number of times:
    var it = iterReplicateBy( rand, discreteUniform.factory( 1, 10 ) );
    
    // Perform manual iteration...
    var v;
    while ( true ) {
        v = it.next();
        if ( v.done ) {
            break;
        }
        console.log( v.value );
    }

    See Also

    • @stdlib/iter/replicate: create an iterator which replicates each iterated value a specified number of times.

    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

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2022. The Stdlib Authors.

    Install

    npm i @stdlib/iter-replicate-by

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    27

    Version

    0.0.7

    License

    Apache-2.0

    Unpacked Size

    48.9 kB

    Total Files

    9

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser