Skip to content

Latest commit

 

History

History
276 lines (172 loc) · 10.5 KB

README.md

File metadata and controls

276 lines (172 loc) · 10.5 KB
Raw
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!

sdot

NPM version Build Status Coverage Status

Calculate the dot product of two single-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}$$

Usage

import sdot from 'https://cdn.jsdelivr.net/gh/stdlib-js/blas-sdot@deno/mod.js';

sdot( x, y[, dim] )

Calculates the dot product of two single-precision floating-point vectors x and y.

import Float32Array from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-float32@deno/mod.js';
import array from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-array@deno/mod.js';

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 <ndarray>

var v = z.get();
// returns -5.0

The function has the following parameters:

  • x: a non-zero-dimensional ndarray whose underlying data type is float32. Must be broadcast-compatible with y.
  • y: a non-zero-dimensional ndarray whose underlying data type is float32. Must be broadcast-compatible with x.
  • dim: dimension for which to compute the dot product. Must be a negative integer. Negative indices are resolved relative to the last array dimension, with the last dimension corresponding to -1. Default: -1.

If provided at least one input ndarray having more than one dimension, the input ndarrays are broadcasted to a common shape. For multi-dimensional input ndarrays, the function performs batched computation, such that the function computes the dot product for each pair of vectors in x and y according to the specified dimension index.

import Float32Array from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-float32@deno/mod.js';
import array from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-array@deno/mod.js';

var opts = {
    'shape': [ 2, 3 ]
};
var x = array( new Float32Array( [ 4.0, 2.0, -3.0, 5.0, -1.0, 3.0 ] ), opts );
var y = array( new Float32Array( [ 2.0, 6.0, -1.0, -4.0, 8.0, 2.0 ] ), opts );

var z = sdot( x, y );
// returns <ndarray>

var v1 = z.get( 0 );
// returns 23.0

var v2 = z.get( 1 );
// returns -22.0

Notes

  • The size of the contracted dimension must be the same for both input ndarrays.
  • The function resolves the dimension index for which to compute the dot product before broadcasting.
  • Negative indices are resolved relative to the last ndarray dimension, with the last dimension corresponding to -1.
  • The output ndarray has the same data type as the input ndarrays and has a shape which is determined by broadcasting and excludes the contracted dimension.
  • If provided empty vectors, the dot product is 0.
  • sdot() provides a higher-level interface to the BLAS level 1 function sdot.

Examples

import discreteUniform from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-discrete-uniform@deno/mod.js';
import ndarray2array from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-to-array@deno/mod.js';
import array from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-array@deno/mod.js';
import sdot from 'https://cdn.jsdelivr.net/gh/stdlib-js/blas-sdot@deno/mod.js';

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

var x = array( discreteUniform( 10, 0, 100, opts ), {
    'shape': [ 5, 2 ]
});
console.log( ndarray2array( x ) );

var y = array( discreteUniform( 10, 0, 10, opts ), {
    'shape': x.shape
});
console.log( ndarray2array( y ) );

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

See Also

Notice

This package is part of stdlib, a standard library 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

Chat

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.