ARPACK-Eigen
DenseGenComplexShiftSolve< Scalar > Class Template Reference

#include <DenseGenComplexShiftSolve.h>

Public Member Functions

 DenseGenComplexShiftSolve (ConstGenericMatrix &mat_)
 
int rows ()
 
int cols ()
 
void set_shift (Scalar sigmar, Scalar sigmai)
 
void perform_op (Scalar *x_in, Scalar *y_out)
 

Detailed Description

template<typename Scalar>
class DenseGenComplexShiftSolve< Scalar >

This class defines the complex shift-solve operation on a general real matrix \(A\), i.e., calculating \(y=\mathrm{Re}\{(A-\sigma I)^{-1}x\}\) for any complex-valued \(\sigma\) and real-valued vector \(x\). It is mainly used in the GenEigsComplexShiftSolver eigen solver.

Definition at line 17 of file DenseGenComplexShiftSolve.h.

Constructor & Destructor Documentation

template<typename Scalar >
DenseGenComplexShiftSolve< Scalar >::DenseGenComplexShiftSolve ( ConstGenericMatrix &  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 45 of file DenseGenComplexShiftSolve.h.

Member Function Documentation

template<typename Scalar >
int DenseGenComplexShiftSolve< Scalar >::rows ( )
inline

Return the number of rows of the underlying matrix.

Definition at line 56 of file DenseGenComplexShiftSolve.h.

template<typename Scalar >
int DenseGenComplexShiftSolve< Scalar >::cols ( )
inline

Return the number of columns of the underlying matrix.

Definition at line 60 of file DenseGenComplexShiftSolve.h.

template<typename Scalar >
void DenseGenComplexShiftSolve< Scalar >::set_shift ( Scalar  sigmar,
Scalar  sigmai 
)
inline

Set the complex shift \(\sigma\).

Parameters
sigmarReal part of \(\sigma\).
sigmaiImaginary part of \(\sigma\).

Definition at line 68 of file DenseGenComplexShiftSolve.h.

template<typename Scalar >
void DenseGenComplexShiftSolve< Scalar >::perform_op ( Scalar *  x_in,
Scalar *  y_out 
)
inline

Perform the complex shift-solve operation \(y=\mathrm{Re}\{(A-\sigma I)^{-1}x\}\).

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

Definition at line 85 of file DenseGenComplexShiftSolve.h.


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