DenseGenRealShiftSolve< Scalar > Class Template Reference

#include <DenseGenRealShiftSolve.h>

Public Member Functions
	DenseGenRealShiftSolve (ConstGenericMatrix &mat_)
int	rows ()
int	cols ()
void	set_shift (Scalar sigma)
void	perform_op (Scalar *x_in, Scalar *y_out)

Detailed Description

template<typename Scalar>
class DenseGenRealShiftSolve< Scalar >

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

Definition at line 16 of file DenseGenRealShiftSolve.h.

Constructor & Destructor Documentation

template<typename Scalar >

DenseGenRealShiftSolve< Scalar >::DenseGenRealShiftSolve ( 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 39 of file DenseGenRealShiftSolve.h.

Member Function Documentation

template<typename Scalar >

int DenseGenRealShiftSolve< Scalar >::rows ( )

inline

Return the number of rows of the underlying matrix.

Definition at line 50 of file DenseGenRealShiftSolve.h.

template<typename Scalar >

int DenseGenRealShiftSolve< Scalar >::cols ( )

inline

Return the number of columns of the underlying matrix.

Definition at line 54 of file DenseGenRealShiftSolve.h.

template<typename Scalar >

void DenseGenRealShiftSolve< Scalar >::set_shift ( Scalar  sigma )

inline

Set the real shift \(\sigma\).

Definition at line 59 of file DenseGenRealShiftSolve.h.

template<typename Scalar >

void DenseGenRealShiftSolve< Scalar >::perform_op ( Scalar *  x_in, Scalar *  y_out  )

inline

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

Parameters

x_in	Pointer to the \(x\) vector.
y_out	Pointer to the \(y\) vector.

Definition at line 71 of file DenseGenRealShiftSolve.h.

---

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

• MatOp/DenseGenRealShiftSolve.h