#include <SingleValue.h>

Inheritance diagram for gtsam::SingleValue:

[legend]

Public Types
typedef std::shared_ptr< SingleValue >	shared_ptr

Public Types inherited from gtsam::Constraint
typedef std::shared_ptr< Constraint >	shared_ptr

Public Types inherited from gtsam::DiscreteFactor
typedef Factor	Base
	Our base class. More...

using	Binary = std::function< double(const double, const double)>

typedef std::shared_ptr< DiscreteFactor >	shared_ptr
	shared_ptr to this class More...

typedef DiscreteFactor	This
	This class. More...

using	Unary = std::function< double(const double &)>

using	UnaryAssignment = std::function< double(const Assignment< Key > &, const double &)>

using	Values = DiscreteValues
	backwards compatibility More...

using	Names = DiscreteValues::Names
	Translation table from values to strings. More...

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 Member Functions
bool	ensureArcConsistency (Key j, Domains *domains) const override

bool	equals (const DiscreteFactor &other, double tol) const override
	equals More...

double	evaluate (const Assignment< Key > &values) const override
	Calculate value. More...

DecisionTreeFactor	operator* (const DecisionTreeFactor &f) const override
	Multiply into a decisiontree. More...

Constraint::shared_ptr	partiallyApply (const DiscreteValues &values) const override
	Partially apply known values. More...

Constraint::shared_ptr	partiallyApply (const Domains &domains) const override
	Partially apply known values, domain version. More...

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

	SingleValue (const DiscreteKey &dkey, size_t value)
	Construct from DiscreteKey and given value. More...

	SingleValue (Key key, size_t n, size_t value)
	Construct from key, cardinality, and given value. More...

DecisionTreeFactor	toDecisionTreeFactor () const override
	Convert into a decisiontree. More...

Public Member Functions inherited from gtsam::Constraint
	Constraint ()
	Default constructor for I/O. More...

	~Constraint () override
	Virtual destructor. More...

DiscreteFactor::shared_ptr	multiply (const DiscreteFactor::shared_ptr &df) const override
	Multiply factors, DiscreteFactor::shared_ptr edition. More...

virtual DiscreteFactor::shared_ptr	operator* (double s) const override
	Multiply by a scalar. More...

DiscreteFactor::shared_ptr	operator/ (const DiscreteFactor::shared_ptr &df) const override
	divide by DiscreteFactor::shared_ptr f (safely) More...

uint64_t	nrValues () const override
	Get the number of non-zero values contained in this factor. More...

DiscreteFactor::shared_ptr	sum (size_t nrFrontals) const override
	Create new factor by summing all values with the same separator values. More...

DiscreteFactor::shared_ptr	sum (const Ordering &keys) const override
	Create new factor by summing all values with the same separator values. More...

double	max () const override
	Find the max value. More...

DiscreteFactor::shared_ptr	max (size_t nrFrontals) const override
	Create new factor by maximizing over all values with the same separator. More...

DiscreteFactor::shared_ptr	max (const Ordering &keys) const override
	Create new factor by maximizing over all values with the same separator. More...

AlgebraicDecisionTree< Key >	errorTree () const override
	Compute error for each assignment and return as a tree. More...

DiscreteFactor::shared_ptr	restrict (const DiscreteValues &assignment) const override
	Compute error for each assignment and return as a tree. More...

std::string	markdown (const KeyFormatter &keyFormatter=DefaultKeyFormatter, const Names &names={}) const override
	Render as markdown table. More...

std::string	html (const KeyFormatter &keyFormatter=DefaultKeyFormatter, const Names &names={}) const override
	Render as html table. More...

Public Member Functions inherited from gtsam::DiscreteFactor
	DiscreteFactor ()

template<typename CONTAINER >
	DiscreteFactor (const CONTAINER &keys, const std::map< Key, size_t > cardinalities={})

DiscreteKeys	discreteKeys () const
	Return all the discrete keys associated with this factor. More...

std::map< Key, size_t >	cardinalities () const

size_t	cardinality (Key j) const

double	operator() (const DiscreteValues &values) const
	Find value for given assignment of values to variables. More...

virtual double	error (const DiscreteValues &values) const
	Error is just -log(value) More...

double	error (const HybridValues &c) const override

DiscreteFactor::shared_ptr	scale () const
	Scale the factor values by the maximum to prevent underflow/overflow. More...

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

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

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

KeyVector &	keys ()

iterator	begin ()

iterator	end ()

Private Member Functions
DiscreteKey	discreteKey () const

Private Attributes
size_t	cardinality_

size_t	value_
	< Number of values More...

