Spectra::DenseGenMatProd< Scalar > Class Template Reference

#include <DenseGenMatProd.h>

Public Member Functions
Index	cols () const
	DenseGenMatProd (ConstGenericMatrix &mat)
void	perform_op (const Scalar *x_in, Scalar *y_out) const
Index	rows () const

Private Types
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

Detailed Description

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

This class defines the matrix-vector multiplication operation on a general real matrix , i.e., calculating for any vector . It is mainly used in the GenEigsSolver and SymEigsSolver eigen solvers.

Definition at line 29 of file DenseGenMatProd.h.

Member Typedef Documentation

ConstGenericMatrix

template<typename Scalar >

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

private

Definition at line 37 of file DenseGenMatProd.h.

Index

template<typename Scalar >

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

private

Definition at line 32 of file DenseGenMatProd.h.

MapConstVec

template<typename Scalar >

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

private

Definition at line 35 of file DenseGenMatProd.h.

MapVec

template<typename Scalar >

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

private

Definition at line 36 of file DenseGenMatProd.h.

Matrix

template<typename Scalar >

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

private

Definition at line 33 of file DenseGenMatProd.h.

Vector

template<typename Scalar >

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

private

Definition at line 34 of file DenseGenMatProd.h.

Constructor & Destructor Documentation

DenseGenMatProd()

template<typename Scalar >

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

Member Function Documentation

cols()

template<typename Scalar >

Index Spectra::DenseGenMatProd< Scalar >::cols ( void  ) const

inline

Return the number of columns of the underlying matrix.

Definition at line 61 of file DenseGenMatProd.h.

perform_op()

template<typename Scalar >

void Spectra::DenseGenMatProd< Scalar >::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 70 of file DenseGenMatProd.h.

rows()

template<typename Scalar >

Index Spectra::DenseGenMatProd< Scalar >::rows ( void  ) const

inline

Return the number of rows of the underlying matrix.

Definition at line 57 of file DenseGenMatProd.h.

Member Data Documentation

m_mat

template<typename Scalar >

ConstGenericMatrix Spectra::DenseGenMatProd< Scalar >::m_mat

private

Definition at line 39 of file DenseGenMatProd.h.

---

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

• DenseGenMatProd.h