Public Types | Public Member Functions | Protected Attributes | List of all members
gtsam::PCGSolver Class Reference

#include <PCGSolver.h>

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

Public Types

typedef IterativeSolver Base
 
typedef std::shared_ptr< PCGSolvershared_ptr
 
- Public Types inherited from gtsam::IterativeSolver
typedef std::shared_ptr< IterativeSolvershared_ptr
 

Public Member Functions

VectorValues optimize (const GaussianFactorGraph &gfg, const KeyInfo &keyInfo, const std::map< Key, Vector > &lambda, const VectorValues &initial) override
 
 PCGSolver (const PCGSolverParameters &p)
 
 ~PCGSolver () override
 
- Public Member Functions inherited from gtsam::IterativeSolver
 IterativeSolver ()
 
GTSAM_EXPORT VectorValues optimize (const GaussianFactorGraph &gfg, const KeyInfo *=nullptr, const std::map< Key, Vector > *lambda=nullptr)
 
GTSAM_EXPORT VectorValues optimize (const GaussianFactorGraph &gfg, const KeyInfo &keyInfo, const std::map< Key, Vector > &lambda)
 
virtual ~IterativeSolver ()
 

Protected Attributes

PCGSolverParameters parameters_
 
std::shared_ptr< Preconditionerpreconditioner_
 

Detailed Description

A virtual base class for the preconditioned conjugate gradient solver

Definition at line 62 of file PCGSolver.h.

Member Typedef Documentation

◆ Base

Definition at line 64 of file PCGSolver.h.

◆ shared_ptr

typedef std::shared_ptr<PCGSolver> gtsam::PCGSolver::shared_ptr

Definition at line 65 of file PCGSolver.h.

Constructor & Destructor Documentation

◆ PCGSolver()

gtsam::PCGSolver::PCGSolver ( const PCGSolverParameters p)

Definition at line 41 of file PCGSolver.cpp.

◆ ~PCGSolver()

gtsam::PCGSolver::~PCGSolver ( )
inlineoverride

Definition at line 75 of file PCGSolver.h.

Member Function Documentation

◆ optimize()

VectorValues gtsam::PCGSolver::optimize ( const GaussianFactorGraph gfg,
const KeyInfo keyInfo,
const std::map< Key, Vector > &  lambda,
const VectorValues initial 
)
overridevirtual

Implements gtsam::IterativeSolver.

Definition at line 58 of file PCGSolver.cpp.

Member Data Documentation

◆ parameters_

PCGSolverParameters gtsam::PCGSolver::parameters_
protected

Definition at line 69 of file PCGSolver.h.

◆ preconditioner_

std::shared_ptr<Preconditioner> gtsam::PCGSolver::preconditioner_
protected

Definition at line 70 of file PCGSolver.h.


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


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