hetri.h
Go to the documentation of this file.
1 //=================================================================================================
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_LAPACK_HETRI_H_
36 #define _BLAZE_MATH_LAPACK_HETRI_H_
37 
38 
39 //*************************************************************************************************
40 // Includes
41 //*************************************************************************************************
42 
43 #include <memory>
44 #include <blaze/math/Aliases.h>
49 #include <blaze/math/Exception.h>
53 #include <blaze/util/Assert.h>
54 #include <blaze/util/NumericCast.h>
55 
56 
57 
58 namespace blaze {
59 
60 //=================================================================================================
61 //
62 // LAPACK LDLH-BASED INVERSION FUNCTIONS (HETRI)
63 //
64 //=================================================================================================
65 
66 //*************************************************************************************************
69 template< typename MT, bool SO >
70 inline void hetri( DenseMatrix<MT,SO>& A, char uplo, const int* ipiv );
72 //*************************************************************************************************
73 
74 
75 //*************************************************************************************************
113 template< typename MT // Type of the dense matrix
114  , bool SO > // Storage order of the dense matrix
115 inline void hetri( DenseMatrix<MT,SO>& A, char uplo, const int* ipiv )
116 {
121 
122  using ET = ElementType_<MT>;
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).columns() ) );
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  const std::unique_ptr<ET[]> work( new ET[n] );
145 
146  hetri( uplo, n, (~A).data(), lda, ipiv, work.get(), &info );
147 
148  BLAZE_INTERNAL_ASSERT( info >= 0, "Invalid argument for matrix inversion" );
149 
150  if( info > 0 ) {
151  BLAZE_THROW_LAPACK_ERROR( "Inversion of singular matrix failed" );
152  }
153 }
154 //*************************************************************************************************
155 
156 } // namespace blaze
157 
158 #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.
void hetri(char uplo, int n, complex< float > *A, int lda, const int *ipiv, complex< float > *work, int *info)
LAPACK kernel for the inversion of the given dense Hermitian indefinite single precision complex colu...
Definition: hetri.h:121
#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
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:78
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:110
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: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
BLAZE_ALWAYS_INLINE size_t columns(const Matrix< MT, SO > &matrix) noexcept
Returns the current number of columns of the matrix.
Definition: Matrix.h:340
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
Header file for the IsRowMajorMatrix type trait.
Header file for the CLAPACK hetri wrapper functions.
#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
BLAZE_ALWAYS_INLINE bool isSquare(const Matrix< MT, SO > &matrix) noexcept
Checks if the given matrix is a square matrix.
Definition: Matrix.h:742
#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