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

#include <NonlinearConjugateGradientOptimizer.h>

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

Classes

class  System
 

Public Types

typedef NonlinearOptimizer Base
 
typedef NonlinearOptimizerParams Parameters
 
typedef std::shared_ptr< NonlinearConjugateGradientOptimizershared_ptr
 
- Public Types inherited from gtsam::NonlinearOptimizer
using shared_ptr = std::shared_ptr< const NonlinearOptimizer >
 

Public Member Functions

GaussianFactorGraph::shared_ptr iterate () override
 
 NonlinearConjugateGradientOptimizer (const NonlinearFactorGraph &graph, const Values &initialValues, const Parameters &params=Parameters(), const DirectionMethod &directionMethod=DirectionMethod::PolakRibiere)
 Constructor. More...
 
const Valuesoptimize () override
 
 ~NonlinearConjugateGradientOptimizer () override
 Destructor. More...
 
- Public Member Functions inherited from gtsam::NonlinearOptimizer
const ValuesoptimizeSafely ()
 
double error () const
 return error in current optimizer state More...
 
size_t iterations () const
 return number of iterations in current optimizer state More...
 
const Valuesvalues () const
 return values in current optimizer state More...
 
const NonlinearFactorGraphgraph () const
 return the graph with nonlinear factors More...
 
virtual ~NonlinearOptimizer ()
 
virtual VectorValues solve (const GaussianFactorGraph &gfg, const NonlinearOptimizerParams &params) const
 

Protected Member Functions

const NonlinearOptimizerParams_params () const override
 
- Protected Member Functions inherited from gtsam::NonlinearOptimizer
void defaultOptimize ()
 
 NonlinearOptimizer (const NonlinearFactorGraph &graph, std::unique_ptr< internal::NonlinearOptimizerState > state)
 

Protected Attributes

DirectionMethod directionMethod_ = DirectionMethod::PolakRibiere
 
Parameters params_
 
- Protected Attributes inherited from gtsam::NonlinearOptimizer
NonlinearFactorGraph graph_
 The graph with nonlinear factors. More...
 
std::unique_ptr< internal::NonlinearOptimizerStatestate_
 PIMPL'd state. More...
 

Detailed Description

An implementation of the nonlinear CG method using the template below

Definition at line 80 of file NonlinearConjugateGradientOptimizer.h.

Member Typedef Documentation

◆ Base

Definition at line 101 of file NonlinearConjugateGradientOptimizer.h.

◆ Parameters

Definition at line 102 of file NonlinearConjugateGradientOptimizer.h.

◆ shared_ptr

Definition at line 103 of file NonlinearConjugateGradientOptimizer.h.

Constructor & Destructor Documentation

◆ NonlinearConjugateGradientOptimizer()

gtsam::NonlinearConjugateGradientOptimizer::NonlinearConjugateGradientOptimizer ( const NonlinearFactorGraph graph,
const Values initialValues,
const Parameters params = Parameters(),
const DirectionMethod directionMethod = DirectionMethod::PolakRibiere 
)

Constructor.

Definition at line 44 of file NonlinearConjugateGradientOptimizer.cpp.

◆ ~NonlinearConjugateGradientOptimizer()

gtsam::NonlinearConjugateGradientOptimizer::~NonlinearConjugateGradientOptimizer ( )
inlineoverride

Destructor.

Definition at line 119 of file NonlinearConjugateGradientOptimizer.h.

Member Function Documentation

◆ _params()

const NonlinearOptimizerParams& gtsam::NonlinearConjugateGradientOptimizer::_params ( ) const
inlineoverrideprotectedvirtual

Implements gtsam::NonlinearOptimizer.

Definition at line 109 of file NonlinearConjugateGradientOptimizer.h.

◆ iterate()

GaussianFactorGraph::shared_ptr gtsam::NonlinearConjugateGradientOptimizer::iterate ( )
overridevirtual

Perform a single iteration, returning GaussianFactorGraph corresponding to the linearized factor graph.

Implements gtsam::NonlinearOptimizer.

Definition at line 71 of file NonlinearConjugateGradientOptimizer.cpp.

◆ optimize()

const Values & gtsam::NonlinearConjugateGradientOptimizer::optimize ( )
overridevirtual

Optimize for the maximum-likelihood estimate, returning a the optimized variable assignments.

Reimplemented from gtsam::NonlinearOptimizer.

Definition at line 82 of file NonlinearConjugateGradientOptimizer.cpp.

Member Data Documentation

◆ directionMethod_

DirectionMethod gtsam::NonlinearConjugateGradientOptimizer::directionMethod_ = DirectionMethod::PolakRibiere
protected

Definition at line 107 of file NonlinearConjugateGradientOptimizer.h.

◆ params_

Parameters gtsam::NonlinearConjugateGradientOptimizer::params_
protected

Definition at line 106 of file NonlinearConjugateGradientOptimizer.h.


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


gtsam
Author(s):
autogenerated on Sun Dec 22 2024 04:24:40