#include <SymbolicEliminationTree.h>

Inheritance diagram for gtsam::SymbolicEliminationTree:

Public Types
typedef EliminationTree< SymbolicBayesNet, SymbolicFactorGraph >	Base
	Base class. More...

typedef std::shared_ptr< This >	shared_ptr
	Shared pointer to this class. More...

typedef SymbolicEliminationTree	This
	This class. More...

Public Types inherited from gtsam::EliminationTree< SymbolicBayesNet, SymbolicFactorGraph >
typedef SymbolicBayesNet	BayesNetType
	The BayesNet corresponding to FACTOR. More...

typedef BayesNetType::ConditionalType	ConditionalType
	The type of conditionals. More...

typedef SymbolicFactorGraph ::Eliminate	Eliminate

typedef SymbolicFactorGraph	FactorGraphType
	The factor graph type. More...

typedef SymbolicFactorGraph ::FactorType	FactorType
	The type of factors. More...

typedef std::shared_ptr< ConditionalType >	sharedConditional
	Shared pointer to a conditional. More...

typedef std::shared_ptr< FactorType >	sharedFactor
	Shared pointer to a factor. More...

typedef std::shared_ptr< Node >	sharedNode
	Shared pointer to Node. More...

Public Member Functions
bool	equals (const This &other, double tol=1e-9) const

	SymbolicEliminationTree (const SymbolicFactorGraph &factorGraph, const Ordering &order)

	SymbolicEliminationTree (const SymbolicFactorGraph &factorGraph, const VariableIndex &structure, const Ordering &order)

Public Member Functions inherited from gtsam::EliminationTree< SymbolicBayesNet, SymbolicFactorGraph >
	~EliminationTree ()

std::pair< std::shared_ptr< BayesNetType >, std::shared_ptr< FactorGraphType > >	eliminate (Eliminate function) const

const FastVector< sharedNode > &	roots () const

const FastVector< sharedFactor > &	remainingFactors () const

void	swap (This &other)

void	print (const std::string &name="EliminationTree: ", const KeyFormatter &formatter=DefaultKeyFormatter) const

Private Member Functions
	SymbolicEliminationTree ()

Friends
class	::EliminationTreeTester

Additional Inherited Members
Protected Types inherited from gtsam::EliminationTree< SymbolicBayesNet, SymbolicFactorGraph >
typedef std::shared_ptr< This >	shared_ptr
	Shared pointer to this class. More...

typedef EliminationTree< SymbolicBayesNet, SymbolicFactorGraph >	This
	This class. More...

Protected Member Functions inherited from gtsam::EliminationTree< SymbolicBayesNet, SymbolicFactorGraph >
	EliminationTree (const FactorGraphType &factorGraph, const VariableIndex &structure, const Ordering &order)

	EliminationTree (const FactorGraphType &factorGraph, const Ordering &order)

	EliminationTree (const This &other)

This &	operator= (const This &other)

	EliminationTree ()
	Protected default constructor. More...

bool	equals (const This &other, double tol=1e-9) const

Protected Attributes inherited from gtsam::EliminationTree< SymbolicBayesNet, SymbolicFactorGraph >
FastVector< sharedFactor >	remainingFactors_

FastVector< sharedNode >	roots_

Detailed Description

Definition at line 27 of file SymbolicEliminationTree.h.

Member Typedef Documentation

◆ Base

typedef EliminationTree<SymbolicBayesNet, SymbolicFactorGraph> gtsam::SymbolicEliminationTree::Base

Base class.

Definition at line 31 of file SymbolicEliminationTree.h.

◆ shared_ptr

typedef std::shared_ptr<This> gtsam::SymbolicEliminationTree::shared_ptr

Shared pointer to this class.

Definition at line 33 of file SymbolicEliminationTree.h.

◆ This

typedef SymbolicEliminationTree gtsam::SymbolicEliminationTree::This

This class.

Definition at line 32 of file SymbolicEliminationTree.h.

Constructor & Destructor Documentation

◆ SymbolicEliminationTree() [1/3]

gtsam::SymbolicEliminationTree::SymbolicEliminationTree	(	const SymbolicFactorGraph &	factorGraph,
		const VariableIndex &	structure,
		const Ordering &	order
	)

Build the elimination tree of a factor graph using pre-computed column structure.

Parameters

factorGraph	The factor graph for which to build the elimination tree
structure	The 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 28 of file SymbolicEliminationTree.cpp.

◆ SymbolicEliminationTree() [2/3]

gtsam::SymbolicEliminationTree::SymbolicEliminationTree	(	const SymbolicFactorGraph &	factorGraph,
		const Ordering &	order
	)

Build the elimination tree of a factor graph. Note that this has to compute the column structure as a VariableIndex, so if you already have this precomputed, use the other constructor instead.

Parameters

factorGraph The factor graph for which to build the elimination tree

Definition at line 34 of file SymbolicEliminationTree.cpp.

◆ SymbolicEliminationTree() [3/3]

gtsam::SymbolicEliminationTree::SymbolicEliminationTree ( )

inlineprivate

Private default constructor for testing

Definition at line 56 of file SymbolicEliminationTree.h.

Member Function Documentation

◆ equals()

bool gtsam::SymbolicEliminationTree::equals	(	const This &	other,
		double	tol = `1e-9`
	)		const

Test whether the tree is equal to another

Definition at line 39 of file SymbolicEliminationTree.cpp.

Friends And Related Function Documentation

◆ ::EliminationTreeTester

friend class ::EliminationTreeTester

friend

Definition at line 58 of file SymbolicEliminationTree.h.

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

Public Types

Public Member Functions

Private Member Functions

Friends

Additional Inherited Members