Spectra 1.2.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- or complex-valued matrix A, i.e., calculating y=Ax for any vector x. It is mainly used in the GenEigsSolver eigen solver.
Scalar_ | The element type of the matrix, for example, float, double, long double, and their complex types (e.g., std::complex<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 30 of file SparseGenMatProd.h.
using Spectra::SparseGenMatProd< Scalar_, Flags, StorageIndex >::Scalar = Scalar_ |
Element type of the matrix.
Definition at line 36 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 58 of file SparseGenMatProd.h.
|
inline |
Return the number of rows of the underlying matrix.
Definition at line 69 of file SparseGenMatProd.h.
|
inline |
Return the number of columns of the underlying matrix.
Definition at line 73 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 82 of file SparseGenMatProd.h.
|
inline |
Perform the matrix-matrix multiplication operation y=Ax.
Definition at line 92 of file SparseGenMatProd.h.
|
inline |
Extract (i,j) element of the underlying matrix.
Definition at line 100 of file SparseGenMatProd.h.