#include <Conditional.h>

Public Types
typedef boost::iterator_range< typename FACTOR::const_iterator >	Frontals

typedef boost::iterator_range< typename FACTOR::const_iterator >	Parents

Protected Attributes
size_t	nrFrontals_

Private Types
typedef Conditional< FACTOR, DERIVEDCONDITIONAL >	This
	Typedef to this class. More...

Standard Constructors
	Conditional ()

	Conditional (size_t nrFrontals)

Testable
void	print (const std::string &s="Conditional", const KeyFormatter &formatter=DefaultKeyFormatter) const

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

Standard Interface
size_t	nrFrontals () const

size_t	nrParents () const

Key	firstFrontalKey () const

Frontals	frontals () const

Parents	parents () const

FACTOR::const_iterator	beginFrontals () const

FACTOR::const_iterator	endFrontals () const

FACTOR::const_iterator	beginParents () const

FACTOR::const_iterator	endParents () const

Advanced Interface
class	boost::serialization::access

size_t &	nrFrontals ()

FACTOR::iterator	beginFrontals ()

FACTOR::iterator	endFrontals ()

FACTOR::iterator	beginParents ()

FACTOR::iterator	endParents ()

FACTOR &	asFactor ()

const FACTOR &	asFactor () const

template<class ARCHIVE >
void	serialize (ARCHIVE &ar, const unsigned int)

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.

Definition at line 40 of file Conditional.h.

Member Typedef Documentation

template<class FACTOR, class DERIVEDCONDITIONAL>

typedef boost::iterator_range<typename FACTOR::const_iterator> gtsam::Conditional< FACTOR, DERIVEDCONDITIONAL >::Frontals

View of the frontal keys (call frontals())

Definition at line 52 of file Conditional.h.

template<class FACTOR, class DERIVEDCONDITIONAL>

typedef boost::iterator_range<typename FACTOR::const_iterator> gtsam::Conditional< FACTOR, DERIVEDCONDITIONAL >::Parents

View of the separator keys (call parents())

Definition at line 55 of file Conditional.h.

template<class FACTOR, class DERIVEDCONDITIONAL>

typedef Conditional<FACTOR,DERIVEDCONDITIONAL> gtsam::Conditional< FACTOR, DERIVEDCONDITIONAL >::This

private

Typedef to this class.

Definition at line 48 of file Conditional.h.

Constructor & Destructor Documentation

template<class FACTOR, class DERIVEDCONDITIONAL>

gtsam::Conditional< FACTOR, DERIVEDCONDITIONAL >::Conditional ( )

inlineprotected

Empty Constructor to make serialization possible

Definition at line 62 of file Conditional.h.

template<class FACTOR, class DERIVEDCONDITIONAL>

gtsam::Conditional< FACTOR, DERIVEDCONDITIONAL >::Conditional ( size_t nrFrontals )

inlineprotected

Constructor

Definition at line 65 of file Conditional.h.

Member Function Documentation

template<class FACTOR, class DERIVEDCONDITIONAL>

FACTOR& gtsam::Conditional< FACTOR, DERIVEDCONDITIONAL >::asFactor ( )

inlineprivate

Definition at line 137 of file Conditional.h.

template<class FACTOR, class DERIVEDCONDITIONAL>

const FACTOR& gtsam::Conditional< FACTOR, DERIVEDCONDITIONAL >::asFactor ( ) const

inlineprivate

Definition at line 140 of file Conditional.h.

template<class FACTOR, class DERIVEDCONDITIONAL>

FACTOR::const_iterator gtsam::Conditional< FACTOR, DERIVEDCONDITIONAL >::beginFrontals ( ) const

inline

Iterator pointing to first frontal key.

Definition at line 105 of file Conditional.h.

template<class FACTOR, class DERIVEDCONDITIONAL>

FACTOR::iterator gtsam::Conditional< FACTOR, DERIVEDCONDITIONAL >::beginFrontals ( )

inline

Mutable iterator pointing to first frontal key.

Definition at line 124 of file Conditional.h.

template<class FACTOR, class DERIVEDCONDITIONAL>

FACTOR::const_iterator gtsam::Conditional< FACTOR, DERIVEDCONDITIONAL >::beginParents ( ) const

inline

Iterator pointing to the first parent key.

Definition at line 111 of file Conditional.h.

template<class FACTOR, class DERIVEDCONDITIONAL>

FACTOR::iterator gtsam::Conditional< FACTOR, DERIVEDCONDITIONAL >::beginParents ( )

