[/ 

THIS FILE IS AUTOMATICALLY GENERATED, PLEASE DO NOT EDIT!

]

[section tbmv]

[heading Prototype]
There is one prototype of `tbmv` available, please see below.
``
tbmv( const int_t k, const MatrixA& a, VectorX& x );
``


[heading Description]

`tbmv` (short for triangular, banded,  matrix-vector operation) provides a C++
interface to BLAS routines STBMV, DTBMV, CTBMV, and ZTBMV. 
`tbmv` performs one of the matrix-vector operations

x := A*x, or x := A**T*x, or x := A**H*x,

where x is an n element vector and A is an n by n unit, or non-unit,
upper or lower triangular band matrix, with ( k + 1 ) diagonals.

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

[table Dispatching of tbmv.
[  [ Value type of MatrixA ] [BLAS routine] [CBLAS routine] [CUBLAS routine] ]
[  [`float`][STBMV][cblas_stbmv][cublasStbmv] ]
[  [`double`][DTBMV][cblas_dtbmv][cublasDtbmv] ]
[  [`complex<float>`][CTBMV][cblas_ctbmv][cublasCtbmv] ]
[  [`complex<double>`][ZTBMV][cblas_ztbmv][cublasZtbmv] ]

]

The original routines STBMV, DTBMV, CTBMV, and ZTBMV have nine arguments,
whereas `tbmv` requires three arguments.

[table Deduction of arguments of tbmv.
]

[heading Definition]
Defined in header [headerref boost/numeric/bindings/blas/level2/tbmv.hpp].

[heading Parameters or Requirements on Types]

[variablelist Parameters
    [[MatrixA] [The definition of term 1]]
    [[MatrixB] [The definition of term 2]]
    [[MatrixC] [
    The definition of term 3.

    Definitions may contain paragraphs.
    ]]
]

[heading Complexity]

[heading Example]
``
#include <boost/numeric/bindings/blas/level2/tbmv.hpp>
using namespace boost::numeric::bindings;

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

``

this will output

``
[5] 0 1 2 3 4 5
``

[heading Notes]

[heading See Also]

* Originating Fortran source files [@http://www.netlib.org/blas/stbmv.f stbmv.f], [@http://www.netlib.org/blas/dtbmv.f dtbmv.f], [@http://www.netlib.org/blas/ctbmv.f ctbmv.f], and [@http://www.netlib.org/blas/ztbmv.f ztbmv.f] at Netlib.

[endsect]
