Public Types | Public Member Functions | List of all members
gtsam::Preconditioner Class Referenceabstract

#include <Preconditioner.h>

Inheritance diagram for gtsam::Preconditioner:
Inheritance graph
[legend]

Public Types

typedef std::vector< size_tDimensions
 
typedef std::shared_ptr< Preconditionershared_ptr
 

Public Member Functions

virtual void build (const GaussianFactorGraph &gfg, const KeyInfo &info, const std::map< Key, Vector > &lambda)=0
 build/factorize the preconditioner More...
 
 Preconditioner ()
 
virtual void solve (const Vector &y, Vector &x) const =0
 implement x = L^{-1} y More...
 
virtual void transposeSolve (const Vector &y, Vector &x) const =0
 implement x = L^{-T} y More...
 
virtual ~Preconditioner ()
 

Detailed Description

Definition at line 64 of file Preconditioner.h.

Member Typedef Documentation

◆ Dimensions

Definition at line 67 of file Preconditioner.h.

◆ shared_ptr

Definition at line 66 of file Preconditioner.h.

Constructor & Destructor Documentation

◆ Preconditioner()

gtsam::Preconditioner::Preconditioner ( )
inline

Definition at line 70 of file Preconditioner.h.

◆ ~Preconditioner()

virtual gtsam::Preconditioner::~Preconditioner ( )
inlinevirtual

Definition at line 71 of file Preconditioner.h.

Member Function Documentation

◆ build()

virtual void gtsam::Preconditioner::build ( const GaussianFactorGraph gfg,
const KeyInfo info,
const std::map< Key, Vector > &  lambda 
)
pure virtual

build/factorize the preconditioner

Implemented in gtsam::SubgraphPreconditioner, gtsam::BlockJacobiPreconditioner, and gtsam::DummyPreconditioner.

◆ solve()

virtual void gtsam::Preconditioner::solve ( const Vector y,
Vector x 
) const
pure virtual

◆ transposeSolve()

virtual void gtsam::Preconditioner::transposeSolve ( const Vector y,
Vector x 
) const
pure virtual

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


gtsam
Author(s):
autogenerated on Fri Nov 1 2024 03:52:42