Updated BayesNet documentation.

release/4.3a0
Richard Roberts 2011-02-15 17:45:07 +00:00
parent 62b3db9535
commit 7212d65d8c
2 changed files with 8 additions and 5 deletions

View File

@ -31,10 +31,13 @@
namespace gtsam { namespace gtsam {
/** /**
* Bayes network * A BayesNet is a list of conditionals, stored in elimination order, i.e.
* This is the base class for SymbolicBayesNet, DiscreteBayesNet, and GaussianBayesNet * leaves first, parents last. GaussianBayesNet and SymbolicBayesNet are
* corresponding to what is used for the "Conditional" template argument: * defined as typedefs of this class, using GaussianConditional and
* a SymbolicConditional, ConditionalProbabilityTable, or a GaussianConditional * IndexConditional as the CONDITIONAL template argument.
*
* todo: Symbolic using Index is a misnomer.
* todo: how to handle Bayes nets with an optimize function? Currently using global functions.
*/ */
template<class CONDITIONAL> template<class CONDITIONAL>
class BayesNet: public Testable<BayesNet<CONDITIONAL> > { class BayesNet: public Testable<BayesNet<CONDITIONAL> > {

View File

@ -43,7 +43,7 @@ namespace gtsam {
public: public:
typedef boost::shared_ptr<BayesTree<CONDITIONAL> > shared_ptr; typedef boost::shared_ptr<BayesTree<CONDITIONAL> > shared_ptr;
typedef boost::shared_ptr<CONDITIONAL> sharedConditional; typedef boost::shared_ptr<CONDITIONAL> sharedConditional;
typedef boost::shared_ptr<BayesNet<CONDITIONAL> > sharedBayesNet; typedef boost::shared_ptr<BayesNet<CONDITIONAL> > sharedBayesNet;