Public Types | Public Member Functions | List of all members
gtsam::SymbolicJunctionTree Class Reference

#include <SymbolicJunctionTree.h>

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

Public Types

typedef JunctionTree< SymbolicBayesTree, SymbolicFactorGraphBase
 Base class. More...
 
typedef std::shared_ptr< Thisshared_ptr
 Shared pointer to this class. More...
 
typedef SymbolicJunctionTree This
 This class. More...
 
- Public Types inherited from gtsam::JunctionTree< SymbolicBayesTree, SymbolicFactorGraph >
typedef EliminatableClusterTree< SymbolicBayesTree, SymbolicFactorGraphBase
 Our base class. More...
 
typedef std::shared_ptr< Thisshared_ptr
 Shared pointer to this class. More...
 
typedef JunctionTree< SymbolicBayesTree, SymbolicFactorGraphThis
 This class. More...
 
- Public Types inherited from gtsam::EliminatableClusterTree< SymbolicBayesTree, SymbolicFactorGraph >
typedef SymbolicBayesTree BayesTreeType
 The BayesTree type produced by elimination. More...
 
typedef SymbolicBayesTree ::ConditionalType ConditionalType
 The type of conditionals. More...
 
typedef SymbolicFactorGraph ::Eliminate Eliminate
 Typedef for an eliminate subroutine. More...
 
typedef SymbolicFactorGraph FactorGraphType
 The factor graph type. More...
 
typedef SymbolicFactorGraph ::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< SymbolicBayesTree, SymbolicFactorGraphThis
 This class. More...
 

Public Member Functions

 SymbolicJunctionTree (const SymbolicEliminationTree &eliminationTree)
 
- Public Member Functions inherited from gtsam::EliminatableClusterTree< SymbolicBayesTree, SymbolicFactorGraph >
std::pair< std::shared_ptr< BayesTreeType >, std::shared_ptr< FactorGraphType > > eliminate (const Eliminate &function) const
 
const FastVector< sharedFactor > & remainingFactors () const
 

Additional Inherited Members

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

Detailed Description

A 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 analagous to the EliminationTree, except that in the JunctionTree, at each node multiple variables are eliminated at a time.

Definition at line 50 of file SymbolicJunctionTree.h.

Member Typedef Documentation

◆ Base

Base class.

Definition at line 53 of file SymbolicJunctionTree.h.

◆ shared_ptr

Shared pointer to this class.

Definition at line 55 of file SymbolicJunctionTree.h.

◆ This

This class.

Definition at line 54 of file SymbolicJunctionTree.h.

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

Definition at line 30 of file SymbolicJunctionTree.cpp.


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


gtsam
Author(s):
autogenerated on Fri Nov 1 2024 03:52:50