Elimination tree for discrete factors. More...

#include <DiscreteEliminationTree.h>

Inheritance diagram for gtsam::DiscreteEliminationTree:

Public Types
typedef EliminationTree< DiscreteBayesNet, DiscreteFactorGraph >	Base
	Base class. More...

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

typedef DiscreteEliminationTree	This
	This class. More...

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

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

typedef DiscreteFactorGraph ::Eliminate	Eliminate

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

typedef DiscreteFactorGraph ::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
	DiscreteEliminationTree (const DiscreteFactorGraph &factorGraph, const Ordering &order)

	DiscreteEliminationTree (const DiscreteFactorGraph &factorGraph, const VariableIndex &structure, const Ordering &order)

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

Public Member Functions inherited from gtsam::EliminationTree< DiscreteBayesNet, DiscreteFactorGraph >
	~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

Friends
class	::EliminationTreeTester

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

typedef EliminationTree< DiscreteBayesNet, DiscreteFactorGraph >	This
	This class. More...

Protected Member Functions inherited from gtsam::EliminationTree< DiscreteBayesNet, DiscreteFactorGraph >
	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< DiscreteBayesNet, DiscreteFactorGraph >
FastVector< sharedFactor >	remainingFactors_

FastVector< sharedNode >	roots_

Detailed Description

Elimination tree for discrete factors.

Definition at line 31 of file DiscreteEliminationTree.h.

Member Typedef Documentation

◆ Base

typedef EliminationTree<DiscreteBayesNet, DiscreteFactorGraph> gtsam::DiscreteEliminationTree::Base

Base class.

Definition at line 35 of file DiscreteEliminationTree.h.

◆ shared_ptr

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

Shared pointer to this class.

Definition at line 37 of file DiscreteEliminationTree.h.

◆ This

typedef DiscreteEliminationTree gtsam::DiscreteEliminationTree::This

This class.

Definition at line 36 of file DiscreteEliminationTree.h.

Constructor & Destructor Documentation

◆ DiscreteEliminationTree() [1/2]

gtsam::DiscreteEliminationTree::DiscreteEliminationTree	(	const DiscreteFactorGraph &	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 DiscreteEliminationTree.cpp.

◆ DiscreteEliminationTree() [2/2]

gtsam::DiscreteEliminationTree::DiscreteEliminationTree	(	const DiscreteFactorGraph &	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 DiscreteEliminationTree.cpp.

Member Function Documentation

◆ equals()

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

Test whether the tree is equal to another

Definition at line 39 of file DiscreteEliminationTree.cpp.

Friends And Related Function Documentation

◆ ::EliminationTreeTester

friend class ::EliminationTreeTester

friend

Definition at line 63 of file DiscreteEliminationTree.h.

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

Public Types

Public Member Functions

Friends

Additional Inherited Members