ComplexSchur_LAPACKE.h
Go to the documentation of this file.
1 /*
2  Copyright (c) 2011, Intel Corporation. All rights reserved.
3 
4  Redistribution and use in source and binary forms, with or without modification,
5  are permitted provided that the following conditions are met:
6 
7  * Redistributions of source code must retain the above copyright notice, this
8  list of conditions and the following disclaimer.
9  * Redistributions in binary form must reproduce the above copyright notice,
10  this list of conditions and the following disclaimer in the documentation
11  and/or other materials provided with the distribution.
12  * Neither the name of Intel Corporation nor the names of its contributors may
13  be used to endorse or promote products derived from this software without
14  specific prior written permission.
15 
16  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
17  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
20  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
23  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 
27  ********************************************************************************
28  * Content : Eigen bindings to LAPACKe
29  * Complex Schur needed to complex unsymmetrical eigenvalues/eigenvectors.
30  ********************************************************************************
31 */
32 
33 #ifndef EIGEN_COMPLEX_SCHUR_LAPACKE_H
34 #define EIGEN_COMPLEX_SCHUR_LAPACKE_H
35 
36 // IWYU pragma: private
37 #include "./InternalHeaderCheck.h"
38 
39 namespace Eigen {
40 
43 #define EIGEN_LAPACKE_SCHUR_COMPLEX(EIGTYPE, LAPACKE_TYPE, LAPACKE_PREFIX, LAPACKE_PREFIX_U, EIGCOLROW, \
44  LAPACKE_COLROW) \
45  template <> \
46  template <typename InputType> \
47  inline ComplexSchur<Matrix<EIGTYPE, Dynamic, Dynamic, EIGCOLROW> >& \
48  ComplexSchur<Matrix<EIGTYPE, Dynamic, Dynamic, EIGCOLROW> >::compute(const EigenBase<InputType>& matrix, \
49  bool computeU) { \
50  typedef Matrix<EIGTYPE, Dynamic, Dynamic, EIGCOLROW> MatrixType; \
51  typedef MatrixType::RealScalar RealScalar; \
52  typedef std::complex<RealScalar> ComplexScalar; \
53  \
54  eigen_assert(matrix.cols() == matrix.rows()); \
55  \
56  m_matUisUptodate = false; \
57  if (matrix.cols() == 1) { \
58  m_matT = matrix.derived().template cast<ComplexScalar>(); \
59  if (computeU) m_matU = ComplexMatrixType::Identity(1, 1); \
60  m_info = Success; \
61  m_isInitialized = true; \
62  m_matUisUptodate = computeU; \
63  return *this; \
64  } \
65  lapack_int n = internal::convert_index<lapack_int>(matrix.cols()), sdim, info; \
66  lapack_int matrix_order = LAPACKE_COLROW; \
67  char jobvs, sort = 'N'; \
68  LAPACK_##LAPACKE_PREFIX_U##_SELECT1 select = 0; \
69  jobvs = (computeU) ? 'V' : 'N'; \
70  m_matU.resize(n, n); \
71  lapack_int ldvs = internal::convert_index<lapack_int>(m_matU.outerStride()); \
72  m_matT = matrix; \
73  lapack_int lda = internal::convert_index<lapack_int>(m_matT.outerStride()); \
74  Matrix<EIGTYPE, Dynamic, Dynamic> w; \
75  w.resize(n, 1); \
76  info = LAPACKE_##LAPACKE_PREFIX##gees(matrix_order, jobvs, sort, select, n, (LAPACKE_TYPE*)m_matT.data(), lda, \
77  &sdim, (LAPACKE_TYPE*)w.data(), (LAPACKE_TYPE*)m_matU.data(), ldvs); \
78  if (info == 0) \
79  m_info = Success; \
80  else \
81  m_info = NoConvergence; \
82  \
83  m_isInitialized = true; \
84  m_matUisUptodate = computeU; \
85  return *this; \
86  }
87 
88 EIGEN_LAPACKE_SCHUR_COMPLEX(dcomplex, lapack_complex_double, z, Z, ColMajor, LAPACK_COL_MAJOR)
89 EIGEN_LAPACKE_SCHUR_COMPLEX(scomplex, lapack_complex_float, c, C, ColMajor, LAPACK_COL_MAJOR)
90 EIGEN_LAPACKE_SCHUR_COMPLEX(dcomplex, lapack_complex_double, z, Z, RowMajor, LAPACK_ROW_MAJOR)
91 EIGEN_LAPACKE_SCHUR_COMPLEX(scomplex, lapack_complex_float, c, C, RowMajor, LAPACK_ROW_MAJOR)
92 
93 } // end namespace Eigen
94 
95 #endif // EIGEN_COMPLEX_SCHUR_LAPACKE_H
EIGEN_LAPACKE_SCHUR_COMPLEX
#define EIGEN_LAPACKE_SCHUR_COMPLEX(EIGTYPE, LAPACKE_TYPE, LAPACKE_PREFIX, LAPACKE_PREFIX_U, EIGCOLROW, LAPACKE_COLROW)
Definition: ComplexSchur_LAPACKE.h:43
oomph::Matrix
Definition: matrices.h:74
Eigen::ColMajor
@ ColMajor
Definition: Constants.h:318
Eigen::RowMajor
@ RowMajor
Definition: Constants.h:320
Z
#define Z
Definition: icosphere.cpp:21
LAPACK_COL_MAJOR
#define LAPACK_COL_MAJOR
Definition: lapacke.h:124
LAPACK_ROW_MAJOR
#define LAPACK_ROW_MAJOR
Definition: lapacke.h:123
lapack_complex_double
#define lapack_complex_double
Definition: lapacke.h:94
lapack_complex_float
#define lapack_complex_float
Definition: lapacke.h:79
Eigen
Namespace containing all symbols from the Eigen library.
Definition: bench_norm.cpp:70
Eigen::dcomplex
std::complex< double > dcomplex
Definition: MKL_support.h:128
Eigen::scomplex
std::complex< float > scomplex
Definition: MKL_support.h:129
calibrate.c
int c
Definition: calibrate.py:100