Public Types | Private Types | List of all members
gtsam::DiscreteBayesTree Class Reference

A Bayes tree representing a Discrete distribution. More...

#include <DiscreteBayesTree.h>

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

Public Types

typedef std::shared_ptr< Thisshared_ptr
 
typedef DiscreteBayesTree This
 
- Public Types inherited from gtsam::BayesTree< DiscreteBayesTreeClique >
typedef DiscreteBayesTreeClique ::BayesNetType BayesNetType
 
typedef DiscreteBayesTreeClique Clique
 The clique type, normally BayesTreeClique. More...
 
typedef FastList< sharedCliqueCliques
 
typedef DiscreteBayesTreeClique ::ConditionalType ConditionalType
 
typedef FactorGraphType::Eliminate Eliminate
 
typedef DiscreteBayesTreeClique ::EliminationTraitsType EliminationTraitsType
 
typedef DiscreteBayesTreeClique ::FactorGraphType FactorGraphType
 
typedef DiscreteBayesTreeClique ::FactorType FactorType
 
typedef Clique Node
 Synonym for Clique (TODO: remove) More...
 
typedef ConcurrentMap< Key, sharedCliqueNodes
 
typedef FastVector< sharedCliqueRoots
 
typedef std::shared_ptr< BayesNetTypesharedBayesNet
 
typedef std::shared_ptr< CliquesharedClique
 Shared pointer to a clique. More...
 
typedef std::shared_ptr< ConditionalTypesharedConditional
 
typedef std::shared_ptr< FactorTypesharedFactor
 
typedef std::shared_ptr< FactorGraphTypesharedFactorGraph
 
typedef sharedClique sharedNode
 Synonym for sharedClique (TODO: remove) More...
 

Public Member Functions

Standard interface
 DiscreteBayesTree ()
 
bool equals (const This &other, double tol=1e-9) const
 
double evaluate (const DiscreteValues &values) const
 
double operator() (const DiscreteValues &values) const
 
Wrapper support
std::string markdown (const KeyFormatter &keyFormatter=DefaultKeyFormatter, const DiscreteFactor::Names &names={}) const
 Render as markdown tables. More...
 
std::string html (const KeyFormatter &keyFormatter=DefaultKeyFormatter, const DiscreteFactor::Names &names={}) const
 Render as html tables. More...
 
- Public Member Functions inherited from gtsam::BayesTree< DiscreteBayesTreeClique >
size_t size () const
 
bool empty () const
 
const Nodesnodes () const
 
sharedClique operator[] (Key j) const
 
const Rootsroots () const
 
const sharedCliqueclique (Key j) const
 
BayesTreeCliqueData getCliqueData () const
 
size_t numCachedSeparatorMarginals () const
 
sharedConditional marginalFactor (Key j, const Eliminate &function=EliminationTraitsType::DefaultEliminate) const
 
sharedFactorGraph joint (Key j1, Key j2, const Eliminate &function=EliminationTraitsType::DefaultEliminate) const
 
sharedBayesNet jointBayesNet (Key j1, Key j2, const Eliminate &function=EliminationTraitsType::DefaultEliminate) const
 
void dot (std::ostream &os, const KeyFormatter &keyFormatter=DefaultKeyFormatter) const
 Output to graphviz format, stream version. More...
 
std::string dot (const KeyFormatter &keyFormatter=DefaultKeyFormatter) const
 Output to graphviz format string. More...
 
void saveGraph (const std::string &filename, const KeyFormatter &keyFormatter=DefaultKeyFormatter) const
 output to file with graphviz format. More...
 
Key findParentClique (const CONTAINER &parents) const
 
void clear ()
 
void deleteCachedShortcuts ()
 
void removePath (sharedClique clique, BayesNetType *bn, Cliques *orphans)
 
void removeTop (const KeyVector &keys, BayesNetType *bn, Cliques *orphans)
 
Cliques removeSubtree (const sharedClique &subtree)
 
void insertRoot (const sharedClique &subtree)
 
void addClique (const sharedClique &clique, const sharedClique &parent_clique=sharedClique())
 
void addFactorsToGraph (FactorGraph< FactorType > *graph) const
 
void print (const std::string &s="", const KeyFormatter &keyFormatter=DefaultKeyFormatter) const
 

Private Types

typedef BayesTree< DiscreteBayesTreeCliqueBase
 

Additional Inherited Members

- Protected Types inherited from gtsam::BayesTree< DiscreteBayesTreeClique >
typedef std::shared_ptr< Thisshared_ptr
 
typedef BayesTree< DiscreteBayesTreeCliqueThis
 
- Protected Member Functions inherited from gtsam::BayesTree< DiscreteBayesTreeClique >
Thisoperator= (const This &other)
 
 ~BayesTree ()
 
 BayesTree ()
 
 BayesTree (const This &other)
 
void getCliqueData (sharedClique clique, BayesTreeCliqueData *stats) const
 
void dot (std::ostream &s, sharedClique clique, const KeyFormatter &keyFormatter, int parentnum=0) const
 
void removeClique (sharedClique clique)
 
void fillNodesIndex (const sharedClique &subtree)
 
bool equals (const This &other, double tol=1e-9) const
 
- Protected Attributes inherited from gtsam::BayesTree< DiscreteBayesTreeClique >
Nodes nodes_
 
Roots roots_
 

Detailed Description

A Bayes tree representing a Discrete distribution.

Definition at line 68 of file DiscreteBayesTree.h.

Member Typedef Documentation

◆ Base

Definition at line 71 of file DiscreteBayesTree.h.

◆ shared_ptr

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

Definition at line 75 of file DiscreteBayesTree.h.

◆ This

Definition at line 74 of file DiscreteBayesTree.h.

Constructor & Destructor Documentation

◆ DiscreteBayesTree()

gtsam::DiscreteBayesTree::DiscreteBayesTree ( )
inline

Default constructor, creates an empty Bayes tree

Definition at line 80 of file DiscreteBayesTree.h.

Member Function Documentation

◆ equals()

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

Check equality

Definition at line 44 of file DiscreteBayesTree.cpp.

◆ evaluate()

double gtsam::DiscreteBayesTree::evaluate ( const DiscreteValues values) const

Definition at line 49 of file DiscreteBayesTree.cpp.

◆ html()

std::string gtsam::DiscreteBayesTree::html ( const KeyFormatter keyFormatter = DefaultKeyFormatter,
const DiscreteFactor::Names names = {} 
) const

Render as html tables.

Definition at line 76 of file DiscreteBayesTree.cpp.

◆ markdown()

std::string gtsam::DiscreteBayesTree::markdown ( const KeyFormatter keyFormatter = DefaultKeyFormatter,
const DiscreteFactor::Names names = {} 
) const

Render as markdown tables.

Definition at line 59 of file DiscreteBayesTree.cpp.

◆ operator()()

double gtsam::DiscreteBayesTree::operator() ( const DiscreteValues values) const
inline

Definition at line 89 of file DiscreteBayesTree.h.


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


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