Public Member Functions | Private Types | Private Attributes | List of all members
Spectra::DenseGenComplexShiftSolve< Scalar > Class Template Reference

#include <DenseGenComplexShiftSolve.h>

Public Member Functions

Index cols () const
 
 DenseGenComplexShiftSolve (ConstGenericMatrix &mat)
 
void perform_op (const Scalar *x_in, Scalar *y_out)
 
Index rows () const
 
void set_shift (Scalar sigmar, Scalar sigmai)
 

Private Types

typedef std::complex< ScalarComplex
 
typedef Eigen::Matrix< Complex, Eigen::Dynamic, Eigen::DynamicComplexMatrix
 
typedef Eigen::PartialPivLU< ComplexMatrixComplexSolver
 
typedef Eigen::Matrix< Complex, Eigen::Dynamic, 1 > ComplexVector
 
typedef const Eigen::Ref< const MatrixConstGenericMatrix
 
typedef Eigen::Index Index
 
typedef Eigen::Map< const VectorMapConstVec
 
typedef Eigen::Map< VectorMapVec
 
typedef Eigen::Matrix< Scalar, Eigen::Dynamic, Eigen::DynamicMatrix
 
typedef Eigen::Matrix< Scalar, Eigen::Dynamic, 1 > Vector
 

Private Attributes

ConstGenericMatrix m_mat
 
const Index m_n
 
ComplexSolver m_solver
 
ComplexVector m_x_cache
 

Detailed Description

template<typename Scalar>
class Spectra::DenseGenComplexShiftSolve< Scalar >

This class defines the complex shift-solve operation on a general real matrix $A$, i.e., calculating $y=\mathrm{Re}\{(A-\sigma I)^{-1}x\}$ for any complex-valued $\sigma$ and real-valued vector $x$. It is mainly used in the GenEigsComplexShiftSolver eigen solver.

Definition at line 25 of file DenseGenComplexShiftSolve.h.

Member Typedef Documentation

◆ Complex

template<typename Scalar >
typedef std::complex<Scalar> Spectra::DenseGenComplexShiftSolve< Scalar >::Complex
private

Definition at line 35 of file DenseGenComplexShiftSolve.h.

◆ ComplexMatrix

Definition at line 36 of file DenseGenComplexShiftSolve.h.

◆ ComplexSolver

Definition at line 39 of file DenseGenComplexShiftSolve.h.

◆ ComplexVector

template<typename Scalar >
typedef Eigen::Matrix<Complex, Eigen::Dynamic, 1> Spectra::DenseGenComplexShiftSolve< Scalar >::ComplexVector
private

Definition at line 37 of file DenseGenComplexShiftSolve.h.

◆ ConstGenericMatrix

template<typename Scalar >
typedef const Eigen::Ref<const Matrix> Spectra::DenseGenComplexShiftSolve< Scalar >::ConstGenericMatrix
private

Definition at line 33 of file DenseGenComplexShiftSolve.h.

◆ Index

template<typename Scalar >
typedef Eigen::Index Spectra::DenseGenComplexShiftSolve< Scalar >::Index
private

Definition at line 28 of file DenseGenComplexShiftSolve.h.

◆ MapConstVec

template<typename Scalar >
typedef Eigen::Map<const Vector> Spectra::DenseGenComplexShiftSolve< Scalar >::MapConstVec
private

Definition at line 31 of file DenseGenComplexShiftSolve.h.

◆ MapVec

template<typename Scalar >
typedef Eigen::Map<Vector> Spectra::DenseGenComplexShiftSolve< Scalar >::MapVec
private

Definition at line 32 of file DenseGenComplexShiftSolve.h.

◆ Matrix

Definition at line 29 of file DenseGenComplexShiftSolve.h.

◆ Vector

template<typename Scalar >
typedef Eigen::Matrix<Scalar, Eigen::Dynamic, 1> Spectra::DenseGenComplexShiftSolve< Scalar >::Vector
private

Definition at line 30 of file DenseGenComplexShiftSolve.h.

Constructor & Destructor Documentation

◆ DenseGenComplexShiftSolve()

Constructor to create the matrix operation object.

Parameters
matAn Eigen matrix object, whose type can be Eigen::Matrix<Scalar, ...> (e.g. Eigen::MatrixXd and Eigen::MatrixXf), or its mapped version (e.g. Eigen::Map<Eigen::MatrixXd>).

Definition at line 55 of file DenseGenComplexShiftSolve.h.

Member Function Documentation

◆ cols()

template<typename Scalar >
Index Spectra::DenseGenComplexShiftSolve< Scalar >::cols ( void  ) const
inline

Return the number of columns of the underlying matrix.

Definition at line 69 of file DenseGenComplexShiftSolve.h.

◆ perform_op()

template<typename Scalar >
void Spectra::DenseGenComplexShiftSolve< Scalar >::perform_op ( const Scalar x_in,
Scalar y_out 
)
inline

Perform the complex shift-solve operation $y=\mathrm{Re}\{(A-\sigma I)^{-1}x\}$.

Parameters
x_inPointer to the $x$ vector.
y_outPointer to the $y$ vector.

Definition at line 92 of file DenseGenComplexShiftSolve.h.

◆ rows()

template<typename Scalar >
Index Spectra::DenseGenComplexShiftSolve< Scalar >::rows ( void  ) const
inline

Return the number of rows of the underlying matrix.

Definition at line 65 of file DenseGenComplexShiftSolve.h.

◆ set_shift()

template<typename Scalar >
void Spectra::DenseGenComplexShiftSolve< Scalar >::set_shift ( Scalar  sigmar,
Scalar  sigmai 
)
inline

Set the complex shift $\sigma$.

Parameters
sigmarReal part of $\sigma$.
sigmaiImaginary part of $\sigma$.

Definition at line 77 of file DenseGenComplexShiftSolve.h.

Member Data Documentation

◆ m_mat

template<typename Scalar >
ConstGenericMatrix Spectra::DenseGenComplexShiftSolve< Scalar >::m_mat
private

Definition at line 41 of file DenseGenComplexShiftSolve.h.

◆ m_n

template<typename Scalar >
const Index Spectra::DenseGenComplexShiftSolve< Scalar >::m_n
private

Definition at line 42 of file DenseGenComplexShiftSolve.h.

◆ m_solver

template<typename Scalar >
ComplexSolver Spectra::DenseGenComplexShiftSolve< Scalar >::m_solver
private

Definition at line 43 of file DenseGenComplexShiftSolve.h.

◆ m_x_cache

template<typename Scalar >
ComplexVector Spectra::DenseGenComplexShiftSolve< Scalar >::m_x_cache
private

Definition at line 44 of file DenseGenComplexShiftSolve.h.


The documentation for this class was generated from the following file:


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:47:31