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 <blaze/math/Aliases.h>
48 #include <blaze/math/Exception.h>
52 #include <blaze/util/Assert.h>
53 #include <blaze/util/NumericCast.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 //*************************************************************************************************
115 template< typename MT // Type of the dense matrix
116  , bool SO > // Storage order of the dense matrix
117 inline void potrf( DenseMatrix<MT,SO>& A, char uplo )
118 {
123 
124  if( !isSquare( ~A ) ) {
125  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
126  }
127 
128  if( uplo != 'L' && uplo != 'U' ) {
129  BLAZE_THROW_INVALID_ARGUMENT( "Invalid uplo argument provided" );
130  }
131 
132  int n ( numeric_cast<int>( (~A).rows() ) );
133  int lda ( numeric_cast<int>( (~A).spacing() ) );
134  int info( 0 );
135 
136  if( n == 0 ) {
137  return;
138  }
139 
141  ( uplo == 'L' )?( uplo = 'U' ):( uplo = 'L' );
142  }
143 
144  potrf( uplo, n, (~A).data(), lda, &info );
145 
146  BLAZE_INTERNAL_ASSERT( info >= 0, "Invalid argument for Cholesky decomposition" );
147 
148  if( info > 0 ) {
149  BLAZE_THROW_LAPACK_ERROR( "Decomposition of non-positive-definite matrix failed" );
150  }
151 }
152 //*************************************************************************************************
153 
154 } // namespace blaze
155 
156 #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.
#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.
Cast operators for numeric types.
#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:80
BLAZE_ALWAYS_INLINE size_t spacing(const DenseMatrix< MT, SO > &dm) noexcept
Returns the spacing between the beginning of two rows/columns.
Definition: DenseMatrix.h:252
Constraint on the data type.
Namespace of the Blaze C++ math library.
Definition: Blaze.h:58
Compile time check for row-major matrix types.This type trait tests whether or not the given template...
Definition: IsRowMajorMatrix.h:110
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:490
BLAZE_ALWAYS_INLINE MT::ElementType * data(DenseMatrix< MT, SO > &dm) noexcept
Low-level data access to the dense matrix elements.
Definition: DenseMatrix.h:169
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:131
BLAZE_ALWAYS_INLINE bool isSquare(const Matrix< MT, SO > &matrix) noexcept
Checks if the given matrix is a square matrix.
Definition: Matrix.h:908
#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