Blaze 3.9
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>
55#include <blaze/util/Assert.h>
58
59
60namespace blaze {
61
62//=================================================================================================
63//
64// LAPACK HERMITIAN MATRIX EIGENVALUE FUNCTIONS (HEEVD)
65//
66//=================================================================================================
67
68//*************************************************************************************************
71template< typename MT, bool SO, typename VT, bool TF >
72void heevd( DenseMatrix<MT,SO>& A, DenseVector<VT,TF>& w, char jobz, char uplo );
74//*************************************************************************************************
75
76
77//*************************************************************************************************
136template< 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
140inline 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 blas_int_t n ( numeric_cast<blas_int_t>( (*A).rows() ) );
173 blas_int_t lda ( numeric_cast<blas_int_t>( (*A).spacing() ) );
174 blas_int_t info( 0 );
175
176 if( n == 0 ) {
177 return;
178 }
179
180 blas_int_t lwork( n*n + 2*n + 2 );
181 const std::unique_ptr<CT[]> work( new CT[lwork] );
182
183 blas_int_t lrwork( 1 + 5*n + 2*n*n );
184 const std::unique_ptr<BT[]> rwork( new BT[lrwork] );
185
186 blas_int_t liwork( 3 + 5*n );
187 const std::unique_ptr<blas_int_t[]> iwork( new blas_int_t[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
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 heevd wrapper functions.
Base class for dense matrices.
Definition: DenseMatrix.h:82
Base class for N-dimensional dense vectors.
Definition: DenseVector.h:77
Constraint on the data type.
Constraint on the data type.
Header file for the DenseMatrix base class.
Header file for the DenseVector base class.
#define BLAZE_CONSTRAINT_MUST_BE_BUILTIN_TYPE(T)
Constraint on the data type.
Definition: Builtin.h:60
#define BLAZE_CONSTRAINT_MUST_BE_COMPLEX_TYPE(T)
Constraint on the data type.
Definition: Complex.h:62
void heevd(DenseMatrix< MT, SO > &A, DenseVector< VT, TF > &w, char jobz, char uplo)
LAPACK kernel for computing the eigenvalues of the given dense Hermitian matrix.
Definition: heevd.h:140
#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
typename UnderlyingElement< T >::Type UnderlyingElement_t
Auxiliary alias declaration for the UnderlyingElement type trait.
Definition: UnderlyingElement.h:119
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
void resize(Matrix< MT, SO > &matrix, size_t rows, size_t columns, bool preserve=true)
Changing the size of the matrix.
Definition: Matrix.h:1108
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.