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 std::shared_ptr< Thisshared_ptr
 Shared pointer to this class. More...
 
typedef std::shared_ptr< ConditionalTypesharedConditional
 Shared pointer to a conditional. More...
 
typedef std::shared_ptr< FactorTypesharedFactor
 Shared pointer to a factor. More...
 
typedef EliminatableClusterTree< BAYESTREE, GRAPH > This
 This class. More...
 

Public Member Functions

Standard Interface
std::pair< std::shared_ptr< BayesTreeType >, std::shared_ptr< FactorGraphType > > eliminate (const Eliminate &function) const
 
Advanced Interface
const FastVector< sharedFactor > & remainingFactors () 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 Attributes

FastVector< sharedFactorremainingFactors_
 

Detailed Description

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

A cluster-tree that eliminates to a Bayes tree.

Definition at line 35 of file BayesTree.h.

Member Typedef Documentation

◆ BayesTreeType

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

The BayesTree type produced by elimination.

Definition at line 188 of file ClusterTree.h.

◆ ConditionalType

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

The type of conditionals.

Definition at line 193 of file ClusterTree.h.

◆ Eliminate

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

Typedef for an eliminate subroutine.

Definition at line 197 of file ClusterTree.h.

◆ FactorGraphType

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

The factor graph type.

Definition at line 189 of file ClusterTree.h.

◆ FactorType

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

The type of factors.

Definition at line 198 of file ClusterTree.h.

◆ shared_ptr

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

Shared pointer to this class.

Definition at line 191 of file ClusterTree.h.

◆ sharedConditional

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

Shared pointer to a conditional.

Definition at line 195 of file ClusterTree.h.

◆ sharedFactor

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

Shared pointer to a factor.

Definition at line 199 of file ClusterTree.h.

◆ This

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

This class.

Definition at line 190 of file ClusterTree.h.

Constructor & Destructor Documentation

◆ EliminatableClusterTree() [1/2]

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 209 of file ClusterTree.h.

◆ EliminatableClusterTree() [2/2]

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

Default constructor to be used in derived classes.

Definition at line 248 of file ClusterTree.h.

Member Function Documentation

◆ eliminate()

template<class BAYESTREE , class GRAPH >
std::pair< std::shared_ptr< BAYESTREE >, std::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 285 of file ClusterTree-inst.h.

◆ operator=()

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 271 of file ClusterTree-inst.h.

◆ remainingFactors()

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 233 of file ClusterTree.h.

Member Data Documentation

◆ remainingFactors_

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

Definition at line 202 of file ClusterTree.h.


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


gtsam
Author(s):
autogenerated on Fri Nov 1 2024 03:51:17