Detailed Description

Parameters for Preconditioned Conjugate Gradient solver.

Inheritance diagram for gtsam::PCGSolverParameters:

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

Public Attributes
std::shared_ptr< PreconditionerParameters >	preconditioner
	Parameters used to construct the preconditioner for each solve.
bool	parallel = true
	Enable scheduler-backed parallel kernels.
size_t	numThreads = 0
	Worker count (0 selects an automatic count).
Public Attributes inherited from gtsam::ConjugateGradientParameters
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
typedef ConjugateGradientParameters	Base
typedef std::shared_ptr< PCGSolverParameters >	shared_ptr
Public Types inherited from gtsam::ConjugateGradientParameters
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
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)
Protected Attributes inherited from gtsam::IterativeOptimizationParameters
Verbosity	verbosity_

Member Function Documentation

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

overridevirtual

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