DenseSymShiftSolve< Scalar > Class Template Reference

#include <DenseSymShiftSolve.h>

Public Member Functions
	DenseSymShiftSolve (Matrix &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 DenseSymShiftSolve< Scalar >

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

Definition at line 22 of file DenseSymShiftSolve.h.

Constructor & Destructor Documentation

template<typename Scalar >

DenseSymShiftSolve< Scalar >::DenseSymShiftSolve ( Matrix &  mat_ )

inline

Constructor to create the matrix operation object.

Parameters

mat_	An Armadillo matrix object, whose type can be arma::mat or arma::fmat, depending on the template parameter Scalar defined.

Definition at line 38 of file DenseSymShiftSolve.h.

Member Function Documentation

template<typename Scalar >

int DenseSymShiftSolve< Scalar >::rows ( )

inline

Return the number of rows of the underlying matrix.

Definition at line 49 of file DenseSymShiftSolve.h.

template<typename Scalar >

int DenseSymShiftSolve< Scalar >::cols ( )

inline

Return the number of columns of the underlying matrix.

Definition at line 53 of file DenseSymShiftSolve.h.

template<typename Scalar >

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

inline

Set the real shift \(\sigma\).

Definition at line 58 of file DenseSymShiftSolve.h.

template<typename Scalar >

void DenseSymShiftSolve< 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 70 of file DenseSymShiftSolve.h.

---

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

• MatOp/DenseSymShiftSolve.h