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

#include <SymGEigsRegInvOp.h>

Public Member Functions

Index cols () const
 
void perform_op (const Scalar *x_in, Scalar *y_out)
 
Index rows () const
 
 SymGEigsRegInvOp (OpType &op, BOpType &Bop)
 

Private Types

typedef Eigen::Index Index
 
typedef Eigen::Matrix< Scalar, Eigen::Dynamic, Eigen::DynamicMatrix
 
typedef Eigen::Matrix< Scalar, Eigen::Dynamic, 1 > Vector
 

Private Attributes

BOpType & m_Bop
 
Vector m_cache
 
OpType & m_op
 

Detailed Description

template<typename Scalar = double, typename OpType = SparseSymMatProd<double>, typename BOpType = SparseRegularInverse<double>>
class Spectra::SymGEigsRegInvOp< Scalar, OpType, BOpType >

This class defines the matrix operation for generalized eigen solver in the regular inverse mode. This class is intended for internal use.

Definition at line 25 of file SymGEigsRegInvOp.h.

Member Typedef Documentation

◆ Index

template<typename Scalar = double, typename OpType = SparseSymMatProd<double>, typename BOpType = SparseRegularInverse<double>>
typedef Eigen::Index Spectra::SymGEigsRegInvOp< Scalar, OpType, BOpType >::Index
private

Definition at line 28 of file SymGEigsRegInvOp.h.

◆ Matrix

template<typename Scalar = double, typename OpType = SparseSymMatProd<double>, typename BOpType = SparseRegularInverse<double>>
typedef Eigen::Matrix<Scalar, Eigen::Dynamic, Eigen::Dynamic> Spectra::SymGEigsRegInvOp< Scalar, OpType, BOpType >::Matrix
private

Definition at line 29 of file SymGEigsRegInvOp.h.

◆ Vector

template<typename Scalar = double, typename OpType = SparseSymMatProd<double>, typename BOpType = SparseRegularInverse<double>>
typedef Eigen::Matrix<Scalar, Eigen::Dynamic, 1> Spectra::SymGEigsRegInvOp< Scalar, OpType, BOpType >::Vector
private

Definition at line 30 of file SymGEigsRegInvOp.h.

Constructor & Destructor Documentation

◆ SymGEigsRegInvOp()

template<typename Scalar = double, typename OpType = SparseSymMatProd<double>, typename BOpType = SparseRegularInverse<double>>
Spectra::SymGEigsRegInvOp< Scalar, OpType, BOpType >::SymGEigsRegInvOp ( OpType &  op,
BOpType &  Bop 
)
inline

Constructor to create the matrix operation object.

Parameters
opPointer to the $A$ matrix operation object.
BopPointer to the $B$ matrix operation object.

Definition at line 43 of file SymGEigsRegInvOp.h.

Member Function Documentation

◆ cols()

template<typename Scalar = double, typename OpType = SparseSymMatProd<double>, typename BOpType = SparseRegularInverse<double>>
Index Spectra::SymGEigsRegInvOp< Scalar, OpType, BOpType >::cols ( void  ) const
inline

Return the number of columns of the underlying matrix.

Definition at line 54 of file SymGEigsRegInvOp.h.

◆ perform_op()

template<typename Scalar = double, typename OpType = SparseSymMatProd<double>, typename BOpType = SparseRegularInverse<double>>
void Spectra::SymGEigsRegInvOp< Scalar, OpType, BOpType >::perform_op ( const Scalar x_in,
Scalar y_out 
)
inline

Perform the matrix operation $y=B^{-1}Ax$.

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

Definition at line 63 of file SymGEigsRegInvOp.h.

◆ rows()

template<typename Scalar = double, typename OpType = SparseSymMatProd<double>, typename BOpType = SparseRegularInverse<double>>
Index Spectra::SymGEigsRegInvOp< Scalar, OpType, BOpType >::rows ( void  ) const
inline

Return the number of rows of the underlying matrix.

Definition at line 50 of file SymGEigsRegInvOp.h.

Member Data Documentation

◆ m_Bop

template<typename Scalar = double, typename OpType = SparseSymMatProd<double>, typename BOpType = SparseRegularInverse<double>>
BOpType& Spectra::SymGEigsRegInvOp< Scalar, OpType, BOpType >::m_Bop
private

Definition at line 33 of file SymGEigsRegInvOp.h.

◆ m_cache

template<typename Scalar = double, typename OpType = SparseSymMatProd<double>, typename BOpType = SparseRegularInverse<double>>
Vector Spectra::SymGEigsRegInvOp< Scalar, OpType, BOpType >::m_cache
private

Definition at line 34 of file SymGEigsRegInvOp.h.

◆ m_op

template<typename Scalar = double, typename OpType = SparseSymMatProd<double>, typename BOpType = SparseRegularInverse<double>>
OpType& Spectra::SymGEigsRegInvOp< Scalar, OpType, BOpType >::m_op
private

Definition at line 32 of file SymGEigsRegInvOp.h.


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


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