Spectra::DenseSymMatProd< Scalar_, Uplo, Flags > Class Template Reference

#include <Spectra/MatOp/DenseSymMatProd.h>

Public Types
using	Scalar = Scalar_

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

Detailed Description

template<typename Scalar_, int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor>
class Spectra::DenseSymMatProd< Scalar_, Uplo, Flags >

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

Template Parameters

Scalar_	The element type of the matrix, for example, float, double, and long double.
Uplo	Either Eigen::Lower or Eigen::Upper, indicating which triangular part of the matrix is used.
Flags	Either Eigen::ColMajor or Eigen::RowMajor, indicating the storage format of the input matrix.

Definition at line 29 of file DenseSymMatProd.h.

Member Typedef Documentation

Scalar

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

using Spectra::DenseSymMatProd< Scalar_, Uplo, Flags >::Scalar = Scalar_

Element type of the matrix.

Definition at line 35 of file DenseSymMatProd.h.

Constructor & Destructor Documentation

DenseSymMatProd()

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

template<typename Derived >

Spectra::DenseSymMatProd< Scalar_, Uplo, Flags >::DenseSymMatProd ( const Eigen::MatrixBase< Derived > &  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 57 of file DenseSymMatProd.h.

Member Function Documentation

rows()

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

Index Spectra::DenseSymMatProd< Scalar_, Uplo, Flags >::rows ( ) const

inline

Return the number of rows of the underlying matrix.

Definition at line 68 of file DenseSymMatProd.h.

cols()

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

Index Spectra::DenseSymMatProd< Scalar_, Uplo, Flags >::cols ( ) const

inline

Return the number of columns of the underlying matrix.

Definition at line 72 of file DenseSymMatProd.h.

perform_op()

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

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

operator*()

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

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

inline

Perform the matrix-matrix multiplication operation \(y=Ax\).

Definition at line 91 of file DenseSymMatProd.h.

operator()()

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

Scalar Spectra::DenseSymMatProd< Scalar_, Uplo, Flags >::operator() ( Index  i, Index  j  ) const

inline

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

Definition at line 99 of file DenseSymMatProd.h.

---

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

• Spectra/MatOp/DenseSymMatProd.h