gtsam::Conditional< FACTOR, DERIVEDCONDITIONAL > Class Template Reference

Detailed Description

template<class FACTOR, class DERIVEDCONDITIONAL>
class gtsam::Conditional< FACTOR, DERIVEDCONDITIONAL >

TODO: Update comments.

The following comments are out of date!!!

Base class for conditional densities, templated on KEY type. This class provides storage for the keys involved in a conditional, and iterators and access to the frontal and separator keys.

Derived classes must redefine the Factor and shared_ptr typedefs to refer to the associated factor type and shared_ptr type of the derived class. See IndexConditional and GaussianConditional for examples.

Advanced Interface
class	boost::serialization::access
	Serialization function.
size_t &	nrFrontals ()
	Mutable version of nrFrontals.
FACTOR::iterator	beginFrontals ()
	Mutable iterator pointing to first frontal key.
FACTOR::iterator	endFrontals ()
	Mutable iterator pointing past the last frontal key.
FACTOR::iterator	beginParents ()
	Mutable iterator pointing to the first parent key.
FACTOR::iterator	endParents ()
	Mutable iterator pointing past the last parent key.

Standard Constructors
	Conditional ()
	Empty Constructor to make serialization possible.
	Conditional (size_t nrFrontals)
	Constructor.

Testable
void	print (const std::string &s="Conditional", const KeyFormatter &formatter=DefaultKeyFormatter) const
	print with optional formatter
bool	equals (const This &c, double tol=1e-9) const
	check equality

Standard Interface
size_t	nrFrontals () const
	return the number of frontals
size_t	nrParents () const
	return the number of parents
Key	firstFrontalKey () const
	Convenience function to get the first frontal key.
Frontals	frontals () const
	return a view of the frontal keys
Parents	parents () const
	return a view of the parent keys
FACTOR::const_iterator	beginFrontals () const
	Iterator pointing to first frontal key.
FACTOR::const_iterator	endFrontals () const
	Iterator pointing past the last frontal key.
FACTOR::const_iterator	beginParents () const
	Iterator pointing to the first parent key.
FACTOR::const_iterator	endParents () const
	Iterator pointing past the last parent key.

Public Types
typedef boost::iterator_range< typename FACTOR::const_iterator >	Frontals
	View of the frontal keys (call frontals())
typedef boost::iterator_range< typename FACTOR::const_iterator >	Parents
	View of the separator keys (call parents())

Protected Attributes
size_t	nrFrontals_
	The first nrFrontal variables are frontal and the rest are parents.

---

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

• /Users/dellaert/git/github/gtsam/inference/Conditional.h
• /Users/dellaert/git/github/gtsam/inference/Conditional-inst.h