gtsam::NonlinearOptimizerState Class Reference

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).

Inheritance diagram for gtsam::NonlinearOptimizerState:

Public Member Functions
virtual	~NonlinearOptimizerState ()
	Virtual destructor.

Public Attributes
Values	values
	The current estimate of the variable values. More...
double	error
	The factor graph error on the current values. More...
int	iterations
	The number of optimization iterations performed. More...

Protected Member Functions
	NonlinearOptimizerState (const NonlinearFactorGraph &graph, const Values &values, unsigned int iterations=0)
	NonlinearOptimizerState (const Values &values, double error, unsigned int iterations)

Friends
class	NonlinearOptimizer

Member Data Documentation

double gtsam::NonlinearOptimizerState::error

The factor graph error on the current values.

int gtsam::NonlinearOptimizerState::iterations

The number of optimization iterations performed.

Values gtsam::NonlinearOptimizerState::values

The current estimate of the variable values.

---

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

• /home/cbeall3/git/gtsam/gtsam/nonlinear/NonlinearOptimizer.h