gtsam::ConjugateGradientParameters Struct Reference

#include <ConjugateGradientSolver.h>

Inheritance diagram for gtsam::ConjugateGradientParameters:

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

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

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
enum gtsam::ConjugateGradientParameters::BLASKernel	blas_kernel
double	epsilon_abs
	threshold for absolute error decrease More...
double	epsilon_rel
	threshold for relative error decrease More...
size_t	maxIterations
	maximum number of cg iterations More...
size_t	minIterations
	minimum number of cg iterations More...
size_t	reset
	number of iterations before reset More...

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

Detailed Description

Parameters for the Conjugate Gradient method

Definition at line 29 of file ConjugateGradientSolver.h.

Member Typedef Documentation

Base

typedef IterativeOptimizationParameters gtsam::ConjugateGradientParameters::Base

Definition at line 31 of file ConjugateGradientSolver.h.

shared_ptr

typedef std::shared_ptr<ConjugateGradientParameters> gtsam::ConjugateGradientParameters::shared_ptr

Definition at line 32 of file ConjugateGradientSolver.h.

Member Enumeration Documentation

BLASKernel

enum gtsam::ConjugateGradientParameters::BLASKernel

Enumerator
GTSAM	Jacobian Factor Graph of GTSAM.

Definition at line 41 of file ConjugateGradientSolver.h.

Constructor & Destructor Documentation

ConjugateGradientParameters() [1/3]

gtsam::ConjugateGradientParameters::ConjugateGradientParameters ( )

inline

Definition at line 45 of file ConjugateGradientSolver.h.

ConjugateGradientParameters() [2/3]

gtsam::ConjugateGradientParameters::ConjugateGradientParameters ( size_t  minIterations, size_t  maxIterations, size_t  reset, double  epsilon_rel, double  epsilon_abs, BLASKernel  blas  )

inline

Definition at line 53 of file ConjugateGradientSolver.h.

ConjugateGradientParameters() [3/3]

gtsam::ConjugateGradientParameters::ConjugateGradientParameters ( const ConjugateGradientParameters &  p )

inline

Definition at line 63 of file ConjugateGradientSolver.h.

Member Function Documentation

blasTranslator() [1/2]

std::string gtsam::ConjugateGradientParameters::blasTranslator ( const BLASKernel  k )

static

Definition at line 39 of file ConjugateGradientSolver.cpp.

blasTranslator() [2/2]

ConjugateGradientParameters::BLASKernel gtsam::ConjugateGradientParameters::blasTranslator ( const std::string &  s )

static

Definition at line 49 of file ConjugateGradientSolver.cpp.

print() [1/2]

void gtsam::ConjugateGradientParameters::print ( ) const

inline

Definition at line 89 of file ConjugateGradientSolver.h.

print() [2/2]

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

overridevirtual

Reimplemented from gtsam::IterativeOptimizationParameters.

Reimplemented in gtsam::PCGSolverParameters, and gtsam::SubgraphSolverParameters.

Member Data Documentation

blas_kernel

enum gtsam::ConjugateGradientParameters::BLASKernel gtsam::ConjugateGradientParameters::blas_kernel

epsilon_abs

double gtsam::ConjugateGradientParameters::epsilon_abs

threshold for absolute error decrease

Definition at line 38 of file ConjugateGradientSolver.h.

epsilon_rel

double gtsam::ConjugateGradientParameters::epsilon_rel

threshold for relative error decrease

Definition at line 37 of file ConjugateGradientSolver.h.

maxIterations

size_t gtsam::ConjugateGradientParameters::maxIterations

maximum number of cg iterations

Definition at line 35 of file ConjugateGradientSolver.h.

minIterations

size_t gtsam::ConjugateGradientParameters::minIterations

minimum number of cg iterations

Definition at line 34 of file ConjugateGradientSolver.h.

reset

size_t gtsam::ConjugateGradientParameters::reset

number of iterations before reset

Definition at line 36 of file ConjugateGradientSolver.h.

---

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

• ConjugateGradientSolver.h
• ConjugateGradientSolver.cpp