Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
gtsam::PreconditionerParameters Struct Reference

#include <Preconditioner.h>

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

Public Types

enum  Kernel { GTSAM = 0, CHOLMOD }
 
typedef std::shared_ptr< PreconditionerParametersshared_ptr
 
enum  Verbosity { SILENT = 0, COMPLEXITY = 1, ERROR = 2 }
 

Public Member Functions

Kernel kernel () const
 
 PreconditionerParameters ()
 
 PreconditionerParameters (const PreconditionerParameters &p)
 
void print () const
 
virtual void print (std::ostream &os) const
 
Verbosity verbosity () const
 
virtual ~PreconditionerParameters ()
 

Static Public Member Functions

static Kernel kernelTranslator (const std::string &s)
 
static std::string kernelTranslator (Kernel k)
 
static Verbosity verbosityTranslator (const std::string &s)
 
static std::string verbosityTranslator (Verbosity v)
 

Public Attributes

enum gtsam::PreconditionerParameters::Kernel kernel_
 
enum gtsam::PreconditionerParameters::Verbosity verbosity_
 

Friends

std::ostream & operator<< (std::ostream &os, const PreconditionerParameters &p)
 

Detailed Description

Definition at line 24 of file Preconditioner.h.

Member Typedef Documentation

◆ shared_ptr

Definition at line 26 of file Preconditioner.h.

Member Enumeration Documentation

◆ Kernel

Enumerator
GTSAM 
CHOLMOD 

Definition at line 28 of file Preconditioner.h.

◆ Verbosity

Enumerator
SILENT 
COMPLEXITY 
ERROR 

Definition at line 33 of file Preconditioner.h.

Constructor & Destructor Documentation

◆ PreconditionerParameters() [1/2]

gtsam::PreconditionerParameters::PreconditionerParameters ( )
inline

Definition at line 39 of file Preconditioner.h.

◆ PreconditionerParameters() [2/2]

gtsam::PreconditionerParameters::PreconditionerParameters ( const PreconditionerParameters p)
inline

Definition at line 40 of file Preconditioner.h.

◆ ~PreconditionerParameters()

virtual gtsam::PreconditionerParameters::~PreconditionerParameters ( )
inlinevirtual

Definition at line 41 of file Preconditioner.h.

Member Function Documentation

◆ kernel()

Kernel gtsam::PreconditionerParameters::kernel ( ) const
inline

Definition at line 44 of file Preconditioner.h.

◆ kernelTranslator() [1/2]

PreconditionerParameters::Kernel gtsam::PreconditionerParameters::kernelTranslator ( const std::string &  s)
static

Definition at line 42 of file Preconditioner.cpp.

◆ kernelTranslator() [2/2]

std::string gtsam::PreconditionerParameters::kernelTranslator ( PreconditionerParameters::Kernel  k)
static

Definition at line 65 of file Preconditioner.cpp.

◆ print() [1/2]

void gtsam::PreconditionerParameters::print ( ) const

Definition at line 24 of file Preconditioner.cpp.

◆ print() [2/2]

virtual void gtsam::PreconditionerParameters::print ( std::ostream &  os) const
virtual

◆ verbosity()

Verbosity gtsam::PreconditionerParameters::verbosity ( ) const
inline

Definition at line 45 of file Preconditioner.h.

◆ verbosityTranslator() [1/2]

PreconditionerParameters::Verbosity gtsam::PreconditionerParameters::verbosityTranslator ( const std::string &  s)
static

Definition at line 53 of file Preconditioner.cpp.

◆ verbosityTranslator() [2/2]

std::string gtsam::PreconditionerParameters::verbosityTranslator ( PreconditionerParameters::Verbosity  verbosity)
static

Definition at line 72 of file Preconditioner.cpp.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  os,
const PreconditionerParameters p 
)
friend

Member Data Documentation

◆ kernel_

enum gtsam::PreconditionerParameters::Kernel gtsam::PreconditionerParameters::kernel_

◆ verbosity_

enum gtsam::PreconditionerParameters::Verbosity gtsam::PreconditionerParameters::verbosity_

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


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