Public Types | Public Member Functions | List of all members

#include <DiscreteJunctionTree.h>

Inheritance diagram for gtsam::DiscreteJunctionTree:
Inheritance graph
[legend]

Public Types

typedef JunctionTree< DiscreteBayesTree, DiscreteFactorGraphBase
 Base class. More...
 
typedef std::shared_ptr< Thisshared_ptr
 Shared pointer to this class. More...
 
typedef DiscreteJunctionTree This
 This class. More...
 
- Public Types inherited from gtsam::JunctionTree< DiscreteBayesTree, DiscreteFactorGraph >
typedef EliminatableClusterTree< DiscreteBayesTree, DiscreteFactorGraphBase
 Our base class. More...
 
typedef std::shared_ptr< Thisshared_ptr
 Shared pointer to this class. More...
 
typedef JunctionTree< DiscreteBayesTree, DiscreteFactorGraphThis
 This class. More...
 
- Public Types inherited from gtsam::EliminatableClusterTree< DiscreteBayesTree, DiscreteFactorGraph >
typedef DiscreteBayesTree BayesTreeType
 The BayesTree type produced by elimination. More...
 
typedef DiscreteBayesTree ::ConditionalType ConditionalType
 The type of conditionals. More...
 
typedef DiscreteFactorGraph ::Eliminate Eliminate
 Typedef for an eliminate subroutine. More...
 
typedef DiscreteFactorGraph FactorGraphType
 The factor graph type. More...
 
typedef DiscreteFactorGraph ::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< DiscreteBayesTree, DiscreteFactorGraphThis
 This class. More...
 
- Public Types inherited from gtsam::ClusterTree< DiscreteFactorGraph >
typedef DiscreteFactorGraph FactorGraphType
 The factor graph type. More...
 
typedef DiscreteFactorGraph ::FactorType FactorType
 The type of factors. More...
 
typedef Cluster Node
 
typedef std::shared_ptr< Thisshared_ptr
 Shared pointer to this class. More...
 
typedef std::shared_ptr< Cluster > sharedCluster
 Shared pointer to Cluster. More...
 
typedef std::shared_ptr< FactorTypesharedFactor
 Shared pointer to a factor. More...
 
typedef sharedCluster sharedNode
 
typedef ClusterTree< DiscreteFactorGraphThis
 This class. More...
 

Public Member Functions

 DiscreteJunctionTree (const DiscreteEliminationTree &eliminationTree)
 
- Public Member Functions inherited from gtsam::EliminatableClusterTree< DiscreteBayesTree, DiscreteFactorGraph >
std::pair< std::shared_ptr< BayesTreeType >, std::shared_ptr< FactorGraphType > > eliminate (const Eliminate &function) const
 
const FastVector< sharedFactor > & remainingFactors () const
 
- Public Member Functions inherited from gtsam::ClusterTree< DiscreteFactorGraph >
 ClusterTree ()
 Default constructor. More...
 
 ~ClusterTree ()
 
void print (const std::string &s="", const KeyFormatter &keyFormatter=DefaultKeyFormatter) const
 
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
 

Additional Inherited Members

- Protected Member Functions inherited from gtsam::JunctionTree< DiscreteBayesTree, DiscreteFactorGraph >
 JunctionTree ()
 
 JunctionTree (const EliminationTree< ETREE_BAYESNET, ETREE_GRAPH > &eliminationTree)
 
- Protected Member Functions inherited from gtsam::EliminatableClusterTree< DiscreteBayesTree, DiscreteFactorGraph >
 EliminatableClusterTree (const This &other)
 
 EliminatableClusterTree ()
 Default constructor to be used in derived classes. More...
 
Thisoperator= (const This &other)
 
- Protected Member Functions inherited from gtsam::ClusterTree< DiscreteFactorGraph >
 ClusterTree (const This &other)
 
Thisoperator= (const This &other)
 
- Static Protected Member Functions inherited from gtsam::JunctionTree< DiscreteBayesTree, DiscreteFactorGraph >
static This FromEliminationTree (const ETREE &eliminationTree)
 
- Protected Attributes inherited from gtsam::EliminatableClusterTree< DiscreteBayesTree, DiscreteFactorGraph >
FastVector< sharedFactorremainingFactors_
 
- Protected Attributes inherited from gtsam::ClusterTree< DiscreteFactorGraph >
FastVector< sharedNoderoots_
 

Detailed Description

An EliminatableClusterTree, i.e., a set of variable clusters with factors, arranged in a tree, with the additional property that it represents the clique tree associated with a Bayes net.

In GTSAM a junction tree is an intermediate data structure in multifrontal variable elimination. Each node is a cluster of factors, along with a clique of variables that are eliminated all at once. In detail, every node k represents a clique (maximal fully connected subset) of an associated chordal graph, such as a chordal Bayes net resulting from elimination.

The difference with the BayesTree is that a JunctionTree stores factors, whereas a BayesTree stores conditionals, that are the product of eliminating the factors in the corresponding JunctionTree cliques.

The tree structure and elimination method are exactly analogous to the EliminationTree, except that in the JunctionTree, at each node multiple variables are eliminated at a time.

Definition at line 51 of file DiscreteJunctionTree.h.

Member Typedef Documentation

◆ Base

Base class.

Definition at line 54 of file DiscreteJunctionTree.h.

◆ shared_ptr

Shared pointer to this class.

Definition at line 56 of file DiscreteJunctionTree.h.

◆ This

This class.

Definition at line 55 of file DiscreteJunctionTree.h.

Constructor & Destructor Documentation

◆ DiscreteJunctionTree()

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

Build the elimination tree of a factor graph using precomputed 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

Definition at line 30 of file DiscreteJunctionTree.cpp.


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


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:46:17