About stdlib...

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!

ddot

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

The dot product (or scalar product) is defined as

$$\mathbf{x}\cdot\mathbf{y} = \sum_{i=0}^{N-1} x_i y_i = x_0 y_0 + x_1 y_1 + \ldots + x_{N-1} y_{N-1}$$

Installation

npm install @stdlib/blas-base-ddot

Alternatively,

To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
If you are using Deno, visit the deno branch (see README for usage intructions).
For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

var ddot = require( '@stdlib/blas-base-ddot' );

ddot( N, x, strideX, y, strideY )

Calculates the dot product of vectors x and y.

var Float64Array = require( '@stdlib/array-float64' );

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

var z = ddot( x.length, x, 1, y, 1 );
// returns -5.0

The function has the following parameters:

N: number of indexed elements.
x: input Float64Array.
strideX: index increment for x.
y: input Float64Array.
strideY: index increment for y.

The N and strides parameters determine which elements in the strided arrays are accessed at runtime. For example, to calculate the dot product of every other value in x and the first N elements of y in reverse order,

var Float64Array = require( '@stdlib/array-float64' );

var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );

var z = ddot( 3, x, 2, y, -1 );
// returns 9.0

Note that indexing is relative to the first index. To introduce an offset, use typed array views.

var Float64Array = require( '@stdlib/array-float64' );

// Initial arrays...
var x0 = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
var y0 = new Float64Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );

// Create offset views...
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
var y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*3 ); // start at 4th element

var z = ddot( 3, x1, -2, y1, 1 );
// returns 128.0

ddot.ndarray( N, x, strideX, offsetX, y, strideY, offsetY )

Calculates the dot product of x and y using alternative indexing semantics.

var Float64Array = require( '@stdlib/array-float64' );

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

var z = ddot.ndarray( x.length, x, 1, 0, y, 1, 0 );
// returns -5.0

The function has the following additional parameters:

offsetX: starting index for x.
offsetY: starting index for y.

While typed array views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, to calculate the dot product of every other value in x starting from the second value with the last 3 elements in y in reverse order

var Float64Array = require( '@stdlib/array-float64' );

var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
var y = new Float64Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );

var z = ddot.ndarray( 3, x, 2, 1, y, -1, y.length-1 );
// returns 128.0

Notes

If N <= 0, both functions return 0.0.
ddot() corresponds to the BLAS level 1 function ddot.

Examples

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

var opts = {
    'dtype': 'float64'
};
var x = discreteUniform( 10, 0, 100, opts );
console.log( x );

var y = discreteUniform( x.length, 0, 10, opts );
console.log( y );

var out = ddot.ndarray( x.length, x, 1, 0, y, -1, y.length-1 );
console.log( out );

C APIs

Usage

#include "stdlib/blas/base/ddot.h"

c_ddot( N, X, strideX, Y, strideY )

Computes the dot product of two double-precision floating-point vectors.

const double x[] = { 4.0, 2.0, -3.0, 5.0, -1.0 };
const double y[] = { 2.0, 6.0, -1.0, -4.0, 8.0 };

double v = c_ddot( 5, x, 1, y, 1 );
// returns -5.0

The function accepts the following arguments:

N: [in] CBLAS_INT number of indexed elements.
X: [in] double* first input array.
strideX: [in] CBLAS_INT index increment for X.
Y: [in] double* second input array.
strideY: [in] CBLAS_INT index increment for Y.

double c_ddot( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const double *Y, const CBLAS_INT strideY );

c_ddot_ndarray( N, X, strideX, offsetX, Y, strideY, offsetY )

Computes the dot product of two double-precision floating-point vectors using alternative indexing semantics.

const double x[] = { 4.0, 2.0, -3.0, 5.0, -1.0 };
const double y[] = { 2.0, 6.0, -1.0, -4.0, 8.0 };

double v = c_ddot_ndarray( 5, x, -1, 4, y, -1, 4 );
// returns -5.0

The function accepts the following arguments:

N: [in] CBLAS_INT number of indexed elements.
X: [in] double* first input array.
strideX: [in] CBLAS_INT index increment for X.
offsetX: [in] CBLAS_INT starting index for X.
Y: [in] double* second input array.
strideY: [in] CBLAS_INT index increment for Y.
offsetY: [in] CBLAS_INT starting index for Y.

double c_ddot_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const double *Y, const CBLAS_INT strideY. const CBLAS_INT offsetY );

Examples

#include "stdlib/blas/base/ddot.h"
#include <stdio.h>

int main( void ) {
    // Create strided arrays:
    const double x[] = { 1.0, -2.0, 3.0, -4.0, 5.0, -6.0, 7.0, -8.0 };
    const double y[] = { 1.0, -2.0, 3.0, -4.0, 5.0, -6.0, 7.0, -8.0 };

    // Specify the number of elements:
    const int N = 8;

    // Specify strides:
    const int strideX = 1;
    const int strideY = -1;

    // Compute the dot product:
    double d = c_ddot( N, x, strideX, y, strideY );

    // Print the result:
    printf( "dot product: %lf\n", d );

    // Compute the dot product:
    d = c_ddot_ndarray( N, x, strideX, 0, y, strideY, N-1 );

    // Print the result:
    printf( "dot product: %lf\n", d );
}

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.

Community

License

See LICENSE.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

ddot

Installation

Usage

ddot( N, x, strideX, y, strideY )

ddot.ndarray( N, x, strideX, offsetX, y, strideY, offsetY )

Notes

Examples

C APIs

Usage

c_ddot( N, X, strideX, Y, strideY )

c_ddot_ndarray( N, X, strideX, offsetX, Y, strideY, offsetY )

Examples

See Also

Notice

Community

License

Copyright

Files

README.md

Latest commit

History

README.md

File metadata and controls

ddot

Installation

Usage

ddot( N, x, strideX, y, strideY )

ddot.ndarray( N, x, strideX, offsetX, y, strideY, offsetY )

Notes

Examples

C APIs

Usage

c_ddot( N, *X, strideX, *Y, strideY )

c_ddot_ndarray( N, *X, strideX, offsetX, *Y, strideY, offsetY )

Examples

See Also

Notice

Community

License

Copyright

c_ddot( N, X, strideX, Y, strideY )

c_ddot_ndarray( N, X, strideX, offsetX, Y, strideY, offsetY )