Nocturnal Pumpkin Maelstrom

    @stdlib/utils-inmap
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.7 • Public • Published

    inmap

    NPM version Build Status Coverage Status dependencies

    Invoke a function for each element in a collection and update the collection in-place.

    Installation

    npm install @stdlib/utils-inmap

    Usage

    var inmap = require( '@stdlib/utils-inmap' );

    inmap( collection, fcn[, thisArg ] )

    Invokes a function for each element in a collection and updates the collection in-place.

    function scale( value, index ) {
        return value * index;
    }
    
    var arr = [ 1, 2, 3, 4 ];
    
    var out = inmap( arr, scale );
    // returns [ 0, 2, 6, 12 ]
    
    var bool = ( out === arr );
    // returns true

    The invoked function is provided three arguments:

    • value: collection element
    • index: collection index
    • collection: input collection

    Basic support for dynamic collections is provided. Note, however, that index incrementation is monotonically increasing.

    function scale1( value, index, collection ) {
        if ( index === collection.length-1 && collection.length < 10 ) {
            collection.push( index+2 );
        }
        return value * index;
    }
    
    var arr = [ 1, 2, 3, 4 ];
    
    var out = inmap( arr, scale1 );
    // returns [ 0, 2, 6, 12, 20, 30, 42, 56, 72, 90 ]
    
    function scale2( value, index, collection ) {
        collection.shift();
        return value * index;
    }
    
    arr = [ 1, 2, 3, 4 ];
    
    out = inmap( arr, scale2 );
    // returns [ 3, 3 ]

    To set the function execution context, provide a thisArg.

    function sum( value ) {
        this.sum += value;
        this.count += 1;
        return value;
    }
    
    var arr = [ 1, 2, 3, 4 ];
    
    var context = {
        'sum': 0,
        'count': 0
    };
    
    var out = inmap( arr, sum, context );
    // returns [ 1, 2, 3, 4 ]
    
    var mean = context.sum / context.count;
    // returns 2.5

    Notes

    • A collection may be either an Array, Typed Array, or an array-like Object (excluding strings and functions).

    • The function differs from Array.prototype.map in the following ways:

      • The function returns the input collection.

      • The function modifies collection elements in-place.

      • The function does not skip undefined elements.

        function log( value, index ) {
            console.log( '%s: %s', index, value );
            return value;
        }
        
        var arr = [ 1, , , 4 ];
        
        var out = inmap( arr, log );
        /* =>
            0: 1
            1: undefined
            2: undefined
            3: 4
        */
      • The function provides limited support for dynamic collections (i.e., collections whose length changes during execution).

    Examples

    var isEven = require( '@stdlib/assert-is-even' ).isPrimitive;
    var inmap = require( '@stdlib/utils-inmap' );
    
    var bool;
    var arr;
    var out;
    var i;
    
    function scale( value, index, collection ) {
        if ( isEven( index ) ) {
            collection.shift();
        } else {
            collection.push( index+1 );
        }
        return value * index;
    }
    
    arr = new Array( 100 );
    for ( i = 0; i < arr.length; i++ ) {
        arr[ i ] = i;
    }
    out = inmap( arr, scale );
    
    bool = ( out === arr );
    console.log( bool );
    
    console.log( out );

    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-2021. The Stdlib Authors.

    Install

    npm i @stdlib/utils-inmap

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    38

    Version

    0.0.7

    License

    Apache-2.0

    Unpacked Size

    42.9 kB

    Total Files

    9

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser