Public Member Functions | Private Types | Private Attributes | List of all members
Spectra::DenseSymShiftSolve< Scalar, Uplo > Class Template Reference

#include <DenseSymShiftSolve.h>

Public Member Functions

Index cols () const
 
 DenseSymShiftSolve (ConstGenericMatrix &mat)
 
void perform_op (const Scalar *x_in, Scalar *y_out) const
 
Index rows () const
 
void set_shift (Scalar sigma)
 

Private Types

typedef const Eigen::Ref< const MatrixConstGenericMatrix
 
typedef Eigen::Index Index
 
typedef Eigen::Map< const VectorMapConstVec
 
typedef Eigen::Map< VectorMapVec
 
typedef Eigen::Matrix< Scalar, Eigen::Dynamic, Eigen::DynamicMatrix
 
typedef Eigen::Matrix< Scalar, Eigen::Dynamic, 1 > Vector
 

Private Attributes

ConstGenericMatrix m_mat
 
const int m_n
 
BKLDLT< Scalarm_solver
 

Detailed Description

template<typename Scalar, int Uplo = Eigen::Lower>
class Spectra::DenseSymShiftSolve< Scalar, Uplo >

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

Member Typedef Documentation

◆ ConstGenericMatrix

template<typename Scalar , int Uplo = Eigen::Lower>
typedef const Eigen::Ref<const Matrix> Spectra::DenseSymShiftSolve< Scalar, Uplo >::ConstGenericMatrix
private

Definition at line 34 of file DenseSymShiftSolve.h.

◆ Index

template<typename Scalar , int Uplo = Eigen::Lower>
typedef Eigen::Index Spectra::DenseSymShiftSolve< Scalar, Uplo >::Index
private

Definition at line 29 of file DenseSymShiftSolve.h.

◆ MapConstVec

template<typename Scalar , int Uplo = Eigen::Lower>
typedef Eigen::Map<const Vector> Spectra::DenseSymShiftSolve< Scalar, Uplo >::MapConstVec
private

Definition at line 32 of file DenseSymShiftSolve.h.

◆ MapVec

template<typename Scalar , int Uplo = Eigen::Lower>
typedef Eigen::Map<Vector> Spectra::DenseSymShiftSolve< Scalar, Uplo >::MapVec
private

Definition at line 33 of file DenseSymShiftSolve.h.

◆ Matrix

template<typename Scalar , int Uplo = Eigen::Lower>
typedef Eigen::Matrix<Scalar, Eigen::Dynamic, Eigen::Dynamic> Spectra::DenseSymShiftSolve< Scalar, Uplo >::Matrix
private

Definition at line 30 of file DenseSymShiftSolve.h.

◆ Vector

template<typename Scalar , int Uplo = Eigen::Lower>
typedef Eigen::Matrix<Scalar, Eigen::Dynamic, 1> Spectra::DenseSymShiftSolve< Scalar, Uplo >::Vector
private

Definition at line 31 of file DenseSymShiftSolve.h.

Constructor & Destructor Documentation

◆ DenseSymShiftSolve()

template<typename Scalar , int Uplo = Eigen::Lower>
Spectra::DenseSymShiftSolve< Scalar, Uplo >::DenseSymShiftSolve ( ConstGenericMatrix mat)
inline

Constructor to create the matrix operation object.

Parameters
matAn 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 49 of file DenseSymShiftSolve.h.

Member Function Documentation

◆ cols()

template<typename Scalar , int Uplo = Eigen::Lower>
Index Spectra::DenseSymShiftSolve< Scalar, Uplo >::cols ( void  ) const
inline

Return the number of columns of the underlying matrix.

Definition at line 63 of file DenseSymShiftSolve.h.

◆ perform_op()

template<typename Scalar , int Uplo = Eigen::Lower>
void Spectra::DenseSymShiftSolve< Scalar, Uplo >::perform_op ( const Scalar x_in,
Scalar y_out 
) const
inline

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

Parameters
x_inPointer to the $x$ vector.
y_outPointer to the $y$ vector.

Definition at line 82 of file DenseSymShiftSolve.h.

◆ rows()

template<typename Scalar , int Uplo = Eigen::Lower>
Index Spectra::DenseSymShiftSolve< Scalar, Uplo >::rows ( void  ) const
inline

Return the number of rows of the underlying matrix.

Definition at line 59 of file DenseSymShiftSolve.h.

◆ set_shift()

template<typename Scalar , int Uplo = Eigen::Lower>
void Spectra::DenseSymShiftSolve< Scalar, Uplo >::set_shift ( Scalar  sigma)
inline

Set the real shift $\sigma$.

Definition at line 68 of file DenseSymShiftSolve.h.

Member Data Documentation

◆ m_mat

template<typename Scalar , int Uplo = Eigen::Lower>
ConstGenericMatrix Spectra::DenseSymShiftSolve< Scalar, Uplo >::m_mat
private

Definition at line 36 of file DenseSymShiftSolve.h.

◆ m_n

template<typename Scalar , int Uplo = Eigen::Lower>
const int Spectra::DenseSymShiftSolve< Scalar, Uplo >::m_n
private

Definition at line 37 of file DenseSymShiftSolve.h.

◆ m_solver

template<typename Scalar , int Uplo = Eigen::Lower>
BKLDLT<Scalar> Spectra::DenseSymShiftSolve< Scalar, Uplo >::m_solver
private

Definition at line 38 of file DenseSymShiftSolve.h.


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


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:47:31