#include <DenseGenRealShiftSolve.h>

Public Member Functions
Index	cols () const

	DenseGenRealShiftSolve (ConstGenericMatrix &mat)

void	perform_op (const Scalar x_in, Scalar y_out) const

Index	rows () const

void	set_shift (Scalar sigma)

Private Types
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
const typedef Eigen::Ref< const Matrix >	ConstGenericMatrix

ConstGenericMatrix	m_mat

const Index	m_n

Eigen::PartialPivLU< Matrix >	m_solver

Detailed Description

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

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

Definition at line 24 of file DenseGenRealShiftSolve.h.

Member Typedef Documentation

◆ Index

template<typename Scalar >

typedef Eigen::Index Spectra::DenseGenRealShiftSolve< Scalar >::Index

private

Definition at line 27 of file DenseGenRealShiftSolve.h.

◆ MapConstVec

template<typename Scalar >

typedef Eigen::Map<const Vector> Spectra::DenseGenRealShiftSolve< Scalar >::MapConstVec

private

Definition at line 30 of file DenseGenRealShiftSolve.h.

◆ MapVec

template<typename Scalar >

typedef Eigen::Map<Vector> Spectra::DenseGenRealShiftSolve< Scalar >::MapVec

private

Definition at line 31 of file DenseGenRealShiftSolve.h.

◆ Matrix

template<typename Scalar >

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

private

Definition at line 28 of file DenseGenRealShiftSolve.h.

◆ Vector

template<typename Scalar >

typedef Eigen::Matrix<Scalar, Eigen::Dynamic, 1> Spectra::DenseGenRealShiftSolve< Scalar >::Vector

private

Definition at line 29 of file DenseGenRealShiftSolve.h.

Constructor & Destructor Documentation

◆ DenseGenRealShiftSolve()

template<typename Scalar >

Spectra::DenseGenRealShiftSolve< Scalar >::DenseGenRealShiftSolve ( 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 47 of file DenseGenRealShiftSolve.h.

Member Function Documentation

◆ cols()

template<typename Scalar >

Index Spectra::DenseGenRealShiftSolve< Scalar >::cols ( ) const

inline

Return the number of columns of the underlying matrix.

Definition at line 61 of file DenseGenRealShiftSolve.h.

◆ perform_op()

template<typename Scalar >

void Spectra::DenseGenRealShiftSolve< Scalar >::perform_op	(	const Scalar *	x_in,
		Scalar *	y_out
	)		const

inline

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

Parameters

x_in	Pointer to the vector.
y_out	Pointer to the vector.

Definition at line 78 of file DenseGenRealShiftSolve.h.

◆ rows()

template<typename Scalar >

Index Spectra::DenseGenRealShiftSolve< Scalar >::rows ( ) const

inline

Return the number of rows of the underlying matrix.

Definition at line 57 of file DenseGenRealShiftSolve.h.

◆ set_shift()

template<typename Scalar >

void Spectra::DenseGenRealShiftSolve< Scalar >::set_shift ( Scalar sigma )

inline

Set the real shift $\sigma$ .

Definition at line 66 of file DenseGenRealShiftSolve.h.

Member Data Documentation

◆ ConstGenericMatrix

template<typename Scalar >

const typedef Eigen::Ref<const Matrix> Spectra::DenseGenRealShiftSolve< Scalar >::ConstGenericMatrix

private

Definition at line 32 of file DenseGenRealShiftSolve.h.

◆ m_mat

template<typename Scalar >

ConstGenericMatrix Spectra::DenseGenRealShiftSolve< Scalar >::m_mat

private

Definition at line 34 of file DenseGenRealShiftSolve.h.

◆ m_n

template<typename Scalar >

const Index Spectra::DenseGenRealShiftSolve< Scalar >::m_n

private

Definition at line 35 of file DenseGenRealShiftSolve.h.

◆ m_solver

template<typename Scalar >

Eigen::PartialPivLU<Matrix> Spectra::DenseGenRealShiftSolve< Scalar >::m_solver

private

Definition at line 36 of file DenseGenRealShiftSolve.h.

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

DenseGenRealShiftSolve.h

Public Member Functions

Private Types

Private Attributes

Detailed Description

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

Member Typedef Documentation

◆ Index

◆ MapConstVec

◆ MapVec

◆ Matrix

◆ Vector

Constructor & Destructor Documentation

◆ DenseGenRealShiftSolve()

Member Function Documentation

◆ cols()

◆ perform_op()

◆ rows()

◆ set_shift()

Member Data Documentation

◆ ConstGenericMatrix

◆ m_mat

◆ m_n

◆ m_solver

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