#include <SparseGenRealShiftSolve.h>

Public Member Functions
Index	cols () const

void	perform_op (const Scalar x_in, Scalar y_out) const

Index	rows () const

void	set_shift (Scalar sigma)

	SparseGenRealShiftSolve (ConstGenericSparseMatrix &mat)

Private Types
typedef const Eigen::Ref< const SparseMatrix >	ConstGenericSparseMatrix

typedef Eigen::Index	Index

typedef Eigen::Map< const Vector >	MapConstVec

typedef Eigen::Map< Vector >	MapVec

typedef Eigen::SparseMatrix< Scalar, Flags, StorageIndex >	SparseMatrix

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

Private Attributes
ConstGenericSparseMatrix	m_mat

const int	m_n

Eigen::SparseLU< SparseMatrix >	m_solver

Detailed Description

template<typename Scalar, int Flags = 0, typename StorageIndex = int>
class Spectra::SparseGenRealShiftSolve< Scalar, Flags, StorageIndex >

This class defines the shift-solve operation on a sparse 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 25 of file SparseGenRealShiftSolve.h.

Member Typedef Documentation

template<typename Scalar , int Flags = 0, typename StorageIndex = int>

typedef const Eigen::Ref<const SparseMatrix> Spectra::SparseGenRealShiftSolve< Scalar, Flags, StorageIndex >::ConstGenericSparseMatrix

private

Definition at line 33 of file SparseGenRealShiftSolve.h.

template<typename Scalar , int Flags = 0, typename StorageIndex = int>

typedef Eigen::Index Spectra::SparseGenRealShiftSolve< Scalar, Flags, StorageIndex >::Index

private

Definition at line 28 of file SparseGenRealShiftSolve.h.

template<typename Scalar , int Flags = 0, typename StorageIndex = int>

typedef Eigen::Map<const Vector> Spectra::SparseGenRealShiftSolve< Scalar, Flags, StorageIndex >::MapConstVec

private

Definition at line 30 of file SparseGenRealShiftSolve.h.

template<typename Scalar , int Flags = 0, typename StorageIndex = int>

typedef Eigen::Map<Vector> Spectra::SparseGenRealShiftSolve< Scalar, Flags, StorageIndex >::MapVec

private

Definition at line 31 of file SparseGenRealShiftSolve.h.

template<typename Scalar , int Flags = 0, typename StorageIndex = int>

typedef Eigen::SparseMatrix<Scalar, Flags, StorageIndex> Spectra::SparseGenRealShiftSolve< Scalar, Flags, StorageIndex >::SparseMatrix

private

Definition at line 32 of file SparseGenRealShiftSolve.h.

template<typename Scalar , int Flags = 0, typename StorageIndex = int>

typedef Eigen::Matrix<Scalar, Eigen::Dynamic, 1> Spectra::SparseGenRealShiftSolve< Scalar, Flags, StorageIndex >::Vector

private

Definition at line 29 of file SparseGenRealShiftSolve.h.

Constructor & Destructor Documentation

template<typename Scalar , int Flags = 0, typename StorageIndex = int>

Spectra::SparseGenRealShiftSolve< Scalar, Flags, StorageIndex >::SparseGenRealShiftSolve ( ConstGenericSparseMatrix & mat )

inline

Constructor to create the matrix operation object.

Parameters

mat	An Eigen sparse matrix object, whose type can be `Eigen::SparseMatrix<Scalar, ...>` or its mapped version `Eigen::Map<Eigen::SparseMatrix<Scalar, ...> >`.

Definition at line 47 of file SparseGenRealShiftSolve.h.

Member Function Documentation

template<typename Scalar , int Flags = 0, typename StorageIndex = int>

Index Spectra::SparseGenRealShiftSolve< Scalar, Flags, StorageIndex >::cols ( void ) const

inline

Return the number of columns of the underlying matrix.

Definition at line 61 of file SparseGenRealShiftSolve.h.

template<typename Scalar , int Flags = 0, typename StorageIndex = int>

void Spectra::SparseGenRealShiftSolve< Scalar, Flags, StorageIndex >::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 83 of file SparseGenRealShiftSolve.h.

template<typename Scalar , int Flags = 0, typename StorageIndex = int>

Index Spectra::SparseGenRealShiftSolve< Scalar, Flags, StorageIndex >::rows ( void ) const

inline

Return the number of rows of the underlying matrix.

Definition at line 57 of file SparseGenRealShiftSolve.h.

template<typename Scalar , int Flags = 0, typename StorageIndex = int>

void Spectra::SparseGenRealShiftSolve< Scalar, Flags, StorageIndex >::set_shift ( Scalar sigma )

inline

Set the real shift $\sigma$ .

Definition at line 66 of file SparseGenRealShiftSolve.h.

Member Data Documentation

template<typename Scalar , int Flags = 0, typename StorageIndex = int>

ConstGenericSparseMatrix Spectra::SparseGenRealShiftSolve< Scalar, Flags, StorageIndex >::m_mat

private

Definition at line 35 of file SparseGenRealShiftSolve.h.

template<typename Scalar , int Flags = 0, typename StorageIndex = int>

const int Spectra::SparseGenRealShiftSolve< Scalar, Flags, StorageIndex >::m_n

private

Definition at line 36 of file SparseGenRealShiftSolve.h.

template<typename Scalar , int Flags = 0, typename StorageIndex = int>

Eigen::SparseLU<SparseMatrix> Spectra::SparseGenRealShiftSolve< Scalar, Flags, StorageIndex >::m_solver

private

Definition at line 37 of file SparseGenRealShiftSolve.h.

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

SparseGenRealShiftSolve.h

Public Member Functions

Private Types

Private Attributes

Detailed Description

template<typename Scalar, int Flags = 0, typename StorageIndex = int> class Spectra::SparseGenRealShiftSolve< Scalar, Flags, StorageIndex >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename Scalar, int Flags = 0, typename StorageIndex = int>
class Spectra::SparseGenRealShiftSolve< Scalar, Flags, StorageIndex >