gtsam::ConjugateGradientParameters Struct Reference

Detailed Description

Parameters for the Conjugate Gradient method.

Inheritance diagram for gtsam::ConjugateGradientParameters:

Public Member Functions
	ConjugateGradientParameters (size_t minIterations, size_t maxIterations, size_t reset, double epsilon_rel, double epsilon_abs, BLASKernel blas)
	ConjugateGradientParameters (const ConjugateGradientParameters &p)
ConjugateGradientParameters &	operator= (const ConjugateGradientParameters &other)=default
void	print () const
void	print (std::ostream &os) const override
Public Member Functions inherited from gtsam::IterativeOptimizationParameters
	IterativeOptimizationParameters (Verbosity v=SILENT)
Verbosity	verbosity () const
GTSAM_EXPORT std::string	getVerbosity () const
GTSAM_EXPORT void	setVerbosity (const std::string &s)
GTSAM_EXPORT void	print () const
virtual GTSAM_EXPORT bool	equals (const IterativeOptimizationParameters &other, double tol=1e-9) const

Static Public Member Functions
static std::string	blasTranslator (const BLASKernel k)
static BLASKernel	blasTranslator (const std::string &s)
Static Public Member Functions inherited from gtsam::IterativeOptimizationParameters
static GTSAM_EXPORT Verbosity	verbosityTranslator (const std::string &s)
static GTSAM_EXPORT std::string	verbosityTranslator (Verbosity v)

Public Attributes
size_t	minIterations
	minimum number of cg iterations
size_t	maxIterations
	maximum number of cg iterations
size_t	reset
	number of iterations before reset
double	epsilon_rel
	threshold for relative error decrease
double	epsilon_abs
	threshold for absolute error decrease
enum gtsam::ConjugateGradientParameters::BLASKernel	blas_kernel

Public Types
enum	BLASKernel { GTSAM = 0 }
typedef IterativeOptimizationParameters	Base
typedef std::shared_ptr< ConjugateGradientParameters >	shared_ptr
Public Types inherited from gtsam::IterativeOptimizationParameters
enum	Verbosity { SILENT = 0 , COMPLEXITY , ERROR }
typedef std::shared_ptr< IterativeOptimizationParameters >	shared_ptr

Additional Inherited Members
Protected Attributes inherited from gtsam::IterativeOptimizationParameters
Verbosity	verbosity_

Member Enumeration Documentation

BLASKernel

enum gtsam::ConjugateGradientParameters::BLASKernel

Enumerator
GTSAM	Jacobian Factor Graph of GTSAM.

Member Function Documentation

print()

void gtsam::ConjugateGradientParameters::print ( std::ostream & os ) const

overridevirtual

Reimplemented from gtsam::IterativeOptimizationParameters.

---

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

• /tmp/gtsam-4.3.0-doxygen.rsXPUS/source/gtsam/linear/ConjugateGradientSolver.h
• /tmp/gtsam-4.3.0-doxygen.rsXPUS/source/gtsam/linear/ConjugateGradientSolver.cpp