inline

Mutable iterator pointing to the first parent key.

Definition at line 130 of file Conditional.h.

template<class FACTOR, class DERIVEDCONDITIONAL>

FACTOR::const_iterator gtsam::Conditional< FACTOR, DERIVEDCONDITIONAL >::endFrontals ( ) const

inline

Iterator pointing past the last frontal key.

Definition at line 108 of file Conditional.h.

template<class FACTOR, class DERIVEDCONDITIONAL>

FACTOR::iterator gtsam::Conditional< FACTOR, DERIVEDCONDITIONAL >::endFrontals ( )

inline

Mutable iterator pointing past the last frontal key.

Definition at line 127 of file Conditional.h.

template<class FACTOR, class DERIVEDCONDITIONAL>

FACTOR::const_iterator gtsam::Conditional< FACTOR, DERIVEDCONDITIONAL >::endParents ( ) const

inline

Iterator pointing past the last parent key.

Definition at line 114 of file Conditional.h.

template<class FACTOR, class DERIVEDCONDITIONAL>

FACTOR::iterator gtsam::Conditional< FACTOR, DERIVEDCONDITIONAL >::endParents ( )

inline

Mutable iterator pointing past the last parent key.

Definition at line 133 of file Conditional.h.

template<class FACTOR , class DERIVEDFACTOR >

bool gtsam::Conditional< FACTOR, DERIVEDFACTOR >::equals	(	const This &	c,
		double	tol = `1e-9`
	)		const

check equality

Definition at line 42 of file Conditional-inst.h.

template<class FACTOR, class DERIVEDCONDITIONAL>

Key gtsam::Conditional< FACTOR, DERIVEDCONDITIONAL >::firstFrontalKey ( ) const

inline

Convenience function to get the first frontal key

Definition at line 91 of file Conditional.h.

template<class FACTOR, class DERIVEDCONDITIONAL>

Frontals gtsam::Conditional< FACTOR, DERIVEDCONDITIONAL >::frontals ( ) const

inline

return a view of the frontal keys

Definition at line 99 of file Conditional.h.

template<class FACTOR, class DERIVEDCONDITIONAL>

size_t gtsam::Conditional< FACTOR, DERIVEDCONDITIONAL >::nrFrontals ( ) const

inline

return the number of frontals

Definition at line 85 of file Conditional.h.

template<class FACTOR, class DERIVEDCONDITIONAL>

size_t& gtsam::Conditional< FACTOR, DERIVEDCONDITIONAL >::nrFrontals ( )

inline

Mutable version of nrFrontals

Definition at line 121 of file Conditional.h.

template<class FACTOR, class DERIVEDCONDITIONAL>

size_t gtsam::Conditional< FACTOR, DERIVEDCONDITIONAL >::nrParents ( ) const

inline

return the number of parents

Definition at line 88 of file Conditional.h.

template<class FACTOR, class DERIVEDCONDITIONAL>

Parents gtsam::Conditional< FACTOR, DERIVEDCONDITIONAL >::parents ( ) const

inline

return a view of the parent keys

Definition at line 102 of file Conditional.h.

template<class FACTOR , class DERIVEDFACTOR >

void gtsam::Conditional< FACTOR, DERIVEDFACTOR >::print	(	const std::string &	s = `"Conditional< FACTOR, DERIVEDCONDITIONAL >"`,
		const KeyFormatter &	formatter = `DefaultKeyFormatter`
	)		const

print with optional formatter

Definition at line 29 of file Conditional-inst.h.

template<class FACTOR, class DERIVEDCONDITIONAL>

template<class ARCHIVE >

void gtsam::Conditional< FACTOR, DERIVEDCONDITIONAL >::serialize	(	ARCHIVE &	ar,
		const unsigned	int
	)

inlineprivate

Definition at line 145 of file Conditional.h.

Friends And Related Function Documentation

template<class FACTOR, class DERIVEDCONDITIONAL>

friend class boost::serialization::access

friend

Serialization function

Definition at line 143 of file Conditional.h.

Member Data Documentation

template<class FACTOR, class DERIVEDCONDITIONAL>

size_t gtsam::Conditional< FACTOR, DERIVEDCONDITIONAL >::nrFrontals_

protected

The first nrFrontal variables are frontal and the rest are parents.

Definition at line 44 of file Conditional.h.

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

Public Types

Protected Attributes

Private Types

Standard Constructors

Testable

Standard Interface

Advanced Interface

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

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