#include <SymbolicConditional.h>

Inheritance diagram for gtsam::SymbolicConditional:

[legend]

Public Types
typedef Conditional< BaseFactor, This >	BaseConditional
	Typedef to the factor base class. More...

typedef SymbolicFactor	BaseFactor
	Typedef to this class. More...

typedef BaseFactor::const_iterator	const_iterator
	iterator to keys More...

typedef BaseFactor::iterator	iterator
	Boost shared_ptr to this class. More...

typedef std::shared_ptr< This >	shared_ptr
	Typedef to the conditional base class. More...

typedef SymbolicConditional	This

Public Types inherited from gtsam::SymbolicFactor
typedef Factor	Base

typedef SymbolicConditional	ConditionalType

typedef std::shared_ptr< This >	shared_ptr

typedef SymbolicFactor	This

Public Types inherited from gtsam::Factor
typedef KeyVector::const_iterator	const_iterator
	Const iterator over keys. More...

typedef KeyVector::iterator	iterator
	Iterator over keys. More...

Public Types inherited from gtsam::Conditional< SymbolicFactor, SymbolicConditional >
typedef std::pair< typename SymbolicFactor ::const_iterator, typename SymbolicFactor ::const_iterator >	ConstFactorRange

typedef ConstFactorRangeIterator	Frontals

typedef ConstFactorRangeIterator	Parents

Standard Constructors
const_iterator to keys
	SymbolicConditional ()

	SymbolicConditional (Key j)

	SymbolicConditional (Key j, Key parent)

	SymbolicConditional (Key j, Key parent1, Key parent2)

	SymbolicConditional (Key j, Key parent1, Key parent2, Key parent3)

SymbolicFactor::shared_ptr	clone () const
	Copy this object as its actual derived type. More...

template<typename ITERATOR >
static SymbolicConditional	FromIterators (ITERATOR firstKey, ITERATOR lastKey, size_t nrFrontals)

template<typename ITERATOR >
static SymbolicConditional::shared_ptr	FromIteratorsShared (ITERATOR firstKey, ITERATOR lastKey, size_t nrFrontals)

template<class CONTAINER >
static SymbolicConditional	FromKeys (const CONTAINER &keys, size_t nrFrontals)

template<class CONTAINER >
static SymbolicConditional::shared_ptr	FromKeysShared (const CONTAINER &keys, size_t nrFrontals)

Testable
void	print (const std::string &str="", const KeyFormatter &keyFormatter=DefaultKeyFormatter) const override

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

HybridValues methods.
double	logProbability (const HybridValues &x) const override
	logProbability throws exception, symbolic. More...

double	evaluate (const HybridValues &x) const override
	evaluate throws exception, symbolic. More...

double	error (const HybridValues &c) const override
	The `error` method throws an exception. More...

Additional Inherited Members
Public Member Functions inherited from gtsam::SymbolicFactor
	SymbolicFactor ()

	SymbolicFactor (Key j)

	SymbolicFactor (Key j1, Key j2)

	SymbolicFactor (Key j1, Key j2, Key j3)

	SymbolicFactor (Key j1, Key j2, Key j3, Key j4)

	SymbolicFactor (Key j1, Key j2, Key j3, Key j4, Key j5)

	SymbolicFactor (Key j1, Key j2, Key j3, Key j4, Key j5, Key j6)

	SymbolicFactor (const Factor &factor)

SymbolicFactor::shared_ptr	clone () const
	Copy this object as its actual derived type. More...

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

void	print (const std::string &s="SymbolicFactor", const KeyFormatter &formatter=DefaultKeyFormatter) const override
	print More...

void	printKeys (const std::string &s="SymbolicFactor", const KeyFormatter &formatter=DefaultKeyFormatter) const override
	print only keys More...

double	error (const HybridValues &c) const override
	The `error` method throws an exception. More...

std::pair< std::shared_ptr< SymbolicConditional >, std::shared_ptr< SymbolicFactor > >	eliminate (const Ordering &keys) const

Public Member Functions inherited from gtsam::Factor
virtual	~Factor ()=default
	Default destructor. More...

bool	empty () const
	Whether the factor is empty (involves zero variables). More...

Key	front () const
	First key. More...

Key	back () const
	Last key. More...

const_iterator	find (Key key) const
	find More...

const KeyVector &	keys () const
	Access the factor's involved variable keys. More...

const_iterator	begin () const

const_iterator	end () const

size_t	size () const

bool	equals (const This &other, double tol=1e-9) const
	check equality More...

