gtsam  3.2.1
gtsam
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
gtsam::DiscreteJunctionTree Class Reference
+ Inheritance diagram for gtsam::DiscreteJunctionTree:

Public Member Functions

 DiscreteJunctionTree (const DiscreteEliminationTree &eliminationTree)
 Build the elimination tree of a factor graph using pre-computed column structure. More...
 
- Public Member Functions inherited from gtsam::ClusterTree< DiscreteBayesTree, DiscreteFactorGraph >
 GTSAM_CONCEPT_TESTABLE_TYPE (FactorType)
 concept check
 
void print (const std::string &s="", const KeyFormatter &keyFormatter=DefaultKeyFormatter) const
 Print the cluster tree.
 
std::pair< boost::shared_ptr
< BayesTreeType >
, boost::shared_ptr
< FactorGraphType > > 
eliminate (const Eliminate &function) const
 Eliminate the factors to a Bayes tree and remaining factor graph. More...
 
const FastVector< sharedNode > & roots () const
 Return the set of roots (one for a tree, multiple for a forest)
 
const FastVector< sharedFactor > & remainingFactors () const
 Return the remaining factors that are not pulled into elimination.
 

Public Types

typedef JunctionTree
< DiscreteBayesTree,
DiscreteFactorGraph
Base
 Base class.
 
typedef DiscreteJunctionTree This
 This class.
 
typedef boost::shared_ptr< Thisshared_ptr
 Shared pointer to this class.
 
- Public Types inherited from gtsam::JunctionTree< DiscreteBayesTree, DiscreteFactorGraph >
typedef JunctionTree
< DiscreteBayesTree,
DiscreteFactorGraph
This
 This class.
 
typedef boost::shared_ptr< Thisshared_ptr
 Shared pointer to this class.
 
typedef ClusterTree
< DiscreteBayesTree,
DiscreteFactorGraph
Base
 Our base class.
 
- Public Types inherited from gtsam::ClusterTree< DiscreteBayesTree, DiscreteFactorGraph >
typedef DiscreteFactorGraph FactorGraphType
 The factor graph type.
 
typedef
DiscreteFactorGraph::FactorType 
FactorType
 The type of factors.
 
typedef ClusterTree
< DiscreteBayesTree,
DiscreteFactorGraph
This
 This class.
 
typedef boost::shared_ptr< Thisshared_ptr
 Shared pointer to this class.
 
typedef boost::shared_ptr
< FactorType
sharedFactor
 Shared pointer to a factor.
 
typedef DiscreteBayesTree BayesTreeType
 The BayesTree type produced by elimination.
 
typedef
BayesTreeType::ConditionalType 
ConditionalType
 The type of conditionals.
 
typedef boost::shared_ptr
< ConditionalType
sharedConditional
 Shared pointer to a conditional.
 
typedef FactorGraphType::Eliminate Eliminate
 Typedef for an eliminate subroutine.
 
typedef boost::shared_ptr
< Cluster > 
sharedCluster
 Shared pointer to Cluster.
 
typedef Cluster Node
 Define Node=Cluster for compatibility with tree traversal functions.
 
typedef sharedCluster sharedNode
 Define Node=Cluster for compatibility with tree traversal functions.
 

Additional Inherited Members

- Protected Member Functions inherited from gtsam::JunctionTree< DiscreteBayesTree, DiscreteFactorGraph >
 JunctionTree (const EliminationTree< ETREE_BAYESNET, ETREE_GRAPH > &eliminationTree)
 Build the junction tree from an elimination tree. More...
 
- Protected Member Functions inherited from gtsam::ClusterTree< DiscreteBayesTree, DiscreteFactorGraph >
 ClusterTree (const This &other)
 Copy constructor - makes a deep copy of the tree structure, but only pointers to factors are copied, factors are not cloned. More...
 
 ClusterTree ()
 Default constructor to be used in derived classes.
 
Thisoperator= (const This &other)
 Assignment operator - makes a deep copy of the tree structure, but only pointers to factors are copied, factors are not cloned. More...
 
- Static Protected Member Functions inherited from gtsam::JunctionTree< DiscreteBayesTree, DiscreteFactorGraph >
static This FromEliminationTree (const ETREE &eliminationTree)
 Build the junction tree from an elimination tree. More...
 
- Protected Attributes inherited from gtsam::ClusterTree< DiscreteBayesTree, DiscreteFactorGraph >
FastVector< sharedNoderoots_
 
FastVector< sharedFactorremainingFactors_
 

Constructor & Destructor Documentation

gtsam::DiscreteJunctionTree::DiscreteJunctionTree ( const DiscreteEliminationTree eliminationTree)

Build the elimination tree of a factor graph using pre-computed column structure.

Parameters
factorGraphThe factor graph for which to build the elimination tree
structureThe set of factors involving each variable. If this is not precomputed, you can call the Create(const FactorGraph<DERIVEDFACTOR>&) named constructor instead.
Returns
The elimination tree

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