Spectra
Spectra::SparseSymMatProd< Scalar, Uplo, Flags, StorageIndex > Class Template Reference

#include <Spectra/MatOp/SparseSymMatProd.h>

Public Member Functions

 SparseSymMatProd (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 Uplo = Eigen::Lower, int Flags = 0, typename StorageIndex = int>
class Spectra::SparseSymMatProd< Scalar, Uplo, Flags, StorageIndex >

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

Definition at line 24 of file SparseSymMatProd.h.

Constructor & Destructor Documentation

◆ SparseSymMatProd()

template<typename Scalar , int Uplo = Eigen::Lower, int Flags = 0, typename StorageIndex = int>
Spectra::SparseSymMatProd< Scalar, Uplo, Flags, StorageIndex >::SparseSymMatProd ( ConstGenericSparseMatrix &  mat)
inline

Constructor to create the matrix operation object.

Parameters
matAn Eigen sparse matrix object, whose type can be Eigen::SparseMatrix<Scalar, ...> or its mapped version Eigen::Map<Eigen::SparseMatrix<Scalar, ...> >.

Definition at line 43 of file SparseSymMatProd.h.

Member Function Documentation

◆ rows()

template<typename Scalar , int Uplo = Eigen::Lower, int Flags = 0, typename StorageIndex = int>
int Spectra::SparseSymMatProd< Scalar, Uplo, Flags, StorageIndex >::rows ( ) const
inline

Return the number of rows of the underlying matrix.

Definition at line 50 of file SparseSymMatProd.h.

◆ cols()

template<typename Scalar , int Uplo = Eigen::Lower, int Flags = 0, typename StorageIndex = int>
int Spectra::SparseSymMatProd< Scalar, Uplo, Flags, StorageIndex >::cols ( ) const
inline

Return the number of columns of the underlying matrix.

Definition at line 54 of file SparseSymMatProd.h.

◆ perform_op()

template<typename Scalar , int Uplo = Eigen::Lower, int Flags = 0, typename StorageIndex = int>
void Spectra::SparseSymMatProd< Scalar, Uplo, Flags, StorageIndex >::perform_op ( const Scalar *  x_in,
Scalar *  y_out 
) const
inline

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

Parameters
x_inPointer to the \(x\) vector.
y_outPointer to the \(y\) vector.

Definition at line 63 of file SparseSymMatProd.h.


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