README.md

caxpy

Multiply a one-dimensional single-precision complex floating-point ndarray x by a constant alpha and add the result to a one-dimensional single-precision complex floating-point ndarray y.

Usage

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

caxpy( arrays )

Multiplies a one-dimensional single-precision complex floating-point ndarray x by a constant alpha and adds the result to a one-dimensional single-precision complex floating-point ndarray y.

var Complex64Array = require( '@stdlib/array/complex64' );
var Complex64 = require( '@stdlib/complex/float32/ctor' );
var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
var ndarray = require( '@stdlib/ndarray/base/ctor' );

var xbuf = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
var x = new ndarray( 'complex64', xbuf, [ 3 ], [ 1 ], 0, 'row-major' );

var ybuf = new Complex64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
var y = new ndarray( 'complex64', ybuf, [ 3 ], [ 1 ], 0, 'row-major' );

var alpha = scalar2ndarray( new Complex64( 1.0, 2.0 ), 'complex64', 'row-major' );
var z = caxpy( [ x, y, alpha ] );
// returns <ndarray>[ <Complex64>[ -2.0, 5.0 ], <Complex64>[ -4.0, 11.0 ], <Complex64>[ -6.0, 17.0 ] ]

var bool = ( y === z );
// returns true

The function has the following parameters:

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

Examples

var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var Complex64Array = require( '@stdlib/array/complex64' );
var Complex64 = require( '@stdlib/complex/float32/ctor' );
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
var ndarray = require( '@stdlib/ndarray/base/ctor' );
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var caxpy = require( '@stdlib/blas/base/ndarray/caxpy' );

var opts = {
    'dtype': 'float32'
};

var xbuf = new Complex64Array( discreteUniform( 10, 0, 100, opts ) );
var x = new ndarray( 'complex64', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
console.log( ndarray2array( x ) );

var ybuf = new Complex64Array( discreteUniform( xbuf.length*2, 0, 10, opts ) );
var y = new ndarray( 'complex64', ybuf, [ ybuf.length ], [ 1 ], 0, 'row-major' );
console.log( ndarray2array( y ) );

var alpha = scalar2ndarray( new Complex64( 1.0, 2.0 ), {
    'dtype': 'complex64'
});
var out = caxpy( [ x, y, alpha ] );
console.log( ndarray2array( out ) );