KeyVector &	keys ()

iterator	begin ()

iterator	end ()

Public Member Functions inherited from gtsam::Conditional< SymbolicFactor, SymbolicConditional >
void	print (const std::string &s="Conditional", const KeyFormatter &formatter=DefaultKeyFormatter) const

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

virtual	~Conditional ()

size_t	nrFrontals () const

size_t	nrParents () const

Key	firstFrontalKey () const

Frontals	frontals () const

Parents	parents () const

double	operator() (const HybridValues &x) const
	Evaluate probability density, sugar. More...

virtual double	negLogConstant () const
	All conditional types need to implement this as the negative log of the normalization constant to make it such that error>=0. More...

size_t &	nrFrontals ()

SymbolicFactor ::const_iterator	beginFrontals () const

SymbolicFactor ::iterator	beginFrontals ()

SymbolicFactor ::const_iterator	endFrontals () const

SymbolicFactor ::iterator	endFrontals ()

SymbolicFactor ::const_iterator	beginParents () const

SymbolicFactor ::iterator	beginParents ()

SymbolicFactor ::const_iterator	endParents () const

SymbolicFactor ::iterator	endParents ()

Static Public Member Functions inherited from gtsam::SymbolicFactor
template<typename KEYITERATOR >
static SymbolicFactor	FromIterators (KEYITERATOR beginKey, KEYITERATOR endKey)

template<typename KEYITERATOR >
static SymbolicFactor::shared_ptr	FromIteratorsShared (KEYITERATOR beginKey, KEYITERATOR endKey)

template<class CONTAINER >
static SymbolicFactor	FromKeys (const CONTAINER &keys)

template<class CONTAINER >
static SymbolicFactor::shared_ptr	FromKeysShared (const CONTAINER &keys)

Static Public Member Functions inherited from gtsam::Conditional< SymbolicFactor, SymbolicConditional >
static bool	CheckInvariants (const SymbolicConditional &conditional, const VALUES &x)

Protected Member Functions inherited from gtsam::Factor
	Factor ()

template<typename CONTAINER >
	Factor (const CONTAINER &keys)

template<typename ITERATOR >
	Factor (ITERATOR first, ITERATOR last)

Protected Member Functions inherited from gtsam::Conditional< SymbolicFactor, SymbolicConditional >
	Conditional ()

	Conditional (size_t nrFrontals)

Static Protected Member Functions inherited from gtsam::Factor
template<typename CONTAINER >
static Factor	FromKeys (const CONTAINER &keys)

template<typename ITERATOR >
static Factor	FromIterators (ITERATOR first, ITERATOR last)

Protected Attributes inherited from gtsam::Factor
KeyVector	keys_
	The keys involved in this factor. More...

Protected Attributes inherited from gtsam::Conditional< SymbolicFactor, SymbolicConditional >
size_t	nrFrontals_

Detailed Description

SymbolicConditional is a conditional with keys but no probability data, produced by symbolic elimination of SymbolicFactor.

It is also a SymbolicFactor, and thus derives from it. It derives also from Conditional<This>, which is a generic interface class for conditionals.

Definition at line 36 of file SymbolicConditional.h.

Member Typedef Documentation

◆ BaseConditional

typedef Conditional<BaseFactor, This> gtsam::SymbolicConditional::BaseConditional

Typedef to the factor base class.

Definition at line 43 of file SymbolicConditional.h.

◆ BaseFactor

typedef SymbolicFactor gtsam::SymbolicConditional::BaseFactor

Typedef to this class.

Definition at line 42 of file SymbolicConditional.h.

◆ const_iterator

typedef BaseFactor::const_iterator gtsam::SymbolicConditional::const_iterator

iterator to keys

Definition at line 46 of file SymbolicConditional.h.

◆ iterator

typedef BaseFactor::iterator gtsam::SymbolicConditional::iterator

Boost shared_ptr to this class.

Definition at line 45 of file SymbolicConditional.h.

◆ shared_ptr

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

Typedef to the conditional base class.

Definition at line 44 of file SymbolicConditional.h.

◆ This

typedef SymbolicConditional gtsam::SymbolicConditional::This

Definition at line 41 of file SymbolicConditional.h.

Constructor & Destructor Documentation

◆ SymbolicConditional() [1/5]

gtsam::SymbolicConditional::SymbolicConditional ( )

inline

Empty Constructor to make serialization possible

Definition at line 52 of file SymbolicConditional.h.

◆ SymbolicConditional() [2/5]

