gtsam/gtsam/inference/MetisIndex.h

106 lines
2.6 KiB
C++

/* ----------------------------------------------------------------------------
* GTSAM Copyright 2010, Georgia Tech Research Corporation,
* Atlanta, Georgia 30332-0415
* All Rights Reserved
* Authors: Frank Dellaert, et al. (see THANKS for the full author list)
* See LICENSE for the license information
* -------------------------------------------------------------------------- */
/**
* @file MetisIndex.h
* @author Andrew Melim
* @date Oct. 10, 2014
*/
#pragma once
#include <gtsam/inference/Key.h>
#include <gtsam/inference/FactorGraph.h>
#include <gtsam/base/FastVector.h>
#include <gtsam/base/types.h>
#include <gtsam/base/timing.h>
// Boost bimap generates many ugly warnings in CLANG
#ifdef __clang__
# pragma clang diagnostic push
# pragma clang diagnostic ignored "-Wredeclared-class-member"
#endif
#include <boost/bimap.hpp>
#ifdef __clang__
# pragma clang diagnostic pop
#endif
#include <vector>
namespace gtsam {
/**
* 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.
* \nosubgrouping
*/
class GTSAM_EXPORT MetisIndex {
public:
typedef boost::shared_ptr<MetisIndex> shared_ptr;
typedef boost::bimap<Key, int32_t> bm_type;
private:
FastVector<int32_t> xadj_; // Index of node's adjacency list in adj
FastVector<int32_t> adj_; // Stores ajacency lists of all nodes, appended into a single vector
FastVector<int32_t> iadj_; // Integer keys for passing into metis. One to one mapping with adj_;
boost::bimap<Key, int32_t> intKeyBMap_; // Stores Key <-> integer value relationship
size_t nKeys_;
public:
/// @name Standard Constructors
/// @{
/** Default constructor, creates empty MetisIndex */
MetisIndex() :
nKeys_(0) {
}
template<class FG>
MetisIndex(const FG& factorGraph) :
nKeys_(0) {
augment(factorGraph);
}
~MetisIndex() {
}
/// @}
/// @name Advanced Interface
/// @{
/**
* Augment the variable index with new factors. This can be used when
* solving problems incrementally.
*/
template<class FACTOR>
void augment(const FactorGraph<FACTOR>& factors);
std::vector<int32_t> xadj() const {
return xadj_;
}
std::vector<int32_t> adj() const {
return adj_;
}
size_t nValues() const {
return nKeys_;
}
Key intToKey(int32_t value) const {
assert(value >= 0);
return intKeyBMap_.right.find(value)->second;
}
/// @}
};
} // \ namesace gtsam
#include <gtsam/inference/MetisIndex-inl.h>