Public Types | Protected Attributes | List of all members
gtsam::EliminatableClusterTree< BAYESTREE, GRAPH > Class Template Reference

#include <BayesTree.h>

Inheritance diagram for gtsam::EliminatableClusterTree< BAYESTREE, GRAPH >:
Inheritance graph
[legend]

Public Types

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

Public Member Functions

Standard Interface
std::pair< boost::shared_ptr< BayesTreeType >, boost::shared_ptr< FactorGraphType > > eliminate (const Eliminate &function) const
 
Advanced Interface
const FastVector< sharedFactor > & remainingFactors () const
 
- Public Member Functions inherited from gtsam::ClusterTree< GRAPH >
 ClusterTree ()
 Default constructor. More...
 
 GTSAM_CONCEPT_TESTABLE_TYPE (FactorType)
 
void print (const std::string &s="", const KeyFormatter &keyFormatter=DefaultKeyFormatter) const
 
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
 
const Clusteroperator[] (size_t i) const
 

Protected Member Functions

Standard Constructors
 EliminatableClusterTree (const This &other)
 
Details
Thisoperator= (const This &other)
 
 EliminatableClusterTree ()
 Default constructor to be used in derived classes. More...
 
- Protected Member Functions inherited from gtsam::ClusterTree< GRAPH >
 ClusterTree (const This &other)
 
Thisoperator= (const This &other)
 

Protected Attributes

FastVector< sharedFactorremainingFactors_
 
- Protected Attributes inherited from gtsam::ClusterTree< GRAPH >
FastVector< sharedNoderoots_
 

Detailed Description

template<class BAYESTREE, class GRAPH>
class gtsam::EliminatableClusterTree< BAYESTREE, GRAPH >

A cluster-tree that eliminates to a Bayes tree.

Definition at line 33 of file BayesTree.h.

Member Typedef Documentation

template<class BAYESTREE, class GRAPH>
typedef BAYESTREE gtsam::EliminatableClusterTree< BAYESTREE, GRAPH >::BayesTreeType

The BayesTree type produced by elimination.

Definition at line 186 of file ClusterTree.h.

template<class BAYESTREE, class GRAPH>
typedef BAYESTREE::ConditionalType gtsam::EliminatableClusterTree< BAYESTREE, GRAPH >::ConditionalType

The type of conditionals.

Definition at line 191 of file ClusterTree.h.

template<class BAYESTREE, class GRAPH>
typedef GRAPH::Eliminate gtsam::EliminatableClusterTree< BAYESTREE, GRAPH >::Eliminate

Typedef for an eliminate subroutine.

Definition at line 195 of file ClusterTree.h.

template<class BAYESTREE, class GRAPH>
typedef GRAPH gtsam::EliminatableClusterTree< BAYESTREE, GRAPH >::FactorGraphType

The factor graph type.

Definition at line 187 of file ClusterTree.h.

template<class BAYESTREE, class GRAPH>
typedef GRAPH::FactorType gtsam::EliminatableClusterTree< BAYESTREE, GRAPH >::FactorType

The type of factors.

Definition at line 196 of file ClusterTree.h.

template<class BAYESTREE, class GRAPH>
typedef boost::shared_ptr<This> gtsam::EliminatableClusterTree< BAYESTREE, GRAPH >::shared_ptr

Shared pointer to this class.

Definition at line 189 of file ClusterTree.h.

template<class BAYESTREE, class GRAPH>
typedef boost::shared_ptr<ConditionalType> gtsam::EliminatableClusterTree< BAYESTREE, GRAPH >::sharedConditional

Shared pointer to a conditional.

Definition at line 193 of file ClusterTree.h.

template<class BAYESTREE, class GRAPH>
typedef boost::shared_ptr<FactorType> gtsam::EliminatableClusterTree< BAYESTREE, GRAPH >::sharedFactor

Shared pointer to a factor.

Definition at line 197 of file ClusterTree.h.

template<class BAYESTREE, class GRAPH>
typedef EliminatableClusterTree<BAYESTREE, GRAPH> gtsam::EliminatableClusterTree< BAYESTREE, GRAPH >::This

This class.

Definition at line 188 of file ClusterTree.h.

Constructor & Destructor Documentation

template<class BAYESTREE, class GRAPH>
gtsam::EliminatableClusterTree< BAYESTREE, GRAPH >::EliminatableClusterTree ( const This other)
inlineprotected

Copy constructor - makes a deep copy of the tree structure, but only pointers to factors are copied, factors are not cloned.

Definition at line 207 of file ClusterTree.h.

template<class BAYESTREE, class GRAPH>
gtsam::EliminatableClusterTree< BAYESTREE, GRAPH >::EliminatableClusterTree ( )
inlineprotected

Default constructor to be used in derived classes.

Definition at line 245 of file ClusterTree.h.

Member Function Documentation

template<class BAYESTREE , class GRAPH >
std::pair< boost::shared_ptr< BAYESTREE >, boost::shared_ptr< GRAPH > > gtsam::EliminatableClusterTree< BAYESTREE, GRAPH >::eliminate ( const Eliminate function) const

Eliminate the factors to a Bayes tree and remaining factor graph

Parameters
functionThe function to use to eliminate, see the namespace functions in GaussianFactorGraph.h
Returns
The Bayes tree and factor graph resulting from elimination

Definition at line 221 of file ClusterTree-inst.h.

template<class BAYESTREE , class GRAPH >
EliminatableClusterTree< BAYESTREE, GRAPH > & gtsam::EliminatableClusterTree< BAYESTREE, GRAPH >::operator= ( const This other)
protected

Assignment operator - makes a deep copy of the tree structure, but only pointers to factors are copied, factors are not cloned.

Definition at line 207 of file ClusterTree-inst.h.

template<class BAYESTREE, class GRAPH>
const FastVector<sharedFactor>& gtsam::EliminatableClusterTree< BAYESTREE, GRAPH >::remainingFactors ( ) const
inline

Return the remaining factors that are not pulled into elimination

Definition at line 231 of file ClusterTree.h.

Member Data Documentation

template<class BAYESTREE, class GRAPH>
FastVector<sharedFactor> gtsam::EliminatableClusterTree< BAYESTREE, GRAPH >::remainingFactors_
protected

Definition at line 200 of file ClusterTree.h.


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


gtsam
Author(s):
autogenerated on Sat May 8 2021 02:58:08