binaryBlockSize

Resolve a loop block size for multi-dimensional array tiled loops.

Installation

npm install @stdlib/ndarray-base-binary-tiling-block-size

Usage

var binaryBlockSize = require( '@stdlib/ndarray-base-binary-tiling-block-size' );

binaryBlockSize( dtypeX, dtypeY, dtypeZ )

Resolves a loop block size according to provided ndarray dtypes for multi-dimensional array tiled loops applying a binary function.

var bsize = binaryBlockSize( 'float64', 'float64', 'float64' );
// returns <number>

Notes

• The returned loop tiling block size is in units of elements.

Examples

var dtypes = require( '@stdlib/ndarray-dtypes' );
var cartesianSquare = require( '@stdlib/array-base-cartesian-square' );
var promotionRules = require( '@stdlib/ndarray-promotion-rules' );
var binaryBlockSize = require( '@stdlib/ndarray-base-binary-tiling-block-size' );

// Generate a list of input ndarray dtype pairs:
var dt = cartesianSquare( dtypes() );

// Resolve the block size for each dtype pair and its promoted dtype...
var t;
var b;
var i;
console.log( 'block_size, xdtype, ydtype, zdtype' );
for ( i = 0; i < dt.length; i++ ) {
    t = promotionRules.apply( null, dt[ i ] );
    dt[ i ].push( ( t === -1 ) ? 'generic' : t );
    b = binaryBlockSize.apply( null, dt[ i ] );
    console.log( '%d, %s, %s, %s', b, dt[i][0], dt[i][1], dt[i][2] );
}

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.