logEachMap

Insert array element values and the result of a callback function into a format string and print the result.

Installation

npm install @stdlib/console-log-each-map

Usage

var logEachMap = require( '@stdlib/console-log-each-map' );

logEachMap( str[, ...args], clbk[, thisArg] )

Inserts array element values and the result of a callback function into a format string and prints the result.

function add( a, b ) {
    return a + b;
}

var x = [ 1, 2, 3 ];
var y = [ 4, 5, 6 ];

logEachMap( '%d + %d = %d', x, y, add );
// e.g., => '1 + 4 = 5\n2 + 5 = 7\n3 + 6 = 9\n'

The function accepts the following arguments:

• str: format string.
• args: input arrays (optional).
• clbk: callback function.
• thisArg: callback execution context (optional).

To set the callback execution context, provide a thisArg.

function count( x, y ) {
    this.count += 1;
    return x + y;
}

var x = [ 1, 2, 3 ];
var y = [ 4, 5, 6 ];

var ctx = {
    'count': 0
};

logEachMap( '%d + %d = %d', x, y, count, ctx );
// e.g., => '1 + 4 = 5\n2 + 5 = 7\n3 + 6 = 9\n'

var v = ctx.count;
// returns 3

If an interpolated argument is not an array-like object, the argument is broadcasted for each iteration.

function multiply( x, y ) {
    return x * y;
}

var x = [ 1, 2, 3 ];
var y = 0.5;

logEachMap( '%0.1f * %0.1f = %0.1f', x, y, multiply );
// e.g., => '1.0 * 0.5 = 0.5\n2.0 * 0.5 = 1.0\n3.0 * 0.5 = 1.5\n'

The callback function is provided the following arguments:

• arg0: current array element for the first broadcasted array.
• arg1: current array element for the second broadcasted array.
• ...argN: current array element for the nth broadcasted array.
• index: current element index.
• arrays: broadcasted arrays. If an argument was broadcasted, the corresponding array is a single-element generic array containing the original element.

The number of argX arguments is determined according to the number of provided args arguments. If no args are provided, the callback is invoked without any arguments.

Notes

• If the function is provided array-like objects of unequal lengths, the function throws an error.
• The function supports array-like objects supporting the accessor protocol (e.g., Complex128Array, Complex64Array, etc).

Examples

var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var logEachMap = require( '@stdlib/console-log-each-map' );

function add( x, y ) {
    return x + y;
}

var x = discreteUniform( 10, -50, 50, {
    'dtype': 'float64'
});
var y = discreteUniform( 10, -50, 50, {
    'dtype': 'float64'
});

logEachMap( '%d + %d = %d', x, y, add );

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