Blaze 3.9
heev.h
Go to the documentation of this file.
1//=================================================================================================
33//=================================================================================================
34
35#ifndef _BLAZE_MATH_LAPACK_HEEV_H_
36#define _BLAZE_MATH_LAPACK_HEEV_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 (HEEV)
65//
66//=================================================================================================
67
68//*************************************************************************************************
71template< typename MT, bool SO, typename VT, bool TF >
72void heev( DenseMatrix<MT,SO>& A, DenseVector<VT,TF>& w, char jobz, char uplo );
74//*************************************************************************************************
75
76
77//*************************************************************************************************
135template< typename MT // Type of the matrix A
136 , bool SO // Storage order of the matrix A
137 , typename VT // Type of the vector w
138 , bool TF > // Transpose flag of the vector w
139inline void heev( DenseMatrix<MT,SO>& A, DenseVector<VT,TF>& w, char jobz, char uplo )
140{
147
153
154 using CT = ElementType_t<MT>;
155 using BT = UnderlyingElement_t<CT>;
156
157 if( !isSquare( *A ) ) {
158 BLAZE_THROW_INVALID_ARGUMENT( "Invalid non-square matrix provided" );
159 }
160
161 if( jobz != 'V' && jobz != 'N' ) {
162 BLAZE_THROW_INVALID_ARGUMENT( "Invalid jobz argument provided" );
163 }
164
165 if( uplo != 'L' && uplo != 'U' ) {
166 BLAZE_THROW_INVALID_ARGUMENT( "Invalid uplo argument provided" );
167 }
168
169 resize( *w, (*A).rows(), false );
170
171 blas_int_t n ( numeric_cast<blas_int_t>( (*A).rows() ) );
172 blas_int_t lda ( numeric_cast<blas_int_t>( (*A).spacing() ) );
173 blas_int_t info( 0 );
174
175 if( n == 0 ) {
176 return;
177 }
178
179 blas_int_t lwork( 10*n + 2 );
180 const std::unique_ptr<CT[]> work ( new CT[lwork] );
181 const std::unique_ptr<BT[]> rwork( new BT[3*n-2] );
182
183 if( IsRowMajorMatrix_v<MT> ) {
184 ( uplo == 'L' )?( uplo = 'U' ):( uplo = 'L' );
185 }
186
187 heev( jobz, uplo, n, (*A).data(), lda, (*w).data(), work.get(), lwork, rwork.get(), &info );
188
189 BLAZE_INTERNAL_ASSERT( info >= 0, "Invalid argument for eigenvalue computation" );
190
191 if( info > 0 ) {
192 BLAZE_THROW_LAPACK_ERROR( "Eigenvalue computation failed" );
193 }
194}
195//*************************************************************************************************
196
197} // namespace blaze
198
199#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 heev 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 heev(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: heev.h:139
#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.