Spectra 1.1.0
Header-only C++ Library for Large Scale Eigenvalue Problems
|
#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 |
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.
Scalar_ | The element type of the matrix, for example, float , double , and long double . |
Flags | Either Eigen::ColMajor or Eigen::RowMajor , indicating the storage format of the input matrix. |
StorageIndex | The type of the indices for the sparse matrix. |
Definition at line 29 of file SparseGenMatProd.h.
using Spectra::SparseGenMatProd< Scalar_, Flags, StorageIndex >::Scalar = Scalar_ |
Element type of the matrix.
Definition at line 35 of file SparseGenMatProd.h.
|
inline |
Constructor to create the matrix operation object.
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 57 of file SparseGenMatProd.h.
|
inline |
Return the number of rows of the underlying matrix.
Definition at line 68 of file SparseGenMatProd.h.
|
inline |
Return the number of columns of the underlying matrix.
Definition at line 72 of file SparseGenMatProd.h.
|
inline |
Perform the matrix-vector multiplication operation y=Ax.
x_in | Pointer to the x vector. |
y_out | Pointer to the y vector. |
Definition at line 81 of file SparseGenMatProd.h.
|
inline |
Perform the matrix-matrix multiplication operation y=Ax.
Definition at line 91 of file SparseGenMatProd.h.
|
inline |
Extract (i,j) element of the underlying matrix.
Definition at line 99 of file SparseGenMatProd.h.