#include <NonlinearOptimizerState.h>

Inheritance diagram for gtsam::internal::NonlinearOptimizerState:

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

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

virtual	~NonlinearOptimizerState ()

Public Attributes
const double	error

const size_t	iterations

const Values	values

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

Definition at line 34 of file NonlinearOptimizerState.h.

Constructor & Destructor Documentation

◆ ~NonlinearOptimizerState()

virtual gtsam::internal::NonlinearOptimizerState::~NonlinearOptimizerState ( )

inlinevirtual

Definition at line 45 of file NonlinearOptimizerState.h.

◆ NonlinearOptimizerState() [1/2]

gtsam::internal::NonlinearOptimizerState::NonlinearOptimizerState	(	const Values &	values,
		double	error,
		size_t	iterations = `0`
	)

inline

Definition at line 47 of file NonlinearOptimizerState.h.

◆ NonlinearOptimizerState() [2/2]

gtsam::internal::NonlinearOptimizerState::NonlinearOptimizerState	(	Values &&	values,
		double	error,
		size_t	iterations = `0`
	)

inline

Definition at line 51 of file NonlinearOptimizerState.h.

Member Data Documentation

◆ error

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

The factor graph error on the current values.

Definition at line 40 of file NonlinearOptimizerState.h.

◆ iterations

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

The number of optimization iterations performed.

Definition at line 43 of file NonlinearOptimizerState.h.

◆ values

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

The current estimate of the variable values.

Definition at line 37 of file NonlinearOptimizerState.h.

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

NonlinearOptimizerState.h

Public Member Functions

Public Attributes