Additional Inherited Members
Protected Member Functions inherited from gtsam::Constraint
	Constraint (const KeyVector &js)
	Construct n-way constraint factor. More...

	Constraint (Key j)
	Construct unary constraint factor. More...

	Constraint (Key j1, Key j2)
	Construct binary constraint factor. More...

template<class KeyIterator >
	Constraint (KeyIterator beginKey, KeyIterator endKey)
	construct from container More...

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

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

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

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::DiscreteFactor
std::map< Key, size_t >	cardinalities_
	Map of Keys and their cardinalities. More...

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

Detailed Description

SingleValue constraint: ensures a variable takes on a certain value. This could of course also be implemented by changing its Domain.

Definition at line 19 of file SingleValue.h.

Member Typedef Documentation

◆ shared_ptr

typedef std::shared_ptr<SingleValue> gtsam::SingleValue::shared_ptr

Definition at line 28 of file SingleValue.h.

Constructor & Destructor Documentation

◆ SingleValue() [1/2]

gtsam::SingleValue::SingleValue	(	Key	key,
		size_t	n,
		size_t	value
	)

inline

Construct from key, cardinality, and given value.

Definition at line 31 of file SingleValue.h.

◆ SingleValue() [2/2]

gtsam::SingleValue::SingleValue	(	const DiscreteKey &	dkey,
		size_t	value
	)

inline

Construct from DiscreteKey and given value.

Definition at line 35 of file SingleValue.h.

Member Function Documentation

◆ discreteKey()

DiscreteKey gtsam::SingleValue::discreteKey ( ) const

inlineprivate

Definition at line 23 of file SingleValue.h.

◆ ensureArcConsistency()

bool gtsam::SingleValue::ensureArcConsistency	(	Key	j,
		Domains *	domains
	)		const

overridevirtual

Implements gtsam::Constraint.

Definition at line 45 of file SingleValue.cpp.

◆ equals()

bool gtsam::SingleValue::equals	(	const DiscreteFactor &	other,
		double	tol
	)		const

inlineoverridevirtual

equals

Reimplemented from gtsam::DiscreteFactor.

Definition at line 43 of file SingleValue.h.

◆ evaluate()

double gtsam::SingleValue::evaluate ( const Assignment< Key > & values ) const

overridevirtual

Calculate value.

Implements gtsam::DiscreteFactor.

Definition at line 25 of file SingleValue.cpp.

◆ operator*()

DecisionTreeFactor gtsam::SingleValue::operator* ( const DecisionTreeFactor & f ) const

overridevirtual

Multiply into a decisiontree.

Reimplemented from gtsam::Constraint.

Definition at line 39 of file SingleValue.cpp.

◆ partiallyApply() [1/2]

Constraint::shared_ptr gtsam::SingleValue::partiallyApply ( const DiscreteValues & values ) const

overridevirtual

Partially apply known values.

Implements gtsam::Constraint.

Definition at line 58 of file SingleValue.cpp.

◆ partiallyApply() [2/2]

Constraint::shared_ptr gtsam::SingleValue::partiallyApply ( const Domains & domains ) const

overridevirtual

Partially apply known values, domain version.

Implements gtsam::Constraint.

Definition at line 66 of file SingleValue.cpp.

◆ print()

void gtsam::SingleValue::print	(	const std::string &	s = `""`,
		const KeyFormatter &	formatter = `DefaultKeyFormatter`
	)		const

overridevirtual

print

Reimplemented from gtsam::DiscreteFactor.

Definition at line 19 of file SingleValue.cpp.

◆ toDecisionTreeFactor()

DecisionTreeFactor gtsam::SingleValue::toDecisionTreeFactor ( ) const

overridevirtual

Convert into a decisiontree.

Implements gtsam::DiscreteFactor.

Definition at line 30 of file SingleValue.cpp.

Member Data Documentation

◆ cardinality_

size_t gtsam::SingleValue::cardinality_

private

Definition at line 20 of file SingleValue.h.

◆ value_

size_t gtsam::SingleValue::value_

private

< Number of values

allowed value

Definition at line 21 of file SingleValue.h.

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

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ shared_ptr

Constructor & Destructor Documentation

◆ SingleValue() [1/2]

◆ SingleValue() [2/2]

Member Function Documentation

◆ discreteKey()

◆ ensureArcConsistency()

◆ equals()

◆ evaluate()

◆ operator*()

◆ partiallyApply() [1/2]

◆ partiallyApply() [2/2]

◆ print()

◆ toDecisionTreeFactor()

Member Data Documentation

◆ cardinality_

◆ value_