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

#include <ArnoldiOp.h>

Public Member Functions

 ArnoldiOp (OpType *op, BOpType *Bop)
 
template<typename Arg1 , typename Arg2 >
Scalar inner_product (const Arg1 &x, const Arg2 &y)
 
template<typename Arg >
Scalar norm (const Arg &x)
 
void perform_op (const Scalar *x_in, Scalar *y_out)
 
Index rows () const
 
template<typename Arg1 , typename Arg2 >
void trans_product (const Arg1 &x, const Arg2 &y, Eigen::Ref< Vector > res)
 

Private Types

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

Private Attributes

BOpType & m_Bop
 
Vector m_cache
 
OpType & m_op
 

Detailed Description

template<typename Scalar, typename OpType, typename BOpType>
class Spectra::ArnoldiOp< Scalar, OpType, BOpType >

Operators used in the Arnoldi factorization.

Definition at line 32 of file ArnoldiOp.h.

Member Typedef Documentation

◆ Index

template<typename Scalar, typename OpType, typename BOpType>
typedef Eigen::Index Spectra::ArnoldiOp< Scalar, OpType, BOpType >::Index
private

Definition at line 35 of file ArnoldiOp.h.

◆ Vector

template<typename Scalar, typename OpType, typename BOpType>
typedef Eigen::Matrix<Scalar, Eigen::Dynamic, 1> Spectra::ArnoldiOp< Scalar, OpType, BOpType >::Vector
private

Definition at line 36 of file ArnoldiOp.h.

Constructor & Destructor Documentation

◆ ArnoldiOp()

template<typename Scalar, typename OpType, typename BOpType>
Spectra::ArnoldiOp< Scalar, OpType, BOpType >::ArnoldiOp ( OpType *  op,
BOpType *  Bop 
)
inline

Definition at line 43 of file ArnoldiOp.h.

Member Function Documentation

◆ inner_product()

template<typename Scalar, typename OpType, typename BOpType>
template<typename Arg1 , typename Arg2 >
Scalar Spectra::ArnoldiOp< Scalar, OpType, BOpType >::inner_product ( const Arg1 &  x,
const Arg2 &  y 
)
inline

Definition at line 55 of file ArnoldiOp.h.

◆ norm()

template<typename Scalar, typename OpType, typename BOpType>
template<typename Arg >
Scalar Spectra::ArnoldiOp< Scalar, OpType, BOpType >::norm ( const Arg &  x)
inline

Definition at line 72 of file ArnoldiOp.h.

◆ perform_op()

template<typename Scalar, typename OpType, typename BOpType>
void Spectra::ArnoldiOp< Scalar, OpType, BOpType >::perform_op ( const Scalar x_in,
Scalar y_out 
)
inline

Definition at line 79 of file ArnoldiOp.h.

◆ rows()

template<typename Scalar, typename OpType, typename BOpType>
Index Spectra::ArnoldiOp< Scalar, OpType, BOpType >::rows ( void  ) const
inline

Definition at line 47 of file ArnoldiOp.h.

◆ trans_product()

template<typename Scalar, typename OpType, typename BOpType>
template<typename Arg1 , typename Arg2 >
void Spectra::ArnoldiOp< Scalar, OpType, BOpType >::trans_product ( const Arg1 &  x,
const Arg2 &  y,
Eigen::Ref< Vector res 
)
inline

Definition at line 64 of file ArnoldiOp.h.

Member Data Documentation

◆ m_Bop

template<typename Scalar, typename OpType, typename BOpType>
BOpType& Spectra::ArnoldiOp< Scalar, OpType, BOpType >::m_Bop
private

Definition at line 39 of file ArnoldiOp.h.

◆ m_cache

template<typename Scalar, typename OpType, typename BOpType>
Vector Spectra::ArnoldiOp< Scalar, OpType, BOpType >::m_cache
private

Definition at line 40 of file ArnoldiOp.h.

◆ m_op

template<typename Scalar, typename OpType, typename BOpType>
OpType& Spectra::ArnoldiOp< Scalar, OpType, BOpType >::m_op
private

Definition at line 38 of file ArnoldiOp.h.


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


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