GTSAM  4.0.2
C++ library for smoothing and mapping (SAM)
Public Member Functions | Public Attributes | List of all members
gtsam::internal::NonlinearOptimizerState Struct Reference

#include <NonlinearOptimizerState.h>

Inheritance diagram for gtsam::internal::NonlinearOptimizerState:
Inheritance graph
[legend]
Collaboration diagram for gtsam::internal::NonlinearOptimizerState:
Collaboration graph
[legend]

Public Member Functions

 NonlinearOptimizerState (const Values &values, double error, size_t iterations=0)
 
 NonlinearOptimizerState (Values &&values, double error, size_t iterations=0)
 

Public Attributes

const Values values
 
const double error
 
const size_t iterations
 

Detailed Description

Base class for a nonlinear optimization state, including the current estimate of the variable values, error, and number of iterations. Optimizers derived from NonlinearOptimizer usually also define a derived state class containing additional state specific to the algorithm (for example, Dogleg state contains the current trust region radius).

Member Data Documentation

◆ error

const double gtsam::internal::NonlinearOptimizerState::error

The factor graph error on the current values.

◆ iterations

const size_t gtsam::internal::NonlinearOptimizerState::iterations

The number of optimization iterations performed.

◆ values

const Values gtsam::internal::NonlinearOptimizerState::values

The current estimate of the variable values.


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