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

#include <SubgraphBuilder.h>

Public Types

enum  AugmentationWeight { SKELETON = 0 }
 
typedef std::shared_ptr< SubgraphBuilderParametersshared_ptr
 
enum  Skeleton { NATURALCHAIN = 0, BFS, KRUSKAL }
 
enum  SkeletonWeight { EQUAL = 0, RHS_2NORM, LHS_FNORM, RANDOM }
 

Public Member Functions

void print () const
 
virtual void print (std::ostream &os) const
 
 SubgraphBuilderParameters ()
 
virtual ~SubgraphBuilderParameters ()
 

Static Public Member Functions

static AugmentationWeight augmentationWeightTranslator (const std::string &s)
 
static std::string augmentationWeightTranslator (AugmentationWeight w)
 
static Skeleton skeletonTranslator (const std::string &s)
 
static std::string skeletonTranslator (Skeleton s)
 
static SkeletonWeight skeletonWeightTranslator (const std::string &s)
 
static std::string skeletonWeightTranslator (SkeletonWeight w)
 

Public Attributes

double augmentationFactor
 factor multiplied with n, yields number of extra edges. More...
 
enum gtsam::SubgraphBuilderParameters::AugmentationWeight augmentationWeight
 
enum gtsam::SubgraphBuilderParameters::Skeleton skeletonType
 
enum gtsam::SubgraphBuilderParameters::SkeletonWeight skeletonWeight
 

Friends

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

Detailed Description

Definition at line 102 of file SubgraphBuilder.h.

Member Typedef Documentation

◆ shared_ptr

Definition at line 103 of file SubgraphBuilder.h.

Member Enumeration Documentation

◆ AugmentationWeight

Enumerator
SKELETON 

Definition at line 119 of file SubgraphBuilder.h.

◆ Skeleton

Enumerator
NATURALCHAIN 
BFS 
KRUSKAL 

Definition at line 105 of file SubgraphBuilder.h.

◆ SkeletonWeight

Enumerator
EQUAL 
RHS_2NORM 
LHS_FNORM 
RANDOM 

Definition at line 112 of file SubgraphBuilder.h.

Constructor & Destructor Documentation

◆ SubgraphBuilderParameters()

gtsam::SubgraphBuilderParameters::SubgraphBuilderParameters ( )
inline

Definition at line 131 of file SubgraphBuilder.h.

◆ ~SubgraphBuilderParameters()

virtual gtsam::SubgraphBuilderParameters::~SubgraphBuilderParameters ( )
inlinevirtual

Definition at line 136 of file SubgraphBuilder.h.

Member Function Documentation

◆ augmentationWeightTranslator() [1/2]

SubgraphBuilderParameters::AugmentationWeight gtsam::SubgraphBuilderParameters::augmentationWeightTranslator ( const std::string &  s)
static

Definition at line 197 of file SubgraphBuilder.cpp.

◆ augmentationWeightTranslator() [2/2]

std::string gtsam::SubgraphBuilderParameters::augmentationWeightTranslator ( AugmentationWeight  w)
static

Definition at line 213 of file SubgraphBuilder.cpp.

◆ print() [1/2]

void gtsam::SubgraphBuilderParameters::print ( ) const

Definition at line 113 of file SubgraphBuilder.cpp.

◆ print() [2/2]

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

◆ skeletonTranslator() [1/2]

SubgraphBuilderParameters::Skeleton gtsam::SubgraphBuilderParameters::skeletonTranslator ( const std::string &  s)
static

Definition at line 133 of file SubgraphBuilder.cpp.

◆ skeletonTranslator() [2/2]

std::string gtsam::SubgraphBuilderParameters::skeletonTranslator ( Skeleton  s)
static

Definition at line 149 of file SubgraphBuilder.cpp.

◆ skeletonWeightTranslator() [1/2]

SubgraphBuilderParameters::SkeletonWeight gtsam::SubgraphBuilderParameters::skeletonWeightTranslator ( const std::string &  s)
static

Definition at line 162 of file SubgraphBuilder.cpp.

◆ skeletonWeightTranslator() [2/2]

std::string gtsam::SubgraphBuilderParameters::skeletonWeightTranslator ( SkeletonWeight  w)
static

Definition at line 181 of file SubgraphBuilder.cpp.

Friends And Related Function Documentation

◆ operator<<

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

Member Data Documentation

◆ augmentationFactor

double gtsam::SubgraphBuilderParameters::augmentationFactor

factor multiplied with n, yields number of extra edges.

Definition at line 129 of file SubgraphBuilder.h.

◆ augmentationWeight

enum gtsam::SubgraphBuilderParameters::AugmentationWeight gtsam::SubgraphBuilderParameters::augmentationWeight

◆ skeletonType

enum gtsam::SubgraphBuilderParameters::Skeleton gtsam::SubgraphBuilderParameters::skeletonType

◆ skeletonWeight

enum gtsam::SubgraphBuilderParameters::SkeletonWeight gtsam::SubgraphBuilderParameters::skeletonWeight

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


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