README.md

gscal

Multiply a one-dimensional ndarray by a scalar constant.

Usage

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

gscal( arrays )

Multiplies a one-dimensional ndarray by a scalar constant.

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

var x = vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ], 'generic' );

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

var y = gscal( [ x, alpha ] );
// returns <ndarray>[ 5.0, 10.0, 15.0, 20.0, 25.0 ]

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

The function has the following parameters:

• arrays: array-like object containing the following ndarrays:

  • a one-dimensional input ndarray.
  • a zero-dimensional ndarray containing a scalar constant.

Examples

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

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

var x = discreteUniform( [ 10 ], 0, 100, opts );
console.log( ndarray2array( x ) );

var alpha = scalar2ndarray( 5.0, opts );

var out = gscal( [ x, alpha ] );
console.log( ndarray2array( out ) );