DenseGenMatProd< Scalar > Class Template Reference

#include <DenseGenMatProd.h>

Public Member Functions
	DenseGenMatProd (ConstGenericMatrix &mat_)
int	rows ()
int	cols ()
void	perform_op (Scalar *x_in, Scalar *y_out)

Detailed Description

template<typename Scalar>
class DenseGenMatProd< Scalar >

This class defines the matrix-vector multiplication operation on a general 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 21 of file DenseGenMatProd.h.

Constructor & Destructor Documentation

template<typename Scalar >

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 42 of file DenseGenMatProd.h.

Member Function Documentation

template<typename Scalar >

int DenseGenMatProd< Scalar >::rows ( )

inline

Return the number of rows of the underlying matrix.

Definition at line 49 of file DenseGenMatProd.h.

template<typename Scalar >

int DenseGenMatProd< Scalar >::cols ( )

inline

Return the number of columns of the underlying matrix.

Definition at line 53 of file DenseGenMatProd.h.

template<typename Scalar >

void DenseGenMatProd< Scalar >::perform_op ( Scalar *  x_in, Scalar *  y_out  )

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 62 of file DenseGenMatProd.h.

---

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

• MatOp/DenseGenMatProd.h