[/ 

THIS FILE IS AUTOMATICALLY GENERATED, PLEASE DO NOT EDIT!

]

[section latrz]

[heading Prototype]
There is one prototype of `latrz` available, please see below.
``
latrz( MatrixA& a, VectorTAU& tau );
``


[heading Description]

`latrz` (short for $FRIENDLY_NAME) provides a C++
interface to LAPACK routines SLATRZ, DLATRZ, CLATRZ, and ZLATRZ. 
`latrz` factors the M-by-(M+L) complex upper trapezoidal matrix
[ A1 A2 ] = [ A(1:M,1:M) A(1:M,N-L+1:N) ] as ( R 0 ) * Z by means
of unitary transformations, where Z is an (M+L)-by-(M+L) unitary
matrix and, R and A1 are M-by-M upper triangular matrices.

The selection of the LAPACK 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`.
The dispatching table below illustrates to which specific routine 
the code path will be generated. 

[table Dispatching of latrz
[  [ Value type of MatrixA ] [LAPACK routine] ]
[  [`float`][SLATRZ] ]
[  [`double`][DLATRZ] ]
[  [`complex<float>`][CLATRZ] ]
[  [`complex<double>`][ZLATRZ] ]

]


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

lapack::latrz( 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/slatrz.f slatrz.f], [@http://www.netlib.org/lapack/double/dlatrz.f dlatrz.f], [@http://www.netlib.org/lapack/complex/clatrz.f clatrz.f], and [@http://www.netlib.org/lapack/complex16/zlatrz.f zlatrz.f] at Netlib.

[endsect]
