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

#include <SparseSymMatProd.h>

Public Member Functions
Index	cols () const
void	perform_op (const Scalar *x_in, Scalar *y_out) const
Index	rows () const
	SparseSymMatProd (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

Detailed Description

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

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

Definition at line 23 of file SparseSymMatProd.h.

Member Typedef Documentation

ConstGenericSparseMatrix

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

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

private

Definition at line 31 of file SparseSymMatProd.h.

Index

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

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

private

Definition at line 26 of file SparseSymMatProd.h.

MapConstVec

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

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

private

Definition at line 28 of file SparseSymMatProd.h.

MapVec

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

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

private

Definition at line 29 of file SparseSymMatProd.h.

SparseMatrix

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

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

private

Definition at line 30 of file SparseSymMatProd.h.

Vector

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

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

private

Definition at line 27 of file SparseSymMatProd.h.

Constructor & Destructor Documentation

SparseSymMatProd()

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

Spectra::SparseSymMatProd< Scalar, Uplo, Flags, StorageIndex >::SparseSymMatProd ( 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 43 of file SparseSymMatProd.h.

Member Function Documentation

cols()

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

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

inline

Return the number of columns of the underlying matrix.

Definition at line 54 of file SparseSymMatProd.h.

perform_op()

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

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

inline

Perform the matrix-vector multiplication operation .

Parameters

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

Definition at line 63 of file SparseSymMatProd.h.

rows()

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

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

inline

Return the number of rows of the underlying matrix.

Definition at line 50 of file SparseSymMatProd.h.

Member Data Documentation

m_mat

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

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

private

Definition at line 33 of file SparseSymMatProd.h.

---

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

• SparseSymMatProd.h