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

#include <Lanczos.h>

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

Public Member Functions

void compress_H (const TridiagQR< RealScalar > &decomp)
 
void deflate_H (Index irr_size, const Scalar &s)
 
void factorize_from (Index from_k, Index to_m, Index &op_counter) override
 
template<typename T >
 Lanczos (T &&op, Index m)
 
- Public Member Functions inherited from Spectra::Arnoldi< Scalar, ArnoldiOpType >
 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
 
void init (MapConstVec &v0, Index &op_counter)
 
const Matrixmatrix_H () const
 
const Matrixmatrix_V () const
 
Index subspace_dim () const
 
const Vectorvector_f () const
 

Private Types

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

Additional Inherited Members

- Protected Member Functions inherited from Spectra::Arnoldi< Scalar, ArnoldiOpType >
void expand_basis (MapConstMat &V, const Index seed, Vector &f, RealScalar &fnorm, Index &op_counter)
 
- Protected Attributes inherited from Spectra::Arnoldi< Scalar, ArnoldiOpType >
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
 

Detailed Description

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

Definition at line 27 of file Lanczos.h.

Member Typedef Documentation

◆ Index

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

Definition at line 32 of file Lanczos.h.

◆ MapConstMat

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

Definition at line 37 of file Lanczos.h.

◆ MapMat

template<typename Scalar , typename ArnoldiOpType >
using Spectra::Lanczos< Scalar, ArnoldiOpType >::MapMat = Eigen::Map<Matrix>
private

Definition at line 35 of file Lanczos.h.

◆ MapVec

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

Definition at line 36 of file Lanczos.h.

◆ Matrix

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

Definition at line 33 of file Lanczos.h.

◆ RealMatrix

template<typename Scalar , typename ArnoldiOpType >
using Spectra::Lanczos< Scalar, ArnoldiOpType >::RealMatrix = Eigen::Matrix<RealScalar, Eigen::Dynamic, Eigen::Dynamic>
private

Definition at line 38 of file Lanczos.h.

◆ RealScalar

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

Definition at line 31 of file Lanczos.h.

◆ Vector

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

Definition at line 34 of file Lanczos.h.

Constructor & Destructor Documentation

◆ Lanczos()

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

Definition at line 54 of file Lanczos.h.

Member Function Documentation

◆ compress_H()

template<typename Scalar , typename ArnoldiOpType >
void Spectra::Lanczos< Scalar, ArnoldiOpType >::compress_H ( const TridiagQR< RealScalar > &  decomp)
inline

Definition at line 195 of file Lanczos.h.

◆ deflate_H()

template<typename Scalar , typename ArnoldiOpType >
void Spectra::Lanczos< Scalar, ArnoldiOpType >::deflate_H ( Index  irr_size,
const Scalar s 
)
inline

Definition at line 209 of file Lanczos.h.

◆ factorize_from()

template<typename Scalar , typename ArnoldiOpType >
void Spectra::Lanczos< Scalar, ArnoldiOpType >::factorize_from ( Index  from_k,
Index  to_m,
Index op_counter 
)
inlineoverridevirtual

Reimplemented from Spectra::Arnoldi< Scalar, ArnoldiOpType >.

Definition at line 59 of file Lanczos.h.


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


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