README.md

gapx

Add a scalar constant to each element in a one-dimensional ndarray.

Usage

var gapx = require( '@stdlib/blas/ext/base/ndarray/gapx' );

gapx( arrays )

Adds a scalar constant to each element in a one-dimensional ndarray.

var ndarray = require( '@stdlib/ndarray/ctor' );
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
var ndarray2array = require( '@stdlib/ndarray/to-array' );

var xbuf = [ 1.0, 2.0, 3.0, 4.0 ];
var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );

var alpha = scalar2ndarray( 5.0, {
    'dtype': 'generic'
});

var out = gapx( [ x, alpha ] );
// returns <ndarray>[ 6, 7, 8, 9 ]

var bool = ( out === x );
// returns true

var arr = ndarray2array( out );
// returns [ 6, 7, 8, 9 ]

The function has the following parameters:

• arrays: array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray containing a scalar constant.

var ndarray = require( '@stdlib/ndarray/ctor' );
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );

// Initial array:
var xbuf = [ 1.0, 2.0, 3.0, 4.0, 5.0 ];

// Create an ndarray view:
var x = new ndarray( 'generic', xbuf, [ 3 ], [ 1 ], 2, 'row-major' );
var alpha = scalar2ndarray( 5.0, {
    'dtype': 'generic'
});
var out = gapx( [ x, alpha ] );
// returns <ndarray>[ 8, 9, 10 ]

Notes

• The function supports generic arrays and typed arrays.

Examples

var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var ndarray = require( '@stdlib/ndarray/ctor' );
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var gapx = require( '@stdlib/blas/ext/base/ndarray/gapx' );

var xbuf = discreteUniform( 10, 0, 100, {
    'dtype': 'generic'
});
var x = new ndarray( 'generic', xbuf, [ 10 ], [ 1 ], 0, 'row-major' );
console.log( ndarray2array( x ) );

var alpha = scalar2ndarray( 5.0, {
    'dtype': 'generic'
});

gapx( [ x, alpha ] );
console.log( ndarray2array( x ) );