Public Types | Public Member Functions | Public Attributes | List of all members
gtsam::PCGSolverParameters Struct Reference

#include <PCGSolver.h>

Inheritance diagram for gtsam::PCGSolverParameters:
Inheritance graph
[legend]

Public Types

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

Public Member Functions

 PCGSolverParameters ()
 
const PreconditionerParameterspreconditioner () const
 
void print (std::ostream &os) const override
 
void print (const std::string &s) const
 
void setPreconditionerParams (const std::shared_ptr< PreconditionerParameters > preconditioner)
 
- Public Member Functions inherited from gtsam::ConjugateGradientParameters
 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
 
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 ()
 

Public Attributes

std::shared_ptr< PreconditionerParameterspreconditioner_
 
- Public Attributes inherited from gtsam::ConjugateGradientParameters
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_
 

Additional Inherited Members

- Static Public Member Functions inherited from gtsam::ConjugateGradientParameters
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)
 

Detailed Description

Parameters for PCG

Definition at line 36 of file PCGSolver.h.

Member Typedef Documentation

◆ Base

Definition at line 38 of file PCGSolver.h.

◆ shared_ptr

Definition at line 39 of file PCGSolver.h.

Constructor & Destructor Documentation

◆ PCGSolverParameters()

gtsam::PCGSolverParameters::PCGSolverParameters ( )
inline

Definition at line 41 of file PCGSolver.h.

Member Function Documentation

◆ preconditioner()

const PreconditionerParameters& gtsam::PCGSolverParameters::preconditioner ( ) const
inline

Definition at line 47 of file PCGSolver.h.

◆ print() [1/2]

void gtsam::PCGSolverParameters::print ( std::ostream &  os) const
overridevirtual

◆ print() [2/2]

void gtsam::PCGSolverParameters::print ( const std::string &  s) const

Definition at line 50 of file PCGSolver.cpp.

◆ setPreconditionerParams()

void gtsam::PCGSolverParameters::setPreconditionerParams ( const std::shared_ptr< PreconditionerParameters preconditioner)

Definition at line 46 of file PCGSolver.cpp.

Member Data Documentation

◆ preconditioner_

std::shared_ptr<PreconditionerParameters> gtsam::PCGSolverParameters::preconditioner_

Definition at line 54 of file PCGSolver.h.


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


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:47:06