time-to-botec/squiggle/node_modules/@stdlib/blas/sdot/README.md

sdot

Calculate the dot product of two single-precision floating-point vectors.

The dot product (or scalar product) is defined as

Usage

var sdot = require( '@stdlib/blas/sdot' );

sdot( x, y )

Calculates the dot product of vectors x and y.

var Float32Array = require( '@stdlib/array/float32' );
var array = require( '@stdlib/ndarray/array' );

var x = array( new Float32Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ) );
var y = array( new Float32Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ) );

var z = sdot( x, y );
// returns -5.0

The function has the following parameters:

• x: a 1-dimensional ndarray whose underlying data type is float32.
• y: a 1-dimensional ndarray whose underlying data type is float32.

If provided empty vectors, the function returns 0.0.

var Float32Array = require( '@stdlib/array/float32' );
var array = require( '@stdlib/ndarray/array' );

var x = array( new Float32Array() );
var y = array( new Float32Array() );

var z = sdot( x, y );
// returns 0.0

Notes

• sdot() provides a higher-level interface to the BLAS level 1 function sdot.

Examples

var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
var Float32Array = require( '@stdlib/array/float32' );
var array = require( '@stdlib/ndarray/array' );
var sdot = require( '@stdlib/blas/sdot' );

var x = array( new Float32Array( 10 ) );
var y = array( new Float32Array( 10 ) );

var rand1 = discreteUniform.factory( 0, 100 );
var rand2 = discreteUniform.factory( 0, 10 );

var i;
for ( i = 0; i < x.length; i++ ) {
    x.set( i, rand1() );
    y.set( i, rand2() );
}
console.log( x.toString() );
console.log( y.toString() );

var z = sdot( x, y );
console.log( z );