potrf.h
Go to the documentation of this file.
1 //=================================================================================================
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_LAPACK_POTRF_H_
36 #define _BLAZE_MATH_LAPACK_POTRF_H_
37 
38 
39 //*************************************************************************************************
40 // Includes
41 //*************************************************************************************************
42 
43 #include <boost/cast.hpp>
44 #include <blaze/math/Aliases.h>
49 #include <blaze/math/Exception.h>
53 #include <blaze/util/Assert.h>
54 
55 
56 namespace blaze {
57 
58 //=================================================================================================
59 //
60 // LAPACK LLH (CHOLESKY) DECOMPOSITION FUNCTIONS (POTRF)
61 //
62 //=================================================================================================
63 
64 //*************************************************************************************************
67 template< typename MT, bool SO >
68 inline void potrf( DenseMatrix<MT,SO>& A, char uplo );
70 //*************************************************************************************************
71 
72 
73 //*************************************************************************************************
114 template< typename MT // Type of the dense matrix
115  , bool SO > // Storage order of the dense matrix
116 inline void potrf( DenseMatrix<MT,SO>& A, char uplo )
117 {
118  using boost::numeric_cast;
119 
124 
125  if( !isSquare( ~A ) ) {
126  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
127  }
128 
129  if( uplo != 'L' && uplo != 'U' ) {
130  BLAZE_THROW_INVALID_ARGUMENT( "Invalid uplo argument provided" );
131  }
132 
133  int n ( numeric_cast<int>( (~A).rows() ) );
134  int lda ( numeric_cast<int>( (~A).spacing() ) );
135  int info( 0 );
136 
137  if( n == 0 ) {
138  return;
139  }
140 
142  ( uplo == 'L' )?( uplo = 'U' ):( uplo = 'L' );
143  }
144 
145  potrf( uplo, n, (~A).data(), lda, &info );
146 
147  BLAZE_INTERNAL_ASSERT( info >= 0, "Invalid argument for Cholesky decomposition" );
148 
149  if( info > 0 ) {
150  BLAZE_THROW_LAPACK_ERROR( "Decomposition of non-positive-definite matrix failed" );
151  }
152 }
153 //*************************************************************************************************
154 
155 } // namespace blaze
156 
157 #endif
#define BLAZE_THROW_INVALID_ARGUMENT(MESSAGE)
Macro for the emission of a std::invalid_argument exception.This macro encapsulates the default way o...
Definition: Exception.h:235
Constraint on the data type.
Header file for auxiliary alias declarations.
Log level for high-level information.
Definition: LogLevel.h:80
#define BLAZE_CONSTRAINT_MUST_HAVE_MUTABLE_DATA_ACCESS(T)
Constraint on the data type.In case the given data type T does not provide low-level data access to m...
Definition: MutableDataAccess.h:61
#define BLAZE_CONSTRAINT_MUST_NOT_BE_COMPUTATION_TYPE(T)
Constraint on the data type.In case the given data type T is a computational expression (i...
Definition: Computation.h:81
Header file for the CLAPACK potrf wrapper functions.
Constraint on the data type.
#define BLAZE_CONSTRAINT_MUST_NOT_BE_ADAPTOR_TYPE(T)
Constraint on the data type.In case the given data type T is an adaptor type (as for instance LowerMa...
Definition: Adaptor.h:81
Base class for dense matrices.The DenseMatrix class is a base class for all dense matrix classes...
Definition: DenseMatrix.h:70
constexpr bool spacing
Adding an additional spacing line between two log messages.This setting gives the opportunity to add ...
Definition: Logging.h:70
Constraint on the data type.
Namespace of the Blaze C++ math library.
Definition: Blaze.h:57
Compile time check for row-major matrix types.This type trait tests whether or not the given template...
Definition: IsRowMajorMatrix.h:83
Header file for the DenseMatrix base class.
typename T::ElementType ElementType_
Alias declaration for nested ElementType type definitions.The ElementType_ alias declaration provides...
Definition: Aliases.h:163
Header file for the exception macros of the math module.
Constraint on the data type.
Header file for run time assertion macros.
#define BLAZE_CONSTRAINT_MUST_BE_BLAS_COMPATIBLE_TYPE(T)
Constraint on the data type.In case the given data type T is not a BLAS compatible data type (i...
Definition: BLASCompatible.h:61
BLAZE_ALWAYS_INLINE size_t rows(const Matrix< MT, SO > &matrix) noexcept
Returns the current number of rows of the matrix.
Definition: Matrix.h:314
Header file for the IsRowMajorMatrix type trait.
#define BLAZE_THROW_LAPACK_ERROR(MESSAGE)
Macro for the emission of an exception on detection of a LAPACK error.This macro encapsulates the def...
Definition: Exception.h:146
void potrf(char uplo, int n, float *A, int lda, int *info)
LAPACK kernel for the Cholesky decomposition of the given dense positive definite single precision co...
Definition: potrf.h:128
BLAZE_ALWAYS_INLINE bool isSquare(const Matrix< MT, SO > &matrix) noexcept
Checks if the given matrix is a square matrix.
Definition: Matrix.h:609
#define BLAZE_INTERNAL_ASSERT(expr, msg)
Run time assertion macro for internal checks.In case of an invalid run time expression, the program execution is terminated. The BLAZE_INTERNAL_ASSERT macro can be disabled by setting the BLAZE_USER_ASSERTION flag to zero or by defining NDEBUG during the compilation.
Definition: Assert.h:101