Detailed Description

The common parameters for Nonlinear optimizers.

Most optimizers deriving from NonlinearOptimizer also subclass the parameters.

Inheritance diagram for gtsam::NonlinearOptimizerParams:

Public Member Functions
virtual void	print (const std::string &str="") const

size_t	getMaxIterations () const

double	getRelativeErrorTol () const

double	getAbsoluteErrorTol () const

double	getErrorTol () const

std::string	getVerbosity () const

void	setMaxIterations (int value)

void	setRelativeErrorTol (double value)

void	setAbsoluteErrorTol (double value)

void	setErrorTol (double value)

void	setVerbosity (const std::string &src)

bool	isMultifrontal () const

bool	isSequential () const

bool	isCholmod () const

bool	isIterative () const

GaussianFactorGraph::Eliminate	getEliminationFunction () const

std::string	getLinearSolverType () const

void	setLinearSolverType (const std::string &solver)

void	setIterativeParams (const boost::shared_ptr< IterativeOptimizationParameters > params)

void	setOrdering (const Ordering &ordering)

std::string	getOrderingType () const

void	setOrderingType (const std::string &ordering)

Static Public Member Functions
static Verbosity	verbosityTranslator (const std::string &s)

static std::string	verbosityTranslator (Verbosity value)

Public Attributes
size_t	maxIterations
	The maximum iterations to stop iterating (default 100)

double	relativeErrorTol
	The maximum relative error decrease to stop iterating (default 1e-5)

double	absoluteErrorTol
	The maximum absolute error decrease to stop iterating (default 1e-5)

double	errorTol
	The maximum total error to stop iterating (default 0.0)

Verbosity	verbosity
	The printing verbosity during optimization (default SILENT)

Ordering::OrderingType	orderingType
	The method of ordering use during variable elimination (default COLAMD)

LinearSolverType	linearSolverType
	The type of linear solver to use in the nonlinear optimizer.

boost::optional< Ordering >	ordering
	The variable elimination ordering, or empty to use COLAMD (default: empty)

IterativeOptimizationParameters::shared_ptr	iterativeParams
	The container for iterativeOptimization parameters. used in CG Solvers.

Public Types
enum	Verbosity { SILENT, TERMINATION, ERROR, VALUES, DELTA, LINEAR }
	See NonlinearOptimizerParams::verbosity.

enum	LinearSolverType { MULTIFRONTAL_CHOLESKY, MULTIFRONTAL_QR, SEQUENTIAL_CHOLESKY, SEQUENTIAL_QR, Iterative, CHOLMOD }
	See NonlinearOptimizerParams::linearSolverType.

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

Public Member Functions