gtsam::MetisIndex Class Reference

#include <MetisIndex.h>

Public Types
typedef boost::bimap< Key, int32_t >	bm_type
typedef boost::shared_ptr< MetisIndex >	shared_ptr

Private Attributes
std::vector< int32_t >	adj_
boost::bimap< Key, int32_t >	intKeyBMap_
size_t	nKeys_
std::vector< int32_t >	xadj_

Standard Constructors
	MetisIndex ()
template<class FG >
	MetisIndex (const FG &factorGraph)
	~MetisIndex ()

Advanced Interface
template<class FACTOR >
void	augment (const FactorGraph< FACTOR > &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 45 of file MetisIndex.h.

Member Typedef Documentation

typedef boost::bimap<Key, int32_t> gtsam::MetisIndex::bm_type

Definition at line 48 of file MetisIndex.h.

typedef boost::shared_ptr<MetisIndex> gtsam::MetisIndex::shared_ptr

Definition at line 47 of file MetisIndex.h.

Constructor & Destructor Documentation

gtsam::MetisIndex::MetisIndex ( )

inline

Default constructor, creates empty MetisIndex

Definition at line 61 of file MetisIndex.h.

template<class FG >

gtsam::MetisIndex::MetisIndex ( const FG &  factorGraph )

inline

Definition at line 66 of file MetisIndex.h.

gtsam::MetisIndex::~MetisIndex ( )

inline

Definition at line 71 of file MetisIndex.h.

Member Function Documentation

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

inline

Definition at line 87 of file MetisIndex.h.

template<class FACTOR >

void gtsam::MetisIndex::augment

(

const FactorGraph< FACTOR > &

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.

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

inline

Definition at line 93 of file MetisIndex.h.

size_t gtsam::MetisIndex::nValues ( ) const

inline

Definition at line 90 of file MetisIndex.h.

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

inline

Definition at line 84 of file MetisIndex.h.

Member Data Documentation

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

private

Definition at line 52 of file MetisIndex.h.

boost::bimap<Key, int32_t> gtsam::MetisIndex::intKeyBMap_

private

Definition at line 53 of file MetisIndex.h.

size_t gtsam::MetisIndex::nKeys_

private

Definition at line 54 of file MetisIndex.h.

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

private

Definition at line 51 of file MetisIndex.h.

---

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

• MetisIndex.h
• MetisIndex-inl.h