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

#include <Spectra/MatOp/SparseGenMatProd.h>

Public Member Functions
	SparseGenMatProd (ConstGenericSparseMatrix &mat)
int	rows () const
int	cols () const
void	perform_op (const Scalar *x_in, Scalar *y_out) const

Detailed Description

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

This class defines the matrix-vector multiplication operation on a sparse real matrix \(A\), i.e., calculating \(y=Ax\) for any vector \(x\). It is mainly used in the GenEigsSolver and SymEigsSolver eigen solvers.

Definition at line 25 of file SparseGenMatProd.h.

Constructor & Destructor Documentation

SparseGenMatProd()

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

Spectra::SparseGenMatProd< Scalar, Flags, StorageIndex >::SparseGenMatProd ( 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 44 of file SparseGenMatProd.h.

Member Function Documentation

rows()

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

int Spectra::SparseGenMatProd< Scalar, Flags, StorageIndex >::rows ( ) const

inline

Return the number of rows of the underlying matrix.

Definition at line 51 of file SparseGenMatProd.h.

cols()

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

int Spectra::SparseGenMatProd< Scalar, Flags, StorageIndex >::cols ( ) const

inline

Return the number of columns of the underlying matrix.

Definition at line 55 of file SparseGenMatProd.h.

perform_op()

template<typename Scalar, int Flags = 0, 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 \(y=Ax\).

Parameters

x_in	Pointer to the \(x\) vector.
y_out	Pointer to the \(y\) vector.

Definition at line 64 of file SparseGenMatProd.h.

---

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

• Spectra/MatOp/SparseGenMatProd.h