#include <BinaryAllDiff.h>

Inheritance diagram for gtsam::BinaryAllDiff:

[legend]

Public Member Functions
	BinaryAllDiff (const DiscreteKey &key1, const DiscreteKey &key2)
	cardinality More...

bool	ensureArcConsistency (Key j, Domains *domains) const override

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

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

double	operator() (const DiscreteValues &values) const override
	Calculate value. More...

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

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

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

void	print (const std::string &s="", const KeyFormatter &formatter=DefaultKeyFormatter) const override
	print 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...

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

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

double	error (const HybridValues &c) const override

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 Attributes
size_t	cardinality0_

size_t	cardinality1_

Additional Inherited Members
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...

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

typedef DiscreteFactor	This
	This class. More...

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...

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

Binary AllDiff constraint Returns 1 if values for two keys are different, 0 otherwise.

Definition at line 20 of file BinaryAllDiff.h.

Constructor & Destructor Documentation

◆ BinaryAllDiff()

gtsam::BinaryAllDiff::BinaryAllDiff	(	const DiscreteKey &	key1,
		const DiscreteKey &	key2
	)

inline

cardinality

Constructor

Definition at line 25 of file BinaryAllDiff.h.

Member Function Documentation

◆ ensureArcConsistency()

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

inlineoverridevirtual

Implements gtsam::Constraint.

Definition at line 78 of file BinaryAllDiff.h.

◆ equals()

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

inlineoverridevirtual

equals

Implements gtsam::DiscreteFactor.

Definition at line 39 of file BinaryAllDiff.h.

◆ errorTree()

AlgebraicDecisionTree<Key> gtsam::BinaryAllDiff::errorTree ( ) const

inlineoverridevirtual

Compute error for each assignment and return as a tree.

Reimplemented from gtsam::DiscreteFactor.

Definition at line 96 of file BinaryAllDiff.h.

◆ operator()()

double gtsam::BinaryAllDiff::operator() ( const DiscreteValues & values ) const

inlineoverridevirtual

Calculate value.

Implements gtsam::DiscreteFactor.

Definition at line 50 of file BinaryAllDiff.h.

◆ operator*()

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

inlineoverridevirtual

Multiply into a decisiontree.

Implements gtsam::DiscreteFactor.

Definition at line 67 of file BinaryAllDiff.h.

◆ partiallyApply() [1/2]

Constraint::shared_ptr gtsam::BinaryAllDiff::partiallyApply ( const DiscreteValues & ) const

inlineoverridevirtual

Partially apply known values.

Implements gtsam::Constraint.

Definition at line 85 of file BinaryAllDiff.h.

◆ partiallyApply() [2/2]

Constraint::shared_ptr gtsam::BinaryAllDiff::partiallyApply ( const Domains & ) const

inlineoverridevirtual

Partially apply known values, domain version.

Implements gtsam::Constraint.

Definition at line 90 of file BinaryAllDiff.h.

◆ print()

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

inlineoverridevirtual

print

Reimplemented from gtsam::DiscreteFactor.

Definition at line 31 of file BinaryAllDiff.h.

◆ toDecisionTreeFactor()

DecisionTreeFactor gtsam::BinaryAllDiff::toDecisionTreeFactor ( ) const

inlineoverridevirtual

Convert into a decisiontree.

Implements gtsam::DiscreteFactor.

Definition at line 55 of file BinaryAllDiff.h.

Member Data Documentation

◆ cardinality0_

size_t gtsam::BinaryAllDiff::cardinality0_

private

Definition at line 21 of file BinaryAllDiff.h.

◆ cardinality1_

size_t gtsam::BinaryAllDiff::cardinality1_

private

Definition at line 21 of file BinaryAllDiff.h.

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

BinaryAllDiff.h

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BinaryAllDiff()

Member Function Documentation

◆ ensureArcConsistency()

◆ equals()

◆ errorTree()

◆ operator()()

◆ operator*()

◆ partiallyApply() [1/2]

◆ partiallyApply() [2/2]

◆ print()

◆ toDecisionTreeFactor()

Member Data Documentation

◆ cardinality0_

◆ cardinality1_