text: //=================================================================================================
  /*!
  //  \file blaze/math/lapack/clapack/potrf.h
  //  \brief Header file for the CLAPACK potrf wrapper functions
  //
  //  Copyright (C) 2013 Klaus Iglberger - All Rights Reserved
  //
  //  This file is part of the Blaze library. You can redistribute it and/or modify it under
  //  the terms of the New (Revised) BSD License. Redistribution and use in source and binary
  //  forms, with or without modification, are permitted provided that the following conditions
  //  are met:
  //
  //  1. Redistributions of source code must retain the above copyright notice, this list of
  //     conditions and the following disclaimer.
  //  2. Redistributions in binary form must reproduce the above copyright notice, this list
  //     of conditions and the following disclaimer in the documentation and/or other materials
  //     provided with the distribution.
  //  3. Neither the names of the Blaze development group nor the names of its contributors
  //     may be used to endorse or promote products derived from this software without specific
  //     prior written permission.
  //
  //  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
  //  EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  //  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
  //  SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  //  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
  //  TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  //  BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  //  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  //  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
  //  DAMAGE.
  */
  //=================================================================================================
  
  #ifndef _BLAZE_MATH_LAPACK_CLAPACK_POTRF_H_
  #define _BLAZE_MATH_LAPACK_CLAPACK_POTRF_H_
  
  
  //*************************************************************************************************
  // Includes
  //*************************************************************************************************
  
  #include <blaze/util/Complex.h>
  #include <blaze/util/StaticAssert.h>
  
  
  namespace blaze {
  
  //=================================================================================================
  //
  //  LAPACK FORWARD DECLARATIONS
  //
  //=================================================================================================
  
  //*************************************************************************************************
  /*! \cond BLAZE_INTERNAL */
  extern "C" {
  
  void spotrf_( char* uplo, int* n, float*  A, int* lda, int* info );
  void dpotrf_( char* uplo, int* n, double* A, int* lda, int* info );
  void cpotrf_( char* uplo, int* n, float*  A, int* lda, int* info );
  void zpotrf_( char* uplo, int* n, double* A, int* lda, int* info );
  
  }
  /*! \endcond */
  //*************************************************************************************************
  
  
  
  
  //=================================================================================================
  //
  //  LAPACK LLH (CHOLESKY) DECOMPOSITION FUNCTIONS (POTRF)
  //
  //=================================================================================================
  
  //*************************************************************************************************
  /*!\name LAPACK LLH (Cholesky) decomposition functions (potrf) */
  //@{
  inline void potrf( char uplo, int n, float* A, int lda, int* info );
  
  inline void potrf( char uplo, int n, double* A, int lda, int* info );
  
  inline void potrf( char uplo, int n, complex<float>* A, int lda, int* info );
  
  inline void potrf( char uplo, int n, complex<double>* A, int lda, int* info );
  //@}
  //*************************************************************************************************
  
  
  //*************************************************************************************************
  /*!\brief LAPACK kernel for the Cholesky decomposition of the given dense positive definite
  //        single precision column-major matrix.
  // \ingroup lapack_decomposition
  //
  // \param uplo \c 'L' to use the lower part of the matrix, \c 'U' to use the upper part.
  // \param n The number of rows/columns of the matrix \f$[0..\infty)\f$.
  // \param A Pointer to the first element of the single precision column-major matrix.
  // \param lda The total number of elements between two columns of the matrix \f$[0..\infty)\f$.
  // \param info Return code of the function call.
  // \return void
  //
  // This function performs the dense matrix Cholesky decomposition of a symmetric positive definite
  // single precision column-major matrix based on the LAPACK spotrf() function. The decomposition
  // has the form
  
                        \f[ A = U^{T} U \texttt{ (if uplo = 'U'), or }
                            A = L L^{T} \texttt{ (if uplo = 'L'), } \f]
  
  // where \c U is an upper triangular matrix and \c L is a lower triangular matrix. The resulting
  // decomposition is stored within \a A: In case \a uplo is set to \c 'L' the result is stored in
  // the lower part of the matrix and the upper part remains untouched, in case \a uplo is set to
  // \c 'U' the result is stored in the upper part and the lower part remains untouched.
  //
  // The \a info argument provides feedback on the success of the function call:
  //
  //   - = 0: The decomposition finished successfully.
  //   - < 0: If info = -i, the i-th argument had an illegal value.
  //   - > 0: If info = i, the leading minor of order i is not positive definite.
  //
  // For more information on the spotrf() function, see the LAPACK online documentation browser:
  //
  //        http://www.netlib.org/lapack/explore-html/
  //
  // \note This function can only be used if the fitting LAPACK library is available and linked to
  // the executable. Otherwise a call to this function will result in a linker error.
  */
  inline void potrf( char uplo, int n, float* A, int lda, int* info )
  {
     spotrf_( &uplo, &n, A, &lda, info );
  }
  //*************************************************************************************************
  
  
  //*************************************************************************************************
  /*!\brief LAPACK kernel for the Cholesky decomposition of the given dense positive definite
  //        double precision column-major matrix.
  // \ingroup lapack_decomposition
  //
  // \param uplo \c 'L' to use the lower part of the matrix, \c 'U' to use the upper part.
  // \param n The number of rows/columns of the matrix \f$[0..\infty)\f$.
  // \param A Pointer to the first element of the double precision column-major matrix.
  // \param lda The total number of elements between two columns of the matrix \f$[0..\infty)\f$.
  // \param info Return code of the function call.
  // \return void
  //
  // This function performs the dense matrix Cholesky decomposition of a symmetric positive definite
  // double precision column-major matrix based on the LAPACK dpotrf() function. The decomposition
  // has the form
  
                        \f[ A = U^{T} U \texttt{ (if uplo = 'U'), or }
                            A = L L^{T} \texttt{ (if uplo = 'L'), } \f]
  
  // where \c U is an upper triangular matrix and \c L is a lower triangular matrix. The resulting
  // decomposition is stored within \a A: In case \a uplo is set to \c 'L' the result is stored in
  // the lower part of the matrix and the upper part remains untouched, in case \a uplo is set to
  // \c 'U' the result is stored in the upper part and the lower part remains untouched.
  //
  // The \a info argument provides feedback on the success of the function call:
  //
  //   - = 0: The decomposition finished successfully.
  //   - < 0: If info = -i, the i-th argument had an illegal value.
  //   - > 0: If info = i, the leading minor of order i is not positive definite.
  //
  // For more information on the dpotrf() function, see the LAPACK online documentation browser:
  //
  //        http://www.netlib.org/lapack/explore-html/
  //
  // \note This function can only be used if the fitting LAPACK library is available and linked to
  // the executable. Otherwise a call to this function will result in a linker error.
  */
  inline void potrf( char uplo, int n, double* A, int lda, int* info )
  {
     dpotrf_( &uplo, &n, A, &lda, info );
  }
  //*************************************************************************************************
  
  
  //*************************************************************************************************
  /*!\brief LAPACK kernel for the Cholesky decomposition of the given dense positive definite
  //        single precision complex column-major matrix.
  // \ingroup lapack_decomposition
  //
  // \param uplo \c 'L' to use the lower part of the matrix, \c 'U' to use the upper part.
  // \param n The number of rows/columns of the matrix \f$[0..\infty)\f$.
  // \param A Pointer to the first element of the single precision complex column-major matrix.
  // \param lda The total number of elements between two columns of the matrix \f$[0..\infty)\f$.
  // \param info Return code of the function call.
  // \return void
  //
  // This function performs the dense matrix Cholesky decomposition of a symmetric positive
  // definite single precision complex column-major matrix based on the LAPACK cpotrf() function.
  // The decomposition has the form
  
                        \f[ A = U^{H} U \texttt{ (if uplo = 'U'), or }
                            A = L L^{H} \texttt{ (if uplo = 'L'), } \f]
  
  // where \c U is an upper triangular matrix and \c L is a lower triangular matrix. The resulting
  // decomposition is stored within \a A: In case \a uplo is set to \c 'L' the result is stored in
  // the lower part of the matrix and the upper part remains untouched, in case \a uplo is set to
  // \c 'U' the result is stored in the upper part and the lower part remains untouched.
  //
  // The \a info argument provides feedback on the success of the function call:
  //
  //   - = 0: The decomposition finished successfully.
  //   - < 0: If info = -i, the i-th argument had an illegal value.
  //   - > 0: If info = i, the leading minor of order i is not positive definite.
  //
  // For more information on the cpotrf() function, see the LAPACK online documentation browser:
  //
  //        http://www.netlib.org/lapack/explore-html/
  //
  // \note This function can only be used if the fitting LAPACK library is available and linked to
  // the executable. Otherwise a call to this function will result in a linker error.
  */
  inline void potrf( char uplo, int n, complex<float>* A, int lda, int* info )
  {
     BLAZE_STATIC_ASSERT( sizeof( complex<float> ) == 2UL*sizeof( float ) );
  
     cpotrf_( &uplo, &n, reinterpret_cast<float*>( A ), &lda, info );
  }
  //*************************************************************************************************
  
  
  //*************************************************************************************************
  /*!\brief LAPACK kernel for the Cholesky decomposition of the given dense positive definite
  //        double precision complex column-major matrix.
  // \ingroup lapack_decomposition
  //
  // \param uplo \c 'L' to use the lower part of the matrix, \c 'U' to use the upper part.
  // \param n The number of rows/columns of the matrix \f$[0..\infty)\f$.
  // \param A Pointer to the first element of the double precision complex column-major matrix.
  // \param lda The total number of elements between two columns of the matrix \f$[0..\infty)\f$.
  // \param info Return code of the function call.
  // \return void
  //
  // This function performs the dense matrix Cholesky decomposition of a symmetric positive
  // definite double precision complex column-major matrix based on the LAPACK zpotrf() function.
  // The decomposition has the form
  
                        \f[ A = U^{H} U \texttt{ (if uplo = 'U'), or }
                            A = L L^{H} \texttt{ (if uplo = 'L'), } \f]
  
  // where \c U is an upper triangular matrix and \c L is a lower triangular matrix. The resulting
  // decomposition is stored within \a A: In case \a uplo is set to \c 'L' the result is stored in
  // the lower part of the matrix and the upper part remains untouched, in case \a uplo is set to
  // \c 'U' the result is stored in the upper part and the lower part remains untouched.
  //
  // The \a info argument provides feedback on the success of the function call:
  //
  //   - = 0: The decomposition finished successfully.
  //   - < 0: If info = -i, the i-th argument had an illegal value.
  //   - > 0: If info = i, the leading minor of order i is not positive definite.
  //
  // For more information on the zpotrf() function, see the LAPACK online documentation browser:
  //
  //        http://www.netlib.org/lapack/explore-html/
  //
  // \note This function can only be used if the fitting LAPACK library is available and linked to
  // the executable. Otherwise a call to this function will result in a linker error.
  */
  inline void potrf( char uplo, int n, complex<double>* A, int lda, int* info )
  {
     BLAZE_STATIC_ASSERT( sizeof( complex<double> ) == 2UL*sizeof( double ) );
  
     zpotrf_( &uplo, &n, reinterpret_cast<double*>( A ), &lda, info );
  }
  //*************************************************************************************************
  
  } // namespace blaze
  
  #endif
  