144 lines
3.6 KiB
Markdown
144 lines
3.6 KiB
Markdown
<!--
|
|
|
|
@license Apache-2.0
|
|
|
|
Copyright (c) 2020 The Stdlib Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
|
|
-->
|
|
|
|
# ddot
|
|
|
|
> Calculate the dot product of two double-precision floating-point vectors.
|
|
|
|
<section class="intro">
|
|
|
|
The [dot product][dot-product] (or scalar product) is defined as
|
|
|
|
<!-- <equation class="equation" label="eq:dot_product" align="center" raw="\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}" alt="Dot product definition."> -->
|
|
|
|
<div class="equation" align="center" data-raw-text="\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}" data-equation="eq:dot_product">
|
|
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@d0afc603cdda35b11d5bd1633dd4dddb0d59e117/lib/node_modules/@stdlib/blas/ddot/docs/img/equation_dot_product.svg" alt="Dot product definition.">
|
|
<br>
|
|
</div>
|
|
|
|
<!-- </equation> -->
|
|
|
|
</section>
|
|
|
|
<!-- /.intro -->
|
|
|
|
<section class="usage">
|
|
|
|
## Usage
|
|
|
|
```javascript
|
|
var ddot = require( '@stdlib/blas/ddot' );
|
|
```
|
|
|
|
#### ddot( x, y )
|
|
|
|
Calculates the dot product of two double-precision floating-point vectors `x` and `y`.
|
|
|
|
```javascript
|
|
var Float64Array = require( '@stdlib/array/float64' );
|
|
var array = require( '@stdlib/ndarray/array' );
|
|
|
|
var x = array( new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ) );
|
|
var y = array( new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ) );
|
|
|
|
var z = ddot( x, y );
|
|
// returns -5.0
|
|
```
|
|
|
|
The function has the following parameters:
|
|
|
|
- **x**: a 1-dimensional [`ndarray`][@stdlib/ndarray/array] whose underlying data type is `float64`.
|
|
- **y**: a 1-dimensional [`ndarray`][@stdlib/ndarray/array] whose underlying data type is `float64`.
|
|
|
|
If provided empty vectors, the function returns `0.0`.
|
|
|
|
```javascript
|
|
var Float64Array = require( '@stdlib/array/float64' );
|
|
var array = require( '@stdlib/ndarray/array' );
|
|
|
|
var x = array( new Float64Array() );
|
|
var y = array( new Float64Array() );
|
|
|
|
var z = ddot( x, y );
|
|
// returns 0.0
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- /.usage -->
|
|
|
|
<section class="notes">
|
|
|
|
## Notes
|
|
|
|
- `ddot()` provides a higher-level interface to the [BLAS][blas] level 1 function [`ddot`][@stdlib/blas/base/ddot].
|
|
|
|
</section>
|
|
|
|
<!-- /.notes -->
|
|
|
|
<section class="examples">
|
|
|
|
## Examples
|
|
|
|
<!-- eslint no-undef: "error" -->
|
|
|
|
```javascript
|
|
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
|
|
var Float64Array = require( '@stdlib/array/float64' );
|
|
var array = require( '@stdlib/ndarray/array' );
|
|
var ddot = require( '@stdlib/blas/ddot' );
|
|
|
|
var x = array( new Float64Array( 10 ) );
|
|
var y = array( new Float64Array( 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 = ddot( x, y );
|
|
console.log( z );
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- /.examples -->
|
|
|
|
<section class="links">
|
|
|
|
[dot-product]: https://en.wikipedia.org/wiki/Dot_product
|
|
|
|
[blas]: http://www.netlib.org/blas
|
|
|
|
[@stdlib/blas/base/ddot]: https://www.npmjs.com/package/@stdlib/blas/tree/main/base/ddot
|
|
|
|
[@stdlib/ndarray/array]: https://www.npmjs.com/package/@stdlib/ndarray-array
|
|
|
|
</section>
|
|
|
|
<!-- /.links -->
|