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

#include <GaussianJunctionTree.h>

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

Public Types

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

Public Member Functions

 GaussianJunctionTree (const GaussianEliminationTree &eliminationTree)
 
- Public Member Functions inherited from gtsam::EliminatableClusterTree< GaussianBayesTree, GaussianFactorGraph >
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< GaussianFactorGraph >
 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< GaussianBayesTree, GaussianFactorGraph >
 JunctionTree ()
 
 JunctionTree (const EliminationTree< ETREE_BAYESNET, ETREE_GRAPH > &eliminationTree)
 
- Protected Member Functions inherited from gtsam::EliminatableClusterTree< GaussianBayesTree, GaussianFactorGraph >
 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< GaussianFactorGraph >
 ClusterTree (const This &other)
 
Thisoperator= (const This &other)
 
- Static Protected Member Functions inherited from gtsam::JunctionTree< GaussianBayesTree, GaussianFactorGraph >
static This FromEliminationTree (const ETREE &eliminationTree)
 
- Protected Attributes inherited from gtsam::EliminatableClusterTree< GaussianBayesTree, GaussianFactorGraph >
FastVector< sharedFactorremainingFactors_
 
- Protected Attributes inherited from gtsam::ClusterTree< GaussianFactorGraph >
FastVector< sharedNoderoots_
 

Detailed Description

A junction tree specialized to Gaussian factors, i.e., it is a cluster tree with Gaussian factors stored in each cluster. It can be eliminated into a Gaussian Bayes tree with the same structure, which is essentially doing multifrontal sparse matrix factorization.

Definition at line 38 of file GaussianJunctionTree.h.

Member Typedef Documentation

◆ Base

Base class.

Definition at line 41 of file GaussianJunctionTree.h.

◆ shared_ptr

Shared pointer to this class.

Definition at line 43 of file GaussianJunctionTree.h.

◆ This

This class.

Definition at line 42 of file GaussianJunctionTree.h.

Constructor & Destructor Documentation

◆ GaussianJunctionTree()

gtsam::GaussianJunctionTree::GaussianJunctionTree ( const GaussianEliminationTree 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 GaussianJunctionTree.cpp.


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


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