heevd.h
Go to the documentation of this file.
1 //=================================================================================================
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_LAPACK_HEEVD_H_
36 #define _BLAZE_MATH_LAPACK_HEEVD_H_
37 
38 
39 //*************************************************************************************************
40 // Includes
41 //*************************************************************************************************
42 
43 #include <memory>
44 #include <blaze/math/Aliases.h>
50 #include <blaze/math/Exception.h>
55 #include <blaze/util/Assert.h>
57 #include <blaze/util/NumericCast.h>
58 
59 
60 namespace blaze {
61 
62 //=================================================================================================
63 //
64 // LAPACK HERMITIAN MATRIX EIGENVALUE FUNCTIONS (HEEVD)
65 //
66 //=================================================================================================
67 
68 //*************************************************************************************************
71 template< typename MT, bool SO, typename VT, bool TF >
72 inline void heevd( DenseMatrix<MT,SO>& A, DenseVector<VT,TF>& w, char jobz, char uplo );
74 //*************************************************************************************************
75 
76 
77 //*************************************************************************************************
136 template< typename MT // Type of the matrix A
137  , bool SO // Storage order of the matrix A
138  , typename VT // Type of the vector w
139  , bool TF > // Transpose flag of the vector w
140 inline void heevd( DenseMatrix<MT,SO>& A, DenseVector<VT,TF>& w, char jobz, char uplo )
141 {
148 
154 
155  using CT = ElementType_t<MT>;
156  using BT = UnderlyingElement_t<CT>;
157 
158  if( !isSquare( ~A ) ) {
159  BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
160  }
161 
162  if( jobz != 'V' && jobz != 'N' ) {
163  BLAZE_THROW_INVALID_ARGUMENT( "Invalid jobz argument provided" );
164  }
165 
166  if( uplo != 'L' && uplo != 'U' ) {
167  BLAZE_THROW_INVALID_ARGUMENT( "Invalid uplo argument provided" );
168  }
169 
170  resize( ~w, (~A).rows(), false );
171 
172  int n ( numeric_cast<int>( (~A).rows() ) );
173  int lda ( numeric_cast<int>( (~A).spacing() ) );
174  int info( 0 );
175 
176  if( n == 0 ) {
177  return;
178  }
179 
180  int lwork( n*n + 2*n + 2 );
181  const std::unique_ptr<CT[]> work( new CT[lwork] );
182 
183  int lrwork( 1 + 5*n + 2*n*n );
184  const std::unique_ptr<BT[]> rwork( new BT[lrwork] );
185 
186  int liwork( 3 + 5*n );
187  const std::unique_ptr<int[]> iwork( new int[liwork] );
188 
189  if( IsRowMajorMatrix_v<MT> ) {
190  ( uplo == 'L' )?( uplo = 'U' ):( uplo = 'L' );
191  }
192 
193  heevd( jobz, uplo, n, (~A).data(), lda, (~w).data(),
194  work.get(), lwork, rwork.get(), lrwork, iwork.get(), liwork, &info );
195 
196  BLAZE_INTERNAL_ASSERT( info >= 0, "Invalid argument for eigenvalue computation" );
197 
198  if( info > 0 ) {
199  BLAZE_THROW_LAPACK_ERROR( "Eigenvalue computation failed" );
200  }
201 }
202 //*************************************************************************************************
203 
204 } // namespace blaze
205 
206 #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
MT::ElementType * data(DenseMatrix< MT, SO > &dm) noexcept
Low-level data access to the dense matrix elements.
Definition: DenseMatrix.h:169
#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.
Header file for the DenseVector base class.
Constraint on the data type.
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
typename T::ElementType ElementType_t
Alias declaration for nested ElementType type definitions.The ElementType_t alias declaration provide...
Definition: Aliases.h:170
size_t spacing(const DenseMatrix< MT, SO > &dm) noexcept
Returns the spacing between the beginning of two rows/columns.
Definition: DenseMatrix.h:252
Header file for the CLAPACK heevd wrapper functions.
Constraint on the data type.
Namespace of the Blaze C++ math library.
Definition: Blaze.h:58
#define BLAZE_CONSTRAINT_MUST_BE_CONTIGUOUS_TYPE(T)
Constraint on the data type.In case the given data type T is not an array-like data type with contigu...
Definition: Contiguous.h:61
Header file for the DenseMatrix base class.
Base class for N-dimensional dense vectors.The DenseVector class is a base class for all arbitrarily ...
Definition: DenseVector.h:76
Header file for the exception macros of the math module.
typename UnderlyingElement< T >::Type UnderlyingElement_t
Auxiliary alias declaration for the UnderlyingElement type trait.The UnderlyingElement_t alias declar...
Definition: UnderlyingElement.h:132
void resize(Matrix< MT, SO > &matrix, size_t rows, size_t columns, bool preserve=true)
Changing the size of the matrix.
Definition: Matrix.h:738
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
constexpr size_t rows(const Matrix< MT, SO > &matrix) noexcept
Returns the current number of rows of the matrix.
Definition: Matrix.h:498
#define BLAZE_CONSTRAINT_MUST_BE_BUILTIN_TYPE(T)
Constraint on the data type.In case the given data type T is not a built-in data type, a compilation error is created.
Definition: Builtin.h:60
#define BLAZE_CONSTRAINT_MUST_BE_COMPLEX_TYPE(T)
Constraint on the data type.This compile time constraint checks that the given data type T is a compl...
Definition: Complex.h:62
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
bool isSquare(const Matrix< MT, SO > &matrix) noexcept
Checks if the given matrix is a square matrix.
Definition: Matrix.h:951
#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