Loading web-font TeX/Math/Italic
Spectra 1.1.0
Header-only C++ Library for Large Scale Eigenvalue Problems
All Classes Functions Typedefs Enumerations Enumerator Modules Pages
Spectra::SparseGenMatProd< Scalar_, Flags, StorageIndex > Class Template Reference

#include <Spectra/MatOp/SparseGenMatProd.h>

Public Types

using Scalar = Scalar_
 

Public Member Functions

template<typename Derived>
 SparseGenMatProd (const Eigen::SparseMatrixBase< 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 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 A, i.e., calculating y=Ax for any vector x. 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.
FlagsEither Eigen::ColMajor or Eigen::RowMajor, indicating the storage format of the input matrix.
StorageIndexThe type of the indices for the sparse matrix.

Definition at line 29 of file SparseGenMatProd.h.

Member Typedef Documentation

◆ 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.

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
matAn 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

◆ 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.

◆ 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.

◆ 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 y=Ax.

Parameters
x_inPointer to the x vector.
y_outPointer to the y vector.

Definition at line 81 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 y=Ax.

Definition at line 91 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.


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