Classes | Public Types | Private Attributes | List of all members
gtsam::MetisIndex Class Reference

#include <MetisIndex.h>

Classes

struct  BiMap
 

Public Types

typedef std::shared_ptr< MetisIndexshared_ptr
 

Private Attributes

std::vector< int32_tadj_
 
BiMap intKeyBMap_
 
size_t nKeys_
 
std::vector< int32_txadj_
 

Standard Constructors

 MetisIndex ()
 
template<class FACTORGRAPH >
 MetisIndex (const FACTORGRAPH &factorGraph)
 
 ~MetisIndex ()
 

Advanced Interface

template<class FACTORGRAPH >
void augment (const FACTORGRAPH &factors)
 
const std::vector< int32_t > & xadj () const
 
const std::vector< int32_t > & adj () const
 
size_t nValues () const
 
Key intToKey (int32_t value) const
 

Detailed Description

The MetisIndex class converts a factor graph into the Compressed Sparse Row format for use in METIS algorithms. Specifically, two vectors store the adjacency structure of the graph. It is built from a factor graph prior to elimination, and stores the list of factors that involve each variable.

Definition at line 37 of file MetisIndex.h.

Member Typedef Documentation

◆ shared_ptr

typedef std::shared_ptr<MetisIndex> gtsam::MetisIndex::shared_ptr

Definition at line 39 of file MetisIndex.h.

Constructor & Destructor Documentation

◆ MetisIndex() [1/2]

gtsam::MetisIndex::MetisIndex ( )
inline

Default constructor, creates empty MetisIndex

Definition at line 62 of file MetisIndex.h.

◆ MetisIndex() [2/2]

template<class FACTORGRAPH >
gtsam::MetisIndex::MetisIndex ( const FACTORGRAPH &  factorGraph)
inline

Definition at line 67 of file MetisIndex.h.

◆ ~MetisIndex()

gtsam::MetisIndex::~MetisIndex ( )
inline

Definition at line 72 of file MetisIndex.h.

Member Function Documentation

◆ adj()

const std::vector<int32_t>& gtsam::MetisIndex::adj ( ) const
inline

Definition at line 88 of file MetisIndex.h.

◆ augment()

template<class FACTORGRAPH >
void gtsam::MetisIndex::augment ( const FACTORGRAPH &  factors)

Augment the variable index with new factors. This can be used when solving problems incrementally.

Definition at line 27 of file MetisIndex-inl.h.

◆ intToKey()

Key gtsam::MetisIndex::intToKey ( int32_t  value) const
inline

Definition at line 94 of file MetisIndex.h.

◆ nValues()

size_t gtsam::MetisIndex::nValues ( ) const
inline

Definition at line 91 of file MetisIndex.h.

◆ xadj()

const std::vector<int32_t>& gtsam::MetisIndex::xadj ( ) const
inline

Definition at line 85 of file MetisIndex.h.

Member Data Documentation

◆ adj_

std::vector<int32_t> gtsam::MetisIndex::adj_
private

Definition at line 53 of file MetisIndex.h.

◆ intKeyBMap_

BiMap gtsam::MetisIndex::intKeyBMap_
private

Definition at line 54 of file MetisIndex.h.

◆ nKeys_

size_t gtsam::MetisIndex::nKeys_
private

Definition at line 55 of file MetisIndex.h.

◆ xadj_

std::vector<int32_t> gtsam::MetisIndex::xadj_
private

Definition at line 52 of file MetisIndex.h.


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


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:46:23