GTSAM  4.0.2
C++ library for smoothing and mapping (SAM)
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
gtsam::ConjugateGradientParameters Class Reference

#include <ConjugateGradientSolver.h>

Inheritance diagram for gtsam::ConjugateGradientParameters:
Inheritance graph
[legend]
Collaboration diagram for gtsam::ConjugateGradientParameters:
Collaboration graph
[legend]

Public Types

enum  BLASKernel { GTSAM = 0 }
 
typedef IterativeOptimizationParameters Base
 
typedef std::shared_ptr< ConjugateGradientParametersshared_ptr
 
enum  Verbosity { SILENT = 0, COMPLEXITY, ERROR }
 

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)
 
size_t minIterations () const
 
size_t maxIterations () const
 
size_t reset () const
 
double epsilon () const
 
double epsilon_rel () const
 
double epsilon_abs () const
 
size_t getMinIterations () const
 
size_t getMaxIterations () const
 
size_t getReset () const
 
double getEpsilon () const
 
double getEpsilon_rel () const
 
double getEpsilon_abs () const
 
void setMinIterations (size_t value)
 
void setMaxIterations (size_t value)
 
void setReset (size_t value)
 
void setEpsilon (double value)
 
void setEpsilon_rel (double value)
 
void setEpsilon_abs (double value)
 
void print () const
 
void print (std::ostream &os) const override
 
Verbosity verbosity () const
 
GTSAM_EXPORT std::string getVerbosity () const
 
GTSAM_EXPORT void setVerbosity (const std::string &s)
 

Static Public Member Functions

static std::string blasTranslator (const BLASKernel k)
 
static BLASKernel blasTranslator (const std::string &s)
 
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_
 
enum gtsam::IterativeOptimizationParameters::Verbosity verbosity_
 

Detailed Description

parameters for the conjugate gradient method

Member Enumeration Documentation

◆ BLASKernel

Enumerator
GTSAM 

Jacobian Factor Graph of GTSAM.


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