xref: /aosp_15_r20/external/eigen/Eigen/src/Eigenvalues/SelfAdjointEigenSolver_LAPACKE.h (revision bf2c37156dfe67e5dfebd6d394bad8b2ab5804d4)
1*bf2c3715SXin Li /*
2*bf2c3715SXin Li  Copyright (c) 2011, Intel Corporation. All rights reserved.
3*bf2c3715SXin Li 
4*bf2c3715SXin Li  Redistribution and use in source and binary forms, with or without modification,
5*bf2c3715SXin Li  are permitted provided that the following conditions are met:
6*bf2c3715SXin Li 
7*bf2c3715SXin Li  * Redistributions of source code must retain the above copyright notice, this
8*bf2c3715SXin Li    list of conditions and the following disclaimer.
9*bf2c3715SXin Li  * Redistributions in binary form must reproduce the above copyright notice,
10*bf2c3715SXin Li    this list of conditions and the following disclaimer in the documentation
11*bf2c3715SXin Li    and/or other materials provided with the distribution.
12*bf2c3715SXin Li  * Neither the name of Intel Corporation nor the names of its contributors may
13*bf2c3715SXin Li    be used to endorse or promote products derived from this software without
14*bf2c3715SXin Li    specific prior written permission.
15*bf2c3715SXin Li 
16*bf2c3715SXin Li  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
17*bf2c3715SXin Li  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18*bf2c3715SXin Li  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19*bf2c3715SXin Li  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
20*bf2c3715SXin Li  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21*bf2c3715SXin Li  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22*bf2c3715SXin Li  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
23*bf2c3715SXin Li  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24*bf2c3715SXin Li  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25*bf2c3715SXin Li  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26*bf2c3715SXin Li 
27*bf2c3715SXin Li  ********************************************************************************
28*bf2c3715SXin Li  *   Content : Eigen bindings to LAPACKe
29*bf2c3715SXin Li  *    Self-adjoint eigenvalues/eigenvectors.
30*bf2c3715SXin Li  ********************************************************************************
31*bf2c3715SXin Li */
32*bf2c3715SXin Li 
33*bf2c3715SXin Li #ifndef EIGEN_SAEIGENSOLVER_LAPACKE_H
34*bf2c3715SXin Li #define EIGEN_SAEIGENSOLVER_LAPACKE_H
35*bf2c3715SXin Li 
36*bf2c3715SXin Li namespace Eigen {
37*bf2c3715SXin Li 
38*bf2c3715SXin Li /** \internal Specialization for the data types supported by LAPACKe */
39*bf2c3715SXin Li 
40*bf2c3715SXin Li #define EIGEN_LAPACKE_EIG_SELFADJ_2(EIGTYPE, LAPACKE_TYPE, LAPACKE_RTYPE, LAPACKE_NAME, EIGCOLROW ) \
41*bf2c3715SXin Li template<> template<typename InputType> inline \
42*bf2c3715SXin Li SelfAdjointEigenSolver<Matrix<EIGTYPE, Dynamic, Dynamic, EIGCOLROW> >& \
43*bf2c3715SXin Li SelfAdjointEigenSolver<Matrix<EIGTYPE, Dynamic, Dynamic, EIGCOLROW> >::compute(const EigenBase<InputType>& matrix, int options) \
44*bf2c3715SXin Li { \
45*bf2c3715SXin Li   eigen_assert(matrix.cols() == matrix.rows()); \
46*bf2c3715SXin Li   eigen_assert((options&~(EigVecMask|GenEigMask))==0 \
47*bf2c3715SXin Li           && (options&EigVecMask)!=EigVecMask \
48*bf2c3715SXin Li           && "invalid option parameter"); \
49*bf2c3715SXin Li   bool computeEigenvectors = (options&ComputeEigenvectors)==ComputeEigenvectors; \
50*bf2c3715SXin Li   lapack_int n = internal::convert_index<lapack_int>(matrix.cols()), lda, info; \
51*bf2c3715SXin Li   m_eivalues.resize(n,1); \
52*bf2c3715SXin Li   m_subdiag.resize(n-1); \
53*bf2c3715SXin Li   m_eivec = matrix; \
54*bf2c3715SXin Li \
55*bf2c3715SXin Li   if(n==1) \
56*bf2c3715SXin Li   { \
57*bf2c3715SXin Li     m_eivalues.coeffRef(0,0) = numext::real(m_eivec.coeff(0,0)); \
58*bf2c3715SXin Li     if(computeEigenvectors) m_eivec.setOnes(n,n); \
59*bf2c3715SXin Li     m_info = Success; \
60*bf2c3715SXin Li     m_isInitialized = true; \
61*bf2c3715SXin Li     m_eigenvectorsOk = computeEigenvectors; \
62*bf2c3715SXin Li     return *this; \
63*bf2c3715SXin Li   } \
64*bf2c3715SXin Li \
65*bf2c3715SXin Li   lda = internal::convert_index<lapack_int>(m_eivec.outerStride()); \
66*bf2c3715SXin Li   char jobz, uplo='L'/*, range='A'*/; \
67*bf2c3715SXin Li   jobz = computeEigenvectors ? 'V' : 'N'; \
68*bf2c3715SXin Li \
69*bf2c3715SXin Li   info = LAPACKE_##LAPACKE_NAME( LAPACK_COL_MAJOR, jobz, uplo, n, (LAPACKE_TYPE*)m_eivec.data(), lda, (LAPACKE_RTYPE*)m_eivalues.data() ); \
70*bf2c3715SXin Li   m_info = (info==0) ? Success : NoConvergence; \
71*bf2c3715SXin Li   m_isInitialized = true; \
72*bf2c3715SXin Li   m_eigenvectorsOk = computeEigenvectors; \
73*bf2c3715SXin Li   return *this; \
74*bf2c3715SXin Li }
75*bf2c3715SXin Li 
76*bf2c3715SXin Li #define EIGEN_LAPACKE_EIG_SELFADJ(EIGTYPE, LAPACKE_TYPE, LAPACKE_RTYPE, LAPACKE_NAME )              \
77*bf2c3715SXin Li         EIGEN_LAPACKE_EIG_SELFADJ_2(EIGTYPE, LAPACKE_TYPE, LAPACKE_RTYPE, LAPACKE_NAME, ColMajor )  \
78*bf2c3715SXin Li         EIGEN_LAPACKE_EIG_SELFADJ_2(EIGTYPE, LAPACKE_TYPE, LAPACKE_RTYPE, LAPACKE_NAME, RowMajor )
79*bf2c3715SXin Li 
80*bf2c3715SXin Li EIGEN_LAPACKE_EIG_SELFADJ(double,   double,                double, dsyev)
81*bf2c3715SXin Li EIGEN_LAPACKE_EIG_SELFADJ(float,    float,                 float,  ssyev)
82*bf2c3715SXin Li EIGEN_LAPACKE_EIG_SELFADJ(dcomplex, lapack_complex_double, double, zheev)
83*bf2c3715SXin Li EIGEN_LAPACKE_EIG_SELFADJ(scomplex, lapack_complex_float,  float,  cheev)
84*bf2c3715SXin Li 
85*bf2c3715SXin Li } // end namespace Eigen
86*bf2c3715SXin Li 
87*bf2c3715SXin Li #endif // EIGEN_SAEIGENSOLVER_H
88