#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< Scalar >	Complex

typedef Eigen::Matrix< Complex, Eigen::Dynamic, Eigen::Dynamic >	ComplexMatrix

typedef Eigen::PartialPivLU< ComplexMatrix >	ComplexSolver

typedef Eigen::Matrix< Complex, Eigen::Dynamic, 1 >	ComplexVector

typedef const Eigen::Ref< const Matrix >	ConstGenericMatrix

typedef Eigen::Index	Index

typedef Eigen::Map< const Vector >	MapConstVec

typedef Eigen::Map< Vector >	MapVec

typedef Eigen::Matrix< Scalar, Eigen::Dynamic, Eigen::Dynamic >	Matrix

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

template<typename Scalar >

typedef Eigen::Matrix<Complex, Eigen::Dynamic, Eigen::Dynamic> Spectra::DenseGenComplexShiftSolve< Scalar >::ComplexMatrix

private

Definition at line 36 of file DenseGenComplexShiftSolve.h.

◆ ComplexSolver

template<typename Scalar >

typedef Eigen::PartialPivLU<ComplexMatrix> Spectra::DenseGenComplexShiftSolve< Scalar >::ComplexSolver

private

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

template<typename Scalar >

typedef Eigen::Matrix<Scalar, Eigen::Dynamic, Eigen::Dynamic> Spectra::DenseGenComplexShiftSolve< Scalar >::Matrix

private

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()

template<typename Scalar >

Spectra::DenseGenComplexShiftSolve< Scalar >::DenseGenComplexShiftSolve ( ConstGenericMatrix & mat )

inline

Constructor to create the matrix operation object.

Parameters

mat	An 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.