[/ 

THIS FILE IS AUTOMATICALLY GENERATED, PLEASE DO NOT EDIT!

]

[section hbtrd]

[heading Prototype]
There is one prototype of `hbtrd` available, please see below.
``
hbtrd( const char vect, MatrixAB& ab, VectorD& d, VectorE& e,
        MatrixQ& q );
``


[heading Description]

`hbtrd` (short for $FRIENDLY_NAME) provides a C++
interface to LAPACK routines SSBTRD, DSBTRD, CHBTRD, and ZHBTRD. 
`hbtrd` reduces a complex Hermitian band matrix A to real symmetric
tridiagonal form T by a unitary similarity transformation:
Q**H * A * Q = T.

The selection of the LAPACK routine is done during compile-time, 
and is determined by the type of values contained in type `MatrixAB`.
The type of values is obtained through the `value_type` meta-function
 `typename value_type<MatrixAB>::type`.
The dispatching table below illustrates to which specific routine 
the code path will be generated. 

[table Dispatching of hbtrd
[  [ Value type of MatrixAB ] [LAPACK routine] ]
[  [`float`][SSBTRD] ]
[  [`double`][DSBTRD] ]
[  [`complex<float>`][CHBTRD] ]
[  [`complex<double>`][ZHBTRD] ]

]


[heading Definition]
Defined in header [headerref boost/numeric/bindings/lapack/computational/hbtrd.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/lapack/computational/hbtrd.hpp>
using namespace boost::numeric::bindings;

lapack::hbtrd( 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/lapack/single/ssbtrd.f ssbtrd.f], [@http://www.netlib.org/lapack/double/dsbtrd.f dsbtrd.f], [@http://www.netlib.org/lapack/complex/chbtrd.f chbtrd.f], and [@http://www.netlib.org/lapack/complex16/zhbtrd.f zhbtrd.f] at Netlib.

[endsect]