gtsam::SymbolicConditional::SymbolicConditional ( Key j )

inline

No parents

Definition at line 55 of file SymbolicConditional.h.

◆ SymbolicConditional() [3/5]

gtsam::SymbolicConditional::SymbolicConditional	(	Key	j,
		Key	parent
	)

inline

Single parent

Definition at line 58 of file SymbolicConditional.h.

◆ SymbolicConditional() [4/5]

gtsam::SymbolicConditional::SymbolicConditional	(	Key	j,
		Key	parent1,
		Key	parent2
	)

inline

Two parents

Definition at line 61 of file SymbolicConditional.h.

◆ SymbolicConditional() [5/5]

gtsam::SymbolicConditional::SymbolicConditional	(	Key	j,
		Key	parent1,
		Key	parent2,
		Key	parent3
	)

inline

Three parents

Definition at line 64 of file SymbolicConditional.h.

Member Function Documentation

◆ clone()

SymbolicFactor::shared_ptr gtsam::SymbolicConditional::clone ( ) const

inline

Copy this object as its actual derived type.

Definition at line 99 of file SymbolicConditional.h.

◆ equals()

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

Check equality

Definition at line 31 of file SymbolicConditional.cpp.

◆ error()

double gtsam::SymbolicFactor::error

override

The error method throws an exception.

Definition at line 30 of file SymbolicFactor.cpp.

◆ evaluate()

double gtsam::SymbolicConditional::evaluate ( const HybridValues & x ) const

overridevirtual

evaluate throws exception, symbolic.

Reimplemented from gtsam::Conditional< SymbolicFactor, SymbolicConditional >.

Definition at line 41 of file SymbolicConditional.cpp.

◆ FromIterators()

template<typename ITERATOR >

static SymbolicConditional gtsam::SymbolicConditional::FromIterators	(	ITERATOR	firstKey,
		ITERATOR	lastKey,
		size_t	nrFrontals
	)

inlinestatic

Named constructor from an arbitrary number of keys and frontals

Definition at line 68 of file SymbolicConditional.h.

◆ FromIteratorsShared()

template<typename ITERATOR >

static SymbolicConditional::shared_ptr gtsam::SymbolicConditional::FromIteratorsShared	(	ITERATOR	firstKey,
		ITERATOR	lastKey,
		size_t	nrFrontals
	)

inlinestatic

Named constructor from an arbitrary number of keys and frontals

Definition at line 78 of file SymbolicConditional.h.

◆ FromKeys()

template<class CONTAINER >

static SymbolicConditional gtsam::SymbolicConditional::FromKeys	(	const CONTAINER &	keys,
		size_t	nrFrontals
	)

inlinestatic

Named constructor from an arbitrary number of keys and frontals

Definition at line 88 of file SymbolicConditional.h.

◆ FromKeysShared()

template<class CONTAINER >

static SymbolicConditional::shared_ptr gtsam::SymbolicConditional::FromKeysShared	(	const CONTAINER &	keys,
		size_t	nrFrontals
	)

inlinestatic

Named constructor from an arbitrary number of keys and frontals

Definition at line 94 of file SymbolicConditional.h.

◆ logProbability()

double gtsam::SymbolicConditional::logProbability ( const HybridValues & x ) const

overridevirtual

logProbability throws exception, symbolic.

Reimplemented from gtsam::Conditional< SymbolicFactor, SymbolicConditional >.

Definition at line 36 of file SymbolicConditional.cpp.

◆ print()

void gtsam::SymbolicConditional::print	(	const std::string &	str = `""`,
		const KeyFormatter &	keyFormatter = `DefaultKeyFormatter`
	)		const

overridevirtual

Print with optional formatter

Reimplemented from gtsam::Factor.

Definition at line 25 of file SymbolicConditional.cpp.

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

Public Types

Standard Constructors

Testable

HybridValues methods.

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseConditional

◆ BaseFactor

◆ const_iterator

◆ iterator

◆ shared_ptr

◆ This

Constructor & Destructor Documentation

◆ SymbolicConditional() [1/5]

◆ SymbolicConditional() [2/5]

◆ SymbolicConditional() [3/5]

◆ SymbolicConditional() [4/5]

◆ SymbolicConditional() [5/5]

Member Function Documentation

◆ clone()

◆ equals()

◆ error()

◆ evaluate()

◆ FromIterators()

◆ FromIteratorsShared()

◆ FromKeys()

◆ FromKeysShared()

◆ logProbability()

◆ print()