[/ 

THIS FILE IS AUTOMATICALLY GENERATED, PLEASE DO NOT EDIT!

]

[section pftrf]

[heading Prototype]
There is one prototype of `pftrf` available, please see below.
``
pftrf( const char uplo, MatrixA& a );
``


[heading Description]

`pftrf` (short for $FRIENDLY_NAME) provides a C++
interface to LAPACK routines SPFTRF, DPFTRF, CPFTRF, and ZPFTRF. 
`pftrf` computes the Cholesky factorization of a complex Hermitian
positive definite matrix A.

The factorization has the form
A = U**H * U, if UPLO = 'U', or
A = L * L**H, if UPLO = 'L',
where U is an upper triangular matrix and L is lower triangular.

This is the block version of the algorithm, calling Level 3 BLAS.

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 pftrf
[  [ Value type of MatrixA ] [LAPACK routine] ]
[  [`float`][SPFTRF] ]
[  [`double`][DPFTRF] ]
[  [`complex<float>`][CPFTRF] ]
[  [`complex<double>`][ZPFTRF] ]

]


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

lapack::pftrf( 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/spftrf.f spftrf.f], [@http://www.netlib.org/lapack/double/dpftrf.f dpftrf.f], [@http://www.netlib.org/lapack/complex/cpftrf.f cpftrf.f], and [@http://www.netlib.org/lapack/complex16/zpftrf.f zpftrf.f] at Netlib.

[endsect]
