Blaze 3.9
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>
53#include <blaze/util/Assert.h>
55
56
57namespace blaze {
58
59//=================================================================================================
60//
61// LAPACK LLH (CHOLESKY) DECOMPOSITION FUNCTIONS (POTRF)
62//
63//=================================================================================================
64
65//*************************************************************************************************
68template< typename MT, bool SO >
69void potrf( DenseMatrix<MT,SO>& A, char uplo );
71//*************************************************************************************************
72
73
74//*************************************************************************************************
116template< typename MT // Type of the dense matrix
117 , bool SO > // Storage order of the dense matrix
118inline void potrf( DenseMatrix<MT,SO>& A, char uplo )
119{
125
126 if( !isSquare( *A ) ) {
127 BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
128 }
129
130 if( uplo != 'L' && uplo != 'U' ) {
131 BLAZE_THROW_INVALID_ARGUMENT( "Invalid uplo argument provided" );
132 }
133
134 blas_int_t n ( numeric_cast<blas_int_t>( (*A).rows() ) );
135 blas_int_t lda ( numeric_cast<blas_int_t>( (*A).spacing() ) );
136 blas_int_t info( 0 );
137
138 if( n == 0 ) {
139 return;
140 }
141
142 if( IsRowMajorMatrix_v<MT> ) {
143 ( uplo == 'L' )?( uplo = 'U' ):( uplo = 'L' );
144 }
145
146 potrf( uplo, n, (*A).data(), lda, &info );
147
148 BLAZE_INTERNAL_ASSERT( info >= 0, "Invalid argument for Cholesky decomposition" );
149
150 if( info > 0 ) {
151 BLAZE_THROW_LAPACK_ERROR( "Decomposition of non-positive-definite matrix failed" );
152 }
153}
154//*************************************************************************************************
155
156} // namespace blaze
157
158#endif
Constraint on the data type.
Header file for auxiliary alias declarations.
typename T::ElementType ElementType_t
Alias declaration for nested ElementType type definitions.
Definition: Aliases.h:190
Header file for run time assertion macros.
Constraint on the data type.
Constraint on the data type.
Header file for the IsRowMajorMatrix type trait.
Constraint on the data type.
Cast operators for numeric types.
Header file for the CLAPACK potrf wrapper functions.
Base class for dense matrices.
Definition: DenseMatrix.h:82
Constraint on the data type.
Header file for the DenseMatrix base class.
void potrf(DenseMatrix< MT, SO > &A, char uplo)
LAPACK kernel for the Cholesky decomposition of the given dense positive definite matrix.
Definition: potrf.h:118
#define BLAZE_CONSTRAINT_MUST_BE_BLAS_COMPATIBLE_TYPE(T)
Constraint on the data type.
Definition: BLASCompatible.h:61
#define BLAZE_CONSTRAINT_MUST_BE_CONTIGUOUS_TYPE(T)
Constraint on the data type.
Definition: Contiguous.h:61
#define BLAZE_CONSTRAINT_MUST_NOT_BE_COMPUTATION_TYPE(T)
Constraint on the data type.
Definition: Computation.h:81
#define BLAZE_CONSTRAINT_MUST_NOT_BE_ADAPTOR_TYPE(T)
Constraint on the data type.
Definition: Adaptor.h:81
#define BLAZE_CONSTRAINT_MUST_HAVE_MUTABLE_DATA_ACCESS(T)
Constraint on the data type.
Definition: MutableDataAccess.h:61
int32_t blas_int_t
Signed integer type used in the BLAS/LAPACK wrapper functions.
Definition: Types.h:64
#define BLAZE_THROW_LAPACK_ERROR(MESSAGE)
Macro for the emission of an exception on detection of a LAPACK error.
Definition: Exception.h:146
bool isSquare(const Matrix< MT, SO > &matrix) noexcept
Checks if the given matrix is a square matrix.
Definition: Matrix.h:1383
#define BLAZE_INTERNAL_ASSERT(expr, msg)
Run time assertion macro for internal checks.
Definition: Assert.h:101
#define BLAZE_THROW_INVALID_ARGUMENT(MESSAGE)
Macro for the emission of a std::invalid_argument exception.
Definition: Exception.h:235
Header file for the exception macros of the math module.