#include <ClusterTree.h>
Inheritance diagram for gtsam::ClusterTree< GRAPH >:
Classes | |
| struct | Cluster |
| A Cluster is just a collection of factors. More... | |
Public Types | |
| typedef GRAPH | FactorGraphType |
| The factor graph type. | |
| typedef ClusterTree< GRAPH > | This |
| This class. | |
| typedef std::shared_ptr< This > | shared_ptr |
| Shared pointer to this class. | |
| typedef GRAPH::FactorType | FactorType |
| The type of factors. | |
| typedef std::shared_ptr< FactorType > | sharedFactor |
| Shared pointer to a factor. | |
| typedef std::shared_ptr< Cluster > | sharedCluster |
| Shared pointer to Cluster. | |
| typedef Cluster | Node |
| typedef sharedCluster | sharedNode |
Public Member Functions | |
| ClusterTree () | |
| Default constructor. | |
Protected Attributes | |
| FastVector< sharedNode > | roots_ |
Standard Constructors | |
| ClusterTree (const This &other) | |
Testable | |
| void | print (const std::string &s="", const KeyFormatter &keyFormatter=DefaultKeyFormatter) const |
Advanced Interface | |
| void | addRoot (const std::shared_ptr< Cluster > &cluster) |
| void | addChildrenAsRoots (const std::shared_ptr< Cluster > &cluster) |
| size_t | nrRoots () const |
| const FastVector< sharedNode > & | roots () const |
| const Cluster & | operator[] (size_t i) const |
Details | |
| This & | operator= (const This &other) |
Detailed Description
template<class GRAPH>
class gtsam::ClusterTree< GRAPH >
A cluster-tree is associated with a factor graph and is defined as in Koller-Friedman: each node k represents a subset \( C_k \sub X \), and the tree is family preserving, in that each factor \( f_i \) is associated with a single cluster and \( scope(f_i) \sub C_k \).
Constructor & Destructor Documentation
◆ ClusterTree()
template<class GRAPH>
|
inlineprotected |
Copy constructor - makes a deep copy of the tree structure, but only pointers to factors are copied, factors are not cloned.
Member Function Documentation
◆ operator=()
template<class GRAPH >
|
protected |
Assignment operator - makes a deep copy of the tree structure, but only pointers to factors are copied, factors are not cloned.
◆ print()
template<class GRAPH >
| void gtsam::ClusterTree< GRAPH >::print | ( | const std::string & | s = "", |
| const KeyFormatter & | keyFormatter = DefaultKeyFormatter |
||
| ) | const |
Print the cluster tree
◆ roots()
template<class GRAPH>
|
inline |
Return the set of roots (one for a tree, multiple for a forest)
Member Data Documentation
◆ roots_
template<class GRAPH>
|
protected |
concept check
The documentation for this class was generated from the following files:
- /home/docs/checkouts/readthedocs.org/user_builds/gtsam-jlblanco-docs/checkouts/latest/gtsam/inference/ClusterTree.h
- /home/docs/checkouts/readthedocs.org/user_builds/gtsam-jlblanco-docs/checkouts/latest/gtsam/inference/ClusterTree-inst.h
