# @stdlib/blas-gdot

0.1.0 • Public • Published

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

# gdot

Calculate the dot product of two vectors.

The dot product (or scalar product) is defined as

## Installation

`npm install @stdlib/blas-gdot`

## Usage

`var gdot = require( '@stdlib/blas-gdot' );`

#### gdot( x, y )

Calculates the dot product of vectors `x` and `y`.

```var Int32Array = require( '@stdlib/array-int32' );
var array = require( '@stdlib/ndarray-array' );

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

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

The function has the following parameters:

If provided empty vectors, the function returns `0.0`.

```var z = gdot( [], [] );
// returns 0.0```

## Notes

• `gdot()` corresponds to the BLAS level 1 function `ddot` with the exception that this implementation works with any array type, not just Float64Arrays.
• In general, for best performance, especially for large vectors, provide 1-dimensional `ndarrays` whose underlying data type is either `float64` or `float32`.

## Examples

```var discreteUniform = require( '@stdlib/random-base-discrete-uniform' );
var gdot = require( '@stdlib/blas-gdot' );

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

var x = [];
var y = [];
var i;
for ( i = 0; i < 10; i++ ) {
x.push( rand1() );
y.push( rand2() );
}
console.log( x );
console.log( y );

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

## 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.

## Package Sidebar

### Install

`npm i @stdlib/blas-gdot`

### Repository

github.com/stdlib-js/blas-gdot

stdlib.io

134

0.1.0

Apache-2.0

46.8 kB

12