##### dot

###### Prototype

There is one prototype of `dot` available, please see below.

    dot( const VectorX& x, const VectorY& y );

###### Description

`dot` (short for TODO) provides a C++ interface to BLAS routines SDOT, DDOT, CDOTU, and ZDOTU.

The selection of the BLAS routine is done during compile-time, and is determined by the type of values contained in type `VectorX`. The type of values is obtained through the `value_type` meta-function `typename value_type<VectorX>::type`. Table X below illustrates to which specific routine this dispatching will take place.

Table 1.12. Dispatching of dot.

Value type of VectorX | BLAS routine | CBLAS routine | CUBLAS routine
--- | --- | --- | ---
`float` | SDOT | cblas_sdot | cublasSdot
`double` | DDOT | cblas_ddot | cublasDdot
`complex<float>` | CDOTU | cblas_cdotu_sub | cublasCdotu
`complex<double>` | ZDOTU | cblas_zdotu_sub | cublasZdotu

The original routines SDOT, DDOT, CDOTU, and ZDOTU have five arguments, whereas `dot` requires two arguments.

Table 1.13. Deduction of arguments of dot.

###### Definition

Defined in header `boost/numeric/bindings/blas/level1/dot.hpp`.

###### Parameters or Requirements on Types

Parameters

MatrixA

  The definition of term 1

MatrixB

  The definition of term 2

MatrixC

  The definition of term 3.

  Definitions may contain paragraphs.

###### Complexity

###### Example

    #include <boost/numeric/bindings/blas/level1/dot.hpp>
    using namespace boost::numeric::bindings;

    blas::dot( x, y, z );

this will output

    [5] 0 1 2 3 4 5

###### Notes

###### See Also

- Originating Fortran source files sdot.f, ddot.f, cdotu.f, and zdotu.f at Netlib.