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 <boost/cast.hpp>
50 #include <blaze/util/Assert.h>
51 #include <blaze/util/Complex.h>
52 #include <blaze/util/Exception.h>
54 #include <blaze/util/UniqueArray.h>
55 
56 
57 namespace blaze {
58 
59 //=================================================================================================
60 //
61 // LAPACK FORWARD DECLARATIONS
62 //
63 //=================================================================================================
64 
65 //*************************************************************************************************
67 extern "C" {
68 
69 void chetri_( char* uplo, int* n, float* A, int* lda, int* ipiv, float* work, int* info );
70 void zhetri_( char* uplo, int* n, double* A, int* lda, int* ipiv, double* work, int* info );
71 
72 }
74 //*************************************************************************************************
75 
76 
77 
78 
79 //=================================================================================================
80 //
81 // LAPACK LDLH-BASED INVERSION FUNCTIONS (HETRI)
82 //
83 //=================================================================================================
84 
85 //*************************************************************************************************
88 inline void hetri( char uplo, int n, complex<float>* A, int lda,
89  const int* ipiv, complex<float>* work, int* info );
90 
91 inline void hetri( char uplo, int n, complex<double>* A, int lda,
92  const int* ipiv, complex<double>* work, int* info );
93 
94 template< typename MT, bool SO >
95 inline void hetri( DenseMatrix<MT,SO>& A, char uplo, const int* ipiv );
97 //*************************************************************************************************
98 
99 
100 //*************************************************************************************************
131 inline void hetri( char uplo, int n, complex<float>* A, int lda,
132  const int* ipiv, complex<float>* work, int* info )
133 {
134  BLAZE_STATIC_ASSERT( sizeof( complex<float> ) == 2UL*sizeof( float ) );
135 
136  chetri_( &uplo, &n, reinterpret_cast<float*>( A ), &lda,
137  const_cast<int*>( ipiv ), reinterpret_cast<float*>( work ), info );
138 }
139 //*************************************************************************************************
140 
141 
142 //*************************************************************************************************
173 inline void hetri( char uplo, int n, complex<double>* A, int lda,
174  const int* ipiv, complex<double>* work, int* info )
175 {
176  BLAZE_STATIC_ASSERT( sizeof( complex<double> ) == 2UL*sizeof( double ) );
177 
178  zhetri_( &uplo, &n, reinterpret_cast<double*>( A ), &lda,
179  const_cast<int*>( ipiv ), reinterpret_cast<double*>( work ), info );
180 }
181 //*************************************************************************************************
182 
183 
184 //*************************************************************************************************
221 template< typename MT // Type of the dense matrix
222  , bool SO > // Storage order of the dense matrix
223 inline void hetri( DenseMatrix<MT,SO>& A, char uplo, const int* ipiv )
224 {
225  using boost::numeric_cast;
226 
231 
232  typedef typename MT::ElementType ET;
233 
234  if( !isSquare( ~A ) ) {
235  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
236  }
237 
238  if( uplo != 'L' && uplo != 'U' ) {
239  BLAZE_THROW_INVALID_ARGUMENT( "Invalid uplo argument provided" );
240  }
241 
242  int n ( numeric_cast<int>( (~A).columns() ) );
243  int lda ( numeric_cast<int>( (~A).spacing() ) );
244  int info( 0 );
245 
246  if( n == 0 ) {
247  return;
248  }
249 
251  ( uplo == 'L' )?( uplo = 'U' ):( uplo = 'L' );
252  }
253 
254  const UniqueArray<ET> work( new ET[n] );
255 
256  hetri( uplo, n, (~A).data(), lda, ipiv, work.get(), &info );
257 
258  BLAZE_INTERNAL_ASSERT( info >= 0, "Invalid argument for matrix inversion" );
259 
260  if( info > 0 ) {
261  BLAZE_THROW_INVALID_ARGUMENT( "Inversion of singular matrix failed" );
262  }
263 }
264 //*************************************************************************************************
265 
266 } // namespace blaze
267 
268 #endif
#define BLAZE_THROW_INVALID_ARGUMENT(MESSAGE)
Macro for the emission of a std::invalid_argument exceptionThis macro encapsulates the default way of...
Definition: Exception.h:187
Constraint on the data type.
Log level for high-level information.
Definition: LogLevel.h:80
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:131
#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:79
BLAZE_ALWAYS_INLINE bool isSquare(const Matrix< MT, SO > &matrix)
Checks if the given matrix is a square matrix.
Definition: Matrix.h:603
#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:118
Pointer get() const
Returns a pointer to the managed array.
Definition: UniqueArray.h:245
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:118
Base class for dense matrices.The DenseMatrix class is a base class for all dense matrix classes...
Definition: DenseMatrix.h:70
Namespace of the Blaze C++ math library.
Definition: Blaze.h:57
Compile time assertion.
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.
Type ElementType
Type of the sparse matrix elements.
Definition: CompressedMatrix.h:2586
Constraint on the data type.
Constraint on the data type.
const bool spacing
Adding an additional spacing line between two log messages.This setting gives the opportunity to add ...
Definition: Logging.h:70
Header file for run time assertion macros.
Header file for the UniqueArray smart pointer class.
#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:79
Header file for the IsRowMajorMatrix type trait.
BLAZE_ALWAYS_INLINE size_t columns(const Matrix< MT, SO > &matrix)
Returns the current number of columns of the matrix.
Definition: Matrix.h:324
Header file for the complex data type.
Header file for exception macros.
#define BLAZE_STATIC_ASSERT(expr)
Compile time assertion macro.In case of an invalid compile time expression, a compilation error is cr...
Definition: StaticAssert.h:143
Scope-limited management of dynamically allocated arrays.The UniqueArray class implements a scope-res...
Definition: UniqueArray.h:97
#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