Spectra::SparseGenMatProd< Scalar_, Flags, StorageIndex > Class Template Reference

#include <SparseGenMatProd.h>

Public Types
using	Scalar = Scalar_

Public Member Functions
Index	cols () const
Scalar	operator() (Index i, Index j) const
Matrix	operator* (const Eigen::Ref< const Matrix > &mat_in) const
void	perform_op (const Scalar *x_in, Scalar *y_out) const
Index	rows () const
template<typename Derived >
	SparseGenMatProd (const Eigen::SparseMatrixBase< Derived > &mat)

Private Types
using	ConstGenericSparseMatrix = const Eigen::Ref< const SparseMatrix >
using	Index = Eigen::Index
using	MapConstVec = Eigen::Map< const Vector >
using	MapVec = Eigen::Map< Vector >
using	Matrix = Eigen::Matrix< Scalar, Eigen::Dynamic, Eigen::Dynamic >
using	SparseMatrix = Eigen::SparseMatrix< Scalar, Flags, StorageIndex >
using	Vector = Eigen::Matrix< Scalar, Eigen::Dynamic, 1 >

Private Attributes
ConstGenericSparseMatrix	m_mat

Detailed Description

template<typename Scalar_, int Flags = Eigen::ColMajor, typename StorageIndex = int>
class Spectra::SparseGenMatProd< Scalar_, Flags, StorageIndex >

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

Template Parameters

Scalar_	The element type of the matrix, for example, float, double, and long double.
Flags	Either Eigen::ColMajor or Eigen::RowMajor, indicating the storage format of the input matrix.
StorageIndex	The type of the indices for the sparse matrix.

Definition at line 29 of file SparseGenMatProd.h.

Member Typedef Documentation

ConstGenericSparseMatrix

template<typename Scalar_ , int Flags = Eigen::ColMajor, typename StorageIndex = int>

using Spectra::SparseGenMatProd< Scalar_, Flags, StorageIndex >::ConstGenericSparseMatrix = const Eigen::Ref<const SparseMatrix>

private

Definition at line 44 of file SparseGenMatProd.h.

Index

template<typename Scalar_ , int Flags = Eigen::ColMajor, typename StorageIndex = int>

using Spectra::SparseGenMatProd< Scalar_, Flags, StorageIndex >::Index = Eigen::Index

private

Definition at line 38 of file SparseGenMatProd.h.

MapConstVec

template<typename Scalar_ , int Flags = Eigen::ColMajor, typename StorageIndex = int>

using Spectra::SparseGenMatProd< Scalar_, Flags, StorageIndex >::MapConstVec = Eigen::Map<const Vector>

private

Definition at line 40 of file SparseGenMatProd.h.

MapVec

template<typename Scalar_ , int Flags = Eigen::ColMajor, typename StorageIndex = int>

using Spectra::SparseGenMatProd< Scalar_, Flags, StorageIndex >::MapVec = Eigen::Map<Vector>

private

Definition at line 41 of file SparseGenMatProd.h.

Matrix

template<typename Scalar_ , int Flags = Eigen::ColMajor, typename StorageIndex = int>

using Spectra::SparseGenMatProd< Scalar_, Flags, StorageIndex >::Matrix = Eigen::Matrix<Scalar, Eigen::Dynamic, Eigen::Dynamic>

private

Definition at line 42 of file SparseGenMatProd.h.

Scalar

template<typename Scalar_ , int Flags = Eigen::ColMajor, typename StorageIndex = int>

using Spectra::SparseGenMatProd< Scalar_, Flags, StorageIndex >::Scalar = Scalar_

Element type of the matrix.

Definition at line 35 of file SparseGenMatProd.h.

SparseMatrix

template<typename Scalar_ , int Flags = Eigen::ColMajor, typename StorageIndex = int>

using Spectra::SparseGenMatProd< Scalar_, Flags, StorageIndex >::SparseMatrix = Eigen::SparseMatrix<Scalar, Flags, StorageIndex>

private

Definition at line 43 of file SparseGenMatProd.h.

Vector

template<typename Scalar_ , int Flags = Eigen::ColMajor, typename StorageIndex = int>

using Spectra::SparseGenMatProd< Scalar_, Flags, StorageIndex >::Vector = Eigen::Matrix<Scalar, Eigen::Dynamic, 1>

private

Definition at line 39 of file SparseGenMatProd.h.

Constructor & Destructor Documentation

SparseGenMatProd()

template<typename Scalar_ , int Flags = Eigen::ColMajor, typename StorageIndex = int>

template<typename Derived >

Spectra::SparseGenMatProd< Scalar_, Flags, StorageIndex >::SparseGenMatProd ( const Eigen::SparseMatrixBase< Derived > &  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 57 of file SparseGenMatProd.h.

Member Function Documentation

cols()

template<typename Scalar_ , int Flags = Eigen::ColMajor, typename StorageIndex = int>

Index Spectra::SparseGenMatProd< Scalar_, Flags, StorageIndex >::cols ( ) const

inline

Return the number of columns of the underlying matrix.

Definition at line 72 of file SparseGenMatProd.h.

operator()()

template<typename Scalar_ , int Flags = Eigen::ColMajor, typename StorageIndex = int>

Scalar Spectra::SparseGenMatProd< Scalar_, Flags, StorageIndex >::operator() ( Index  i, Index  j  ) const

inline

Extract (i,j) element of the underlying matrix.

Definition at line 99 of file SparseGenMatProd.h.

operator*()

template<typename Scalar_ , int Flags = Eigen::ColMajor, typename StorageIndex = int>

Matrix Spectra::SparseGenMatProd< Scalar_, Flags, StorageIndex >::operator* ( const Eigen::Ref< const Matrix > &  mat_in ) const

inline

Perform the matrix-matrix multiplication operation .

Definition at line 91 of file SparseGenMatProd.h.

perform_op()

template<typename Scalar_ , int Flags = Eigen::ColMajor, typename StorageIndex = int>

void Spectra::SparseGenMatProd< Scalar_, 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 81 of file SparseGenMatProd.h.

rows()

template<typename Scalar_ , int Flags = Eigen::ColMajor, typename StorageIndex = int>

Index Spectra::SparseGenMatProd< Scalar_, Flags, StorageIndex >::rows ( ) const

inline

Return the number of rows of the underlying matrix.

Definition at line 68 of file SparseGenMatProd.h.

Member Data Documentation

m_mat

template<typename Scalar_ , int Flags = Eigen::ColMajor, typename StorageIndex = int>

ConstGenericSparseMatrix Spectra::SparseGenMatProd< Scalar_, Flags, StorageIndex >::m_mat

private

Definition at line 46 of file SparseGenMatProd.h.

---

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

• SparseGenMatProd.h