gtsam  4.0.0
gtsam
gtsam::SymbolicJunctionTree Class Reference
+ Inheritance diagram for gtsam::SymbolicJunctionTree:

Public Member Functions

 SymbolicJunctionTree (const SymbolicEliminationTree &eliminationTree)
 Build the elimination tree of a factor graph using pre-computed column structure. More...
 
- Public Member Functions inherited from gtsam::EliminatableClusterTree< SymbolicBayesTree, SymbolicFactorGraph >
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< sharedFactor > & remainingFactors () const
 Return the remaining factors that are not pulled into elimination.
 
- Public Member Functions inherited from gtsam::ClusterTree< SymbolicFactorGraph >
 GTSAM_CONCEPT_TESTABLE_TYPE (FactorType)
 concept check
 
 ClusterTree ()
 Default constructor.
 
void print (const std::string &s="", const KeyFormatter &keyFormatter=DefaultKeyFormatter) const
 Print the cluster tree.
 
void addRoot (const boost::shared_ptr< Cluster > &cluster)
 
void addChildrenAsRoots (const boost::shared_ptr< Cluster > &cluster)
 
size_t nrRoots () const
 
const FastVector< sharedNode > & roots () const
 Return the set of roots (one for a tree, multiple for a forest)
 
const Cluster & operator[] (size_t i) const
 

Public Types

typedef JunctionTree< SymbolicBayesTree, SymbolicFactorGraphBase
 Base class.
 
typedef SymbolicJunctionTree This
 This class.
 
typedef boost::shared_ptr< Thisshared_ptr
 Shared pointer to this class.
 
- Public Types inherited from gtsam::JunctionTree< SymbolicBayesTree, SymbolicFactorGraph >
typedef JunctionTree< SymbolicBayesTree, SymbolicFactorGraphThis
 This class.
 
typedef boost::shared_ptr< Thisshared_ptr
 Shared pointer to this class.
 
typedef EliminatableClusterTree< SymbolicBayesTree, SymbolicFactorGraphBase
 Our base class.
 
- Public Types inherited from gtsam::EliminatableClusterTree< SymbolicBayesTree, SymbolicFactorGraph >
typedef SymbolicBayesTree BayesTreeType
 The BayesTree type produced by elimination.
 
typedef SymbolicFactorGraph FactorGraphType
 The factor graph type.
 
typedef EliminatableClusterTree< SymbolicBayesTree, SymbolicFactorGraphThis
 This class.
 
typedef boost::shared_ptr< Thisshared_ptr
 Shared pointer to this class.
 
typedef SymbolicBayesTree ::ConditionalType ConditionalType
 The type of conditionals.
 
typedef boost::shared_ptr< ConditionalTypesharedConditional
 Shared pointer to a conditional.
 
typedef SymbolicFactorGraph ::Eliminate Eliminate
 Typedef for an eliminate subroutine.
 
typedef SymbolicFactorGraph ::FactorType FactorType
 The type of factors.
 
typedef boost::shared_ptr< FactorTypesharedFactor
 Shared pointer to a factor.
 
- Public Types inherited from gtsam::ClusterTree< SymbolicFactorGraph >
typedef SymbolicFactorGraph FactorGraphType
 The factor graph type.
 
typedef ClusterTree< SymbolicFactorGraphThis
 This class.
 
typedef boost::shared_ptr< Thisshared_ptr
 Shared pointer to this class.
 
typedef SymbolicFactorGraph ::FactorType FactorType
 The type of factors.
 
typedef boost::shared_ptr< FactorTypesharedFactor
 Shared pointer to a factor.
 
typedef boost::shared_ptr< Cluster > sharedCluster
 Shared pointer to Cluster.
 
typedef Cluster Node
 
typedef sharedCluster sharedNode
 

Additional Inherited Members

- Protected Member Functions inherited from gtsam::JunctionTree< SymbolicBayesTree, SymbolicFactorGraph >
 JunctionTree (const EliminationTree< ETREE_BAYESNET, ETREE_GRAPH > &eliminationTree)
 Build the junction tree from an elimination tree. More...
 
- Protected Member Functions inherited from gtsam::EliminatableClusterTree< SymbolicBayesTree, SymbolicFactorGraph >
 EliminatableClusterTree (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...
 
 EliminatableClusterTree ()
 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...
 
- Protected Member Functions inherited from gtsam::ClusterTree< SymbolicFactorGraph >
 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...
 
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< SymbolicBayesTree, SymbolicFactorGraph >
static This FromEliminationTree (const ETREE &eliminationTree)
 Build the junction tree from an elimination tree. More...
 
- Protected Attributes inherited from gtsam::EliminatableClusterTree< SymbolicBayesTree, SymbolicFactorGraph >
FastVector< sharedFactorremainingFactors_
 
- Protected Attributes inherited from gtsam::ClusterTree< SymbolicFactorGraph >
FastVector< sharedNode > roots_
 

Constructor & Destructor Documentation

◆ SymbolicJunctionTree()

gtsam::SymbolicJunctionTree::SymbolicJunctionTree ( const SymbolicEliminationTree 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: