gtsam::DiscreteBayesTreeClique Class Reference

#include <DiscreteBayesTree.h>

Inheritance diagram for gtsam::DiscreteBayesTreeClique:

Public Types
typedef BayesTreeCliqueBase< DiscreteBayesTreeClique, DiscreteFactorGraph >	Base
typedef std::shared_ptr< This >	shared_ptr
typedef DiscreteBayesTreeClique	This
typedef std::weak_ptr< This >	weak_ptr
Public Types inherited from gtsam::BayesTreeCliqueBase< DiscreteBayesTreeClique, DiscreteFactorGraph >
typedef EliminationTraitsType::BayesNetType	BayesNetType
typedef BayesNetType::ConditionalType	ConditionalType
typedef FactorGraphType::Eliminate	Eliminate
typedef DiscreteFactorGraph	FactorGraphType
typedef FactorGraphType::FactorType	FactorType
typedef std::shared_ptr< ConditionalType >	sharedConditional

Public Member Functions
	DiscreteBayesTreeClique ()
	DiscreteBayesTreeClique (const std::shared_ptr< DiscreteConditional > &conditional)
double	evaluate (const DiscreteValues &values) const
double	operator() (const DiscreteValues &values) const
void	printSignature (const std::string &s="Clique: ", const KeyFormatter &formatter=DefaultKeyFormatter) const
	print index signature only More...
Public Member Functions inherited from gtsam::BayesTreeCliqueBase< DiscreteBayesTreeClique, DiscreteFactorGraph >
void	setEliminationResult (const typename FactorGraphType::EliminationResult &eliminationResult)
bool	equals (const DiscreteBayesTreeClique &other, double tol=1e-9) const
virtual void	print (const std::string &s="", const KeyFormatter &keyFormatter=DefaultKeyFormatter) const
const sharedConditional &	conditional () const
sharedConditional &	conditional ()
bool	isRoot () const
	Return true if this clique is the root of a Bayes tree. More...
size_t	nrChildren () const
	Return the number of children. More...
const derived_ptr	operator[] (size_t i) const
	Return the child at index i. More...
size_t	treeSize () const
size_t	numCachedSeparatorMarginals () const
derived_ptr	parent () const
int	problemSize () const
BayesNetType	shortcut (const derived_ptr &root, Eliminate function=EliminationTraitsType::DefaultEliminate) const
FactorGraphType	separatorMarginal (Eliminate function=EliminationTraitsType::DefaultEliminate) const
FactorGraphType	marginal2 (Eliminate function=EliminationTraitsType::DefaultEliminate) const
void	deleteCachedShortcuts ()
const std::optional< FactorGraphType > &	cachedSeparatorMarginal () const

Additional Inherited Members
Public Attributes inherited from gtsam::BayesTreeCliqueBase< DiscreteBayesTreeClique, DiscreteFactorGraph >
FastVector< derived_ptr >	children
sharedConditional	conditional_
bool	is_root
derived_weak_ptr	parent_
int	problemSize_
Protected Member Functions inherited from gtsam::BayesTreeCliqueBase< DiscreteBayesTreeClique, DiscreteFactorGraph >
	BayesTreeCliqueBase ()
	Default constructor. More...
	BayesTreeCliqueBase (const sharedConditional &conditional)
	BayesTreeCliqueBase (const BayesTreeCliqueBase &c)
	Shallow copy constructor. More...
BayesTreeCliqueBase &	operator= (const BayesTreeCliqueBase &c)
	Shallow copy assignment constructor. More...
virtual	~BayesTreeCliqueBase ()
KeyVector	separator_setminus_B (const derived_ptr &B) const
	Calculate set for shortcut calculations. More...
KeyVector	shortcut_indices (const derived_ptr &B, const FactorGraphType &p_Cp_B) const
void	deleteCachedShortcutsNonRecursive ()
Protected Attributes inherited from gtsam::BayesTreeCliqueBase< DiscreteBayesTreeClique, DiscreteFactorGraph >
std::optional< FactorGraphType >	cachedSeparatorMarginal_
	This stores the Cached separator marginal P(S) More...
std::mutex	cachedSeparatorMarginalMutex_

Detailed Description

A clique in a DiscreteBayesTree

Definition at line 39 of file DiscreteBayesTree.h.

Member Typedef Documentation

Base

typedef BayesTreeCliqueBase<DiscreteBayesTreeClique, DiscreteFactorGraph> gtsam::DiscreteBayesTreeClique::Base

Definition at line 44 of file DiscreteBayesTree.h.

shared_ptr

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

Definition at line 45 of file DiscreteBayesTree.h.

This

typedef DiscreteBayesTreeClique gtsam::DiscreteBayesTreeClique::This

Definition at line 42 of file DiscreteBayesTree.h.

weak_ptr

typedef std::weak_ptr<This> gtsam::DiscreteBayesTreeClique::weak_ptr

Definition at line 46 of file DiscreteBayesTree.h.

Constructor & Destructor Documentation

DiscreteBayesTreeClique() [1/2]

gtsam::DiscreteBayesTreeClique::DiscreteBayesTreeClique ( )

inline

Definition at line 47 of file DiscreteBayesTree.h.

DiscreteBayesTreeClique() [2/2]

gtsam::DiscreteBayesTreeClique::DiscreteBayesTreeClique ( const std::shared_ptr< DiscreteConditional > &  conditional )

inline

Definition at line 48 of file DiscreteBayesTree.h.

Member Function Documentation

evaluate()

double gtsam::DiscreteBayesTreeClique::evaluate

(

const DiscreteValues &

values

)

const

Definition at line 33 of file DiscreteBayesTree.cpp.

operator()()

double gtsam::DiscreteBayesTreeClique::operator() ( const DiscreteValues &  values ) const

inline

Definition at line 63 of file DiscreteBayesTree.h.

printSignature()

void gtsam::DiscreteBayesTreeClique::printSignature ( const std::string &  s = "Clique: ", const KeyFormatter &  formatter = DefaultKeyFormatter  ) const

inline

print index signature only

Definition at line 53 of file DiscreteBayesTree.h.

---

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

• DiscreteBayesTree.h
• DiscreteBayesTree.cpp