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

#include <Arnoldi.h>

Inheritance diagram for Spectra::Arnoldi< Scalar, ArnoldiOpType >:
Inheritance graph
[legend]

Public Member Functions

 Arnoldi (ArnoldiOpType &&op, Index m)
 
 Arnoldi (const ArnoldiOpType &op, Index m)
 
void compress_H (const DoubleShiftQR< Scalar > &decomp)
 
void compress_H (const UpperHessenbergQR< Scalar > &decomp)
 
template<typename Derived >
void compress_V (const Eigen::MatrixBase< Derived > &Q)
 
RealScalar f_norm () const
 
virtual void factorize_from (Index from_k, Index to_m, Index &op_counter)
 
void init (MapConstVec &v0, Index &op_counter)
 
const Matrix & matrix_H () const
 
const Matrix & matrix_V () const
 
Index subspace_dim () const
 
const Vector & vector_f () const
 

Protected Member Functions

void expand_basis (MapConstMat &V, const Index seed, Vector &f, RealScalar &fnorm, Index &op_counter)
 

Protected Attributes

RealScalar m_beta
 
const RealScalar m_eps = TypeTraits<RealScalar>::epsilon()
 
Vector m_fac_f
 
Matrix m_fac_H
 
Matrix m_fac_V
 
Index m_k
 
const Index m_m
 
const Index m_n
 
const RealScalar m_near_0 = TypeTraits<RealScalar>::min() * RealScalar(10)
 
ArnoldiOpType m_op
 

Private Types

using Index = Eigen::Index
 
using MapConstMat = Eigen::Map< const Matrix >
 
using MapConstVec = Eigen::Map< const Vector >
 
using MapVec = Eigen::Map< Vector >
 
using Matrix = Eigen::Matrix< Scalar, Eigen::Dynamic, Eigen::Dynamic >
 
using RealScalar = typename Eigen::NumTraits< Scalar >::Real
 
using Vector = Eigen::Matrix< Scalar, Eigen::Dynamic, 1 >
 

Detailed Description

template<typename Scalar, typename ArnoldiOpType>
class Spectra::Arnoldi< Scalar, ArnoldiOpType >

Definition at line 31 of file Arnoldi.h.

Member Typedef Documentation

◆ Index

template<typename Scalar , typename ArnoldiOpType >
using Spectra::Arnoldi< Scalar, ArnoldiOpType >::Index = Eigen::Index
private

Definition at line 36 of file Arnoldi.h.

◆ MapConstMat

template<typename Scalar , typename ArnoldiOpType >
using Spectra::Arnoldi< Scalar, ArnoldiOpType >::MapConstMat = Eigen::Map<const Matrix>
private

Definition at line 40 of file Arnoldi.h.

◆ MapConstVec

template<typename Scalar , typename ArnoldiOpType >
using Spectra::Arnoldi< Scalar, ArnoldiOpType >::MapConstVec = Eigen::Map<const Vector>
private

Definition at line 41 of file Arnoldi.h.

◆ MapVec

template<typename Scalar , typename ArnoldiOpType >
using Spectra::Arnoldi< Scalar, ArnoldiOpType >::MapVec = Eigen::Map<Vector>
private

Definition at line 39 of file Arnoldi.h.

◆ Matrix

template<typename Scalar , typename ArnoldiOpType >
using Spectra::Arnoldi< Scalar, ArnoldiOpType >::Matrix = Eigen::Matrix<Scalar, Eigen::Dynamic, Eigen::Dynamic>
private

Definition at line 37 of file Arnoldi.h.

◆ RealScalar

template<typename Scalar , typename ArnoldiOpType >
using Spectra::Arnoldi< Scalar, ArnoldiOpType >::RealScalar = typename Eigen::NumTraits<Scalar>::Real
private

Definition at line 35 of file Arnoldi.h.

◆ Vector

template<typename Scalar , typename ArnoldiOpType >
using Spectra::Arnoldi< Scalar, ArnoldiOpType >::Vector = Eigen::Matrix<Scalar, Eigen::Dynamic, 1>
private

Definition at line 38 of file Arnoldi.h.

Constructor & Destructor Documentation

◆ Arnoldi() [1/2]

template<typename Scalar , typename ArnoldiOpType >
Spectra::Arnoldi< Scalar, ArnoldiOpType >::Arnoldi ( const ArnoldiOpType &  op,
Index  m 
)
inline

Definition at line 115 of file Arnoldi.h.

◆ Arnoldi() [2/2]

template<typename Scalar , typename ArnoldiOpType >
Spectra::Arnoldi< Scalar, ArnoldiOpType >::Arnoldi ( ArnoldiOpType &&  op,
Index  m 
)
inline

Definition at line 120 of file Arnoldi.h.

Member Function Documentation

◆ compress_H() [1/2]

template<typename Scalar , typename ArnoldiOpType >
void Spectra::Arnoldi< Scalar, ArnoldiOpType >::compress_H ( const DoubleShiftQR< Scalar > &  decomp)
inline

Definition at line 283 of file Arnoldi.h.

◆ compress_H() [2/2]

template<typename Scalar , typename ArnoldiOpType >
void Spectra::Arnoldi< Scalar, ArnoldiOpType >::compress_H ( const UpperHessenbergQR< Scalar > &  decomp)
inline

Definition at line 290 of file Arnoldi.h.

◆ compress_V()

template<typename Scalar , typename ArnoldiOpType >
template<typename Derived >
void Spectra::Arnoldi< Scalar, ArnoldiOpType >::compress_V ( const Eigen::MatrixBase< Derived > &  Q)
inline

Definition at line 305 of file Arnoldi.h.

◆ expand_basis()

template<typename Scalar , typename ArnoldiOpType >
void Spectra::Arnoldi< Scalar, ArnoldiOpType >::expand_basis ( MapConstMat &  V,
const Index  seed,
Vector &  f,
RealScalar &  fnorm,
Index &  op_counter 
)
inlineprotected

Definition at line 62 of file Arnoldi.h.

◆ f_norm()

template<typename Scalar , typename ArnoldiOpType >
RealScalar Spectra::Arnoldi< Scalar, ArnoldiOpType >::f_norm ( ) const
inline

Definition at line 128 of file Arnoldi.h.

◆ factorize_from()

template<typename Scalar , typename ArnoldiOpType >
virtual void Spectra::Arnoldi< Scalar, ArnoldiOpType >::factorize_from ( Index  from_k,
Index  to_m,
Index &  op_counter 
)
inlinevirtual

Reimplemented in Spectra::Lanczos< Scalar, ArnoldiOpType >.

Definition at line 183 of file Arnoldi.h.

◆ init()

template<typename Scalar , typename ArnoldiOpType >
void Spectra::Arnoldi< Scalar, ArnoldiOpType >::init ( MapConstVec &  v0,
Index &  op_counter 
)
inline

Definition at line 132 of file Arnoldi.h.

◆ matrix_H()

template<typename Scalar , typename ArnoldiOpType >
const Matrix& Spectra::Arnoldi< Scalar, ArnoldiOpType >::matrix_H ( ) const
inline

Definition at line 126 of file Arnoldi.h.

◆ matrix_V()

template<typename Scalar , typename ArnoldiOpType >
const Matrix& Spectra::Arnoldi< Scalar, ArnoldiOpType >::matrix_V ( ) const
inline

Definition at line 125 of file Arnoldi.h.

◆ subspace_dim()

template<typename Scalar , typename ArnoldiOpType >
Index Spectra::Arnoldi< Scalar, ArnoldiOpType >::subspace_dim ( ) const
inline

Definition at line 129 of file Arnoldi.h.

◆ vector_f()

template<typename Scalar , typename ArnoldiOpType >
const Vector& Spectra::Arnoldi< Scalar, ArnoldiOpType >::vector_f ( ) const
inline

Definition at line 127 of file Arnoldi.h.

Member Data Documentation

◆ m_beta

template<typename Scalar , typename ArnoldiOpType >
RealScalar Spectra::Arnoldi< Scalar, ArnoldiOpType >::m_beta
protected

Definition at line 57 of file Arnoldi.h.

◆ m_eps

template<typename Scalar , typename ArnoldiOpType >
const RealScalar Spectra::Arnoldi< Scalar, ArnoldiOpType >::m_eps = TypeTraits<RealScalar>::epsilon()
protected

Definition at line 48 of file Arnoldi.h.

◆ m_fac_f

template<typename Scalar , typename ArnoldiOpType >
Vector Spectra::Arnoldi< Scalar, ArnoldiOpType >::m_fac_f
protected

Definition at line 56 of file Arnoldi.h.

◆ m_fac_H

template<typename Scalar , typename ArnoldiOpType >
Matrix Spectra::Arnoldi< Scalar, ArnoldiOpType >::m_fac_H
protected

Definition at line 55 of file Arnoldi.h.

◆ m_fac_V

template<typename Scalar , typename ArnoldiOpType >
Matrix Spectra::Arnoldi< Scalar, ArnoldiOpType >::m_fac_V
protected

Definition at line 54 of file Arnoldi.h.

◆ m_k

template<typename Scalar , typename ArnoldiOpType >
Index Spectra::Arnoldi< Scalar, ArnoldiOpType >::m_k
protected

Definition at line 53 of file Arnoldi.h.

◆ m_m

template<typename Scalar , typename ArnoldiOpType >
const Index Spectra::Arnoldi< Scalar, ArnoldiOpType >::m_m
protected

Definition at line 52 of file Arnoldi.h.

◆ m_n

template<typename Scalar , typename ArnoldiOpType >
const Index Spectra::Arnoldi< Scalar, ArnoldiOpType >::m_n
protected

Definition at line 51 of file Arnoldi.h.

◆ m_near_0

template<typename Scalar , typename ArnoldiOpType >
const RealScalar Spectra::Arnoldi< Scalar, ArnoldiOpType >::m_near_0 = TypeTraits<RealScalar>::min() * RealScalar(10)
protected

Definition at line 46 of file Arnoldi.h.

◆ m_op

template<typename Scalar , typename ArnoldiOpType >
ArnoldiOpType Spectra::Arnoldi< Scalar, ArnoldiOpType >::m_op
protected

Definition at line 50 of file Arnoldi.h.

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

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