Spectra::SparseSymShiftSolve< Scalar, Uplo, Flags, StorageIndex > Class Template Reference

#include <SparseSymShiftSolve.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)
	SparseSymShiftSolve (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 Uplo = Eigen::Lower, int Flags = 0, typename StorageIndex = int>
class Spectra::SparseSymShiftSolve< Scalar, Uplo, Flags, StorageIndex >

This class defines the shift-solve operation on a sparse real symmetric matrix , i.e., calculating for any real and vector . It is mainly used in the SymEigsShiftSolver eigen solver.

Definition at line 25 of file SparseSymShiftSolve.h.

Member Typedef Documentation

template<typename Scalar , int Uplo = Eigen::Lower, int Flags = 0, typename StorageIndex = int>

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

private

Definition at line 33 of file SparseSymShiftSolve.h.

template<typename Scalar , int Uplo = Eigen::Lower, int Flags = 0, typename StorageIndex = int>

typedef Eigen::Index Spectra::SparseSymShiftSolve< Scalar, Uplo, Flags, StorageIndex >::Index

private

Definition at line 28 of file SparseSymShiftSolve.h.

template<typename Scalar , int Uplo = Eigen::Lower, int Flags = 0, typename StorageIndex = int>

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

private

Definition at line 30 of file SparseSymShiftSolve.h.

template<typename Scalar , int Uplo = Eigen::Lower, int Flags = 0, typename StorageIndex = int>

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

private

Definition at line 31 of file SparseSymShiftSolve.h.

template<typename Scalar , int Uplo = Eigen::Lower, int Flags = 0, typename StorageIndex = int>

typedef Eigen::SparseMatrix<Scalar, Flags, StorageIndex> Spectra::SparseSymShiftSolve< Scalar, Uplo, Flags, StorageIndex >::SparseMatrix

private

Definition at line 32 of file SparseSymShiftSolve.h.

template<typename Scalar , int Uplo = Eigen::Lower, int Flags = 0, typename StorageIndex = int>

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

private

Definition at line 29 of file SparseSymShiftSolve.h.

Constructor & Destructor Documentation

template<typename Scalar , int Uplo = Eigen::Lower, int Flags = 0, typename StorageIndex = int>

Spectra::SparseSymShiftSolve< Scalar, Uplo, Flags, StorageIndex >::SparseSymShiftSolve ( 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 SparseSymShiftSolve.h.

Member Function Documentation

template<typename Scalar , int Uplo = Eigen::Lower, int Flags = 0, typename StorageIndex = int>

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

inline

Return the number of columns of the underlying matrix.

Definition at line 61 of file SparseSymShiftSolve.h.

template<typename Scalar , int Uplo = Eigen::Lower, int Flags = 0, typename StorageIndex = int>

void Spectra::SparseSymShiftSolve< Scalar, Uplo, Flags, StorageIndex >::perform_op ( const Scalar *  x_in, Scalar *  y_out  ) const

inline

Perform the shift-solve operation .

Parameters

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

Definition at line 85 of file SparseSymShiftSolve.h.

template<typename Scalar , int Uplo = Eigen::Lower, int Flags = 0, typename StorageIndex = int>

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

inline

Return the number of rows of the underlying matrix.

Definition at line 57 of file SparseSymShiftSolve.h.

template<typename Scalar , int Uplo = Eigen::Lower, int Flags = 0, typename StorageIndex = int>

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

inline

Set the real shift .

Definition at line 66 of file SparseSymShiftSolve.h.

Member Data Documentation

template<typename Scalar , int Uplo = Eigen::Lower, int Flags = 0, typename StorageIndex = int>

ConstGenericSparseMatrix Spectra::SparseSymShiftSolve< Scalar, Uplo, Flags, StorageIndex >::m_mat

private

Definition at line 35 of file SparseSymShiftSolve.h.

template<typename Scalar , int Uplo = Eigen::Lower, int Flags = 0, typename StorageIndex = int>

const int Spectra::SparseSymShiftSolve< Scalar, Uplo, Flags, StorageIndex >::m_n

private

Definition at line 36 of file SparseSymShiftSolve.h.

template<typename Scalar , int Uplo = Eigen::Lower, int Flags = 0, typename StorageIndex = int>

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

private

Definition at line 37 of file SparseSymShiftSolve.h.

---

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

• SparseSymShiftSolve.h