gtsam::ConjugateGradientParameters Class 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 (size_t minIterations, size_t maxIterations, size_t reset, double epsilon_rel, double epsilon_abs, BLASKernel blas)
	ConjugateGradientParameters (const ConjugateGradientParameters &p)
double	epsilon () const
double	epsilon_abs () const
double	epsilon_rel () const
double	getEpsilon () const
double	getEpsilon_abs () const
double	getEpsilon_rel () const
size_t	getMaxIterations () const
size_t	getMinIterations () const
size_t	getReset () const
size_t	maxIterations () const
size_t	minIterations () const
void	print () const
void	print (std::ostream &os) const override
size_t	reset () const
void	setEpsilon (double value)
void	setEpsilon_abs (double value)
void	setEpsilon_rel (double value)
void	setMaxIterations (size_t value)
void	setMinIterations (size_t value)
void	setReset (size_t value)
Public Member Functions inherited from gtsam::IterativeOptimizationParameters
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...
Public Attributes inherited from gtsam::IterativeOptimizationParameters
enum 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 32 of file ConjugateGradientSolver.h.

shared_ptr

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

Definition at line 33 of file ConjugateGradientSolver.h.

Member Enumeration Documentation

BLASKernel

enum gtsam::ConjugateGradientParameters::BLASKernel

Enumerator
GTSAM	Jacobian Factor Graph of GTSAM.

Definition at line 42 of file ConjugateGradientSolver.h.

Constructor & Destructor Documentation

ConjugateGradientParameters() [1/3]

gtsam::ConjugateGradientParameters::ConjugateGradientParameters ( )

inline

Definition at line 46 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 50 of file ConjugateGradientSolver.h.

ConjugateGradientParameters() [3/3]

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

inline

Definition at line 55 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.

epsilon()

double gtsam::ConjugateGradientParameters::epsilon ( ) const

inline

Definition at line 63 of file ConjugateGradientSolver.h.

epsilon_abs()

double gtsam::ConjugateGradientParameters::epsilon_abs ( ) const

inline

Definition at line 65 of file ConjugateGradientSolver.h.

epsilon_rel()

double gtsam::ConjugateGradientParameters::epsilon_rel ( ) const

inline

Definition at line 64 of file ConjugateGradientSolver.h.

getEpsilon()

double gtsam::ConjugateGradientParameters::getEpsilon ( ) const

inline

Definition at line 70 of file ConjugateGradientSolver.h.

getEpsilon_abs()

double gtsam::ConjugateGradientParameters::getEpsilon_abs ( ) const

inline

Definition at line 72 of file ConjugateGradientSolver.h.

getEpsilon_rel()

double gtsam::ConjugateGradientParameters::getEpsilon_rel ( ) const

inline

Definition at line 71 of file ConjugateGradientSolver.h.

getMaxIterations()

size_t gtsam::ConjugateGradientParameters::getMaxIterations ( ) const

inline

Definition at line 68 of file ConjugateGradientSolver.h.

getMinIterations()

size_t gtsam::ConjugateGradientParameters::getMinIterations ( ) const

inline

Definition at line 67 of file ConjugateGradientSolver.h.

getReset()

size_t gtsam::ConjugateGradientParameters::getReset ( ) const

inline

Definition at line 69 of file ConjugateGradientSolver.h.

maxIterations()

size_t gtsam::ConjugateGradientParameters::maxIterations ( ) const

inline

Definition at line 61 of file ConjugateGradientSolver.h.

minIterations()

size_t gtsam::ConjugateGradientParameters::minIterations ( ) const

inline

Definition at line 60 of file ConjugateGradientSolver.h.

print() [1/2]

void gtsam::ConjugateGradientParameters::print ( ) const

inline

Definition at line 82 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.

reset()

size_t gtsam::ConjugateGradientParameters::reset ( ) const

inline

Definition at line 62 of file ConjugateGradientSolver.h.

setEpsilon()

void gtsam::ConjugateGradientParameters::setEpsilon ( double  value )

inline

Definition at line 77 of file ConjugateGradientSolver.h.

setEpsilon_abs()

void gtsam::ConjugateGradientParameters::setEpsilon_abs ( double  value )

inline

Definition at line 79 of file ConjugateGradientSolver.h.

setEpsilon_rel()

void gtsam::ConjugateGradientParameters::setEpsilon_rel ( double  value )

inline

Definition at line 78 of file ConjugateGradientSolver.h.

setMaxIterations()

void gtsam::ConjugateGradientParameters::setMaxIterations ( size_t  value )

inline

Definition at line 75 of file ConjugateGradientSolver.h.

setMinIterations()

void gtsam::ConjugateGradientParameters::setMinIterations ( size_t  value )

inline

Definition at line 74 of file ConjugateGradientSolver.h.

setReset()

void gtsam::ConjugateGradientParameters::setReset ( size_t  value )

inline

Definition at line 76 of file ConjugateGradientSolver.h.

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 39 of file ConjugateGradientSolver.h.

epsilon_rel_

double gtsam::ConjugateGradientParameters::epsilon_rel_

threshold for relative error decrease

Definition at line 38 of file ConjugateGradientSolver.h.

maxIterations_

size_t gtsam::ConjugateGradientParameters::maxIterations_

maximum number of cg iterations

Definition at line 36 of file ConjugateGradientSolver.h.

minIterations_

size_t gtsam::ConjugateGradientParameters::minIterations_

minimum number of cg iterations

Definition at line 35 of file ConjugateGradientSolver.h.

reset_

size_t gtsam::ConjugateGradientParameters::reset_

number of iterations before reset

Definition at line 37 of file ConjugateGradientSolver.h.

---

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

• ConjugateGradientSolver.h
• ConjugateGradientSolver.cpp