Public Member Functions | Private Types | Private Attributes | List of all members
Spectra::SymGEigsCholeskyOp< Scalar, OpType, BOpType > Class Template Reference
Internal Classes » Operators

#include <SymGEigsCholeskyOp.h>

Public Member Functions

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

Private Types

typedef Eigen::Index Index
 
typedef Eigen::Matrix< Scalar, Eigen::Dynamic, Eigen::Dynamic > Matrix
 
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 = DenseSymMatProd<double>, typename BOpType = DenseCholesky<double>>
class Spectra::SymGEigsCholeskyOp< Scalar, OpType, BOpType >

This class defines the matrix operation for generalized eigen solver in the Cholesky decomposition mode. It calculates $y=L^{-1}A(L')^{-1}x$ for any vector $x$, where $L$ is the Cholesky decomposition of $B$. This class is intended for internal use.

Definition at line 27 of file SymGEigsCholeskyOp.h.

Member Typedef Documentation

◆ Index

template<typename Scalar = double, typename OpType = DenseSymMatProd<double>, typename BOpType = DenseCholesky<double>>
typedef Eigen::Index Spectra::SymGEigsCholeskyOp< Scalar, OpType, BOpType >::Index
private

Definition at line 30 of file SymGEigsCholeskyOp.h.

◆ Matrix

template<typename Scalar = double, typename OpType = DenseSymMatProd<double>, typename BOpType = DenseCholesky<double>>
typedef Eigen::Matrix<Scalar, Eigen::Dynamic, Eigen::Dynamic> Spectra::SymGEigsCholeskyOp< Scalar, OpType, BOpType >::Matrix
private

Definition at line 31 of file SymGEigsCholeskyOp.h.

◆ Vector

template<typename Scalar = double, typename OpType = DenseSymMatProd<double>, typename BOpType = DenseCholesky<double>>
typedef Eigen::Matrix<Scalar, Eigen::Dynamic, 1> Spectra::SymGEigsCholeskyOp< Scalar, OpType, BOpType >::Vector
private

Definition at line 32 of file SymGEigsCholeskyOp.h.

Constructor & Destructor Documentation

◆ SymGEigsCholeskyOp()

template<typename Scalar = double, typename OpType = DenseSymMatProd<double>, typename BOpType = DenseCholesky<double>>
Spectra::SymGEigsCholeskyOp< Scalar, OpType, BOpType >::SymGEigsCholeskyOp ( 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 45 of file SymGEigsCholeskyOp.h.

Member Function Documentation

◆ cols()

template<typename Scalar = double, typename OpType = DenseSymMatProd<double>, typename BOpType = DenseCholesky<double>>
Index Spectra::SymGEigsCholeskyOp< Scalar, OpType, BOpType >::cols ( void  ) const
inline

Return the number of columns of the underlying matrix.

Definition at line 56 of file SymGEigsCholeskyOp.h.

◆ perform_op()

template<typename Scalar = double, typename OpType = DenseSymMatProd<double>, typename BOpType = DenseCholesky<double>>
void Spectra::SymGEigsCholeskyOp< Scalar, OpType, BOpType >::perform_op ( const Scalar *  x_in,
Scalar *  y_out 
)
inline

Perform the matrix operation $y=L^{-1}A(L')^{-1}x$.

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

Definition at line 65 of file SymGEigsCholeskyOp.h.

◆ rows()

template<typename Scalar = double, typename OpType = DenseSymMatProd<double>, typename BOpType = DenseCholesky<double>>
Index Spectra::SymGEigsCholeskyOp< Scalar, OpType, BOpType >::rows ( void  ) const
inline

Return the number of rows of the underlying matrix.

Definition at line 52 of file SymGEigsCholeskyOp.h.

Member Data Documentation

◆ m_Bop

template<typename Scalar = double, typename OpType = DenseSymMatProd<double>, typename BOpType = DenseCholesky<double>>
BOpType& Spectra::SymGEigsCholeskyOp< Scalar, OpType, BOpType >::m_Bop
private

Definition at line 35 of file SymGEigsCholeskyOp.h.

◆ m_cache

template<typename Scalar = double, typename OpType = DenseSymMatProd<double>, typename BOpType = DenseCholesky<double>>
Vector Spectra::SymGEigsCholeskyOp< Scalar, OpType, BOpType >::m_cache
private

Definition at line 36 of file SymGEigsCholeskyOp.h.

◆ m_op

template<typename Scalar = double, typename OpType = DenseSymMatProd<double>, typename BOpType = DenseCholesky<double>>
OpType& Spectra::SymGEigsCholeskyOp< Scalar, OpType, BOpType >::m_op
private

Definition at line 34 of file SymGEigsCholeskyOp.h.

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

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