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

#include <ArnoldiOp.h>

Public Member Functions

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

Private Types

using Index = Eigen::Index
 
using RealScalar = typename Eigen::NumTraits< Scalar >::Real
 
using Vector = Eigen::Matrix< Scalar, Eigen::Dynamic, 1 >
 

Private Attributes

const BOpType & m_Bop
 
Vector m_cache
 
const 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 33 of file ArnoldiOp.h.

Member Typedef Documentation

◆ Index

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

Definition at line 38 of file ArnoldiOp.h.

◆ RealScalar

template<typename Scalar , typename OpType , typename BOpType >
using Spectra::ArnoldiOp< Scalar, OpType, BOpType >::RealScalar = typename Eigen::NumTraits<Scalar>::Real
private

Definition at line 37 of file ArnoldiOp.h.

◆ Vector

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

Definition at line 39 of file ArnoldiOp.h.

Constructor & Destructor Documentation

◆ ArnoldiOp() [1/2]

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

Definition at line 46 of file ArnoldiOp.h.

◆ ArnoldiOp() [2/2]

template<typename Scalar , typename OpType , typename BOpType >
Spectra::ArnoldiOp< Scalar, OpType, BOpType >::ArnoldiOp ( ArnoldiOp< Scalar, OpType, BOpType > &&  other)
inline

Definition at line 51 of file ArnoldiOp.h.

Member Function Documentation

◆ adjoint_product()

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

Definition at line 75 of file ArnoldiOp.h.

◆ 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 
) const
inline

Definition at line 66 of file ArnoldiOp.h.

◆ norm()

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

Definition at line 83 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 
) const
inline

Definition at line 91 of file ArnoldiOp.h.

◆ rows()

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

Definition at line 58 of file ArnoldiOp.h.

Member Data Documentation

◆ m_Bop

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

Definition at line 42 of file ArnoldiOp.h.

◆ m_cache

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

Definition at line 43 of file ArnoldiOp.h.

◆ m_op

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

Definition at line 41 of file ArnoldiOp.h.

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

gtsam
Author(s):
autogenerated on Fri Mar 28 2025 03:16:38