Public Member Functions | Private Attributes | List of all members
gtsam::BinaryAllDiff Class Reference

#include <BinaryAllDiff.h>

Inheritance diagram for gtsam::BinaryAllDiff:
Inheritance graph
[legend]

Public Member Functions

 BinaryAllDiff (const DiscreteKey &key1, const DiscreteKey &key2)
 cardinality More...
 
bool ensureArcConsistency (size_t j, std::vector< Domain > &domains) const override
 
bool equals (const DiscreteFactor &other, double tol) const override
 equals More...
 
double operator() (const Values &values) const override
 Calculate value. More...
 
DecisionTreeFactor operator* (const DecisionTreeFactor &f) const override
 Multiply into a decisiontree. More...
 
Constraint::shared_ptr partiallyApply (const Values &) const override
 Partially apply known values. More...
 
Constraint::shared_ptr partiallyApply (const std::vector< Domain > &) 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...
 
- Public Member Functions inherited from gtsam::DiscreteFactor
 DiscreteFactor ()
 
template<typename CONTAINER >
 DiscreteFactor (const CONTAINER &keys)
 
virtual ~DiscreteFactor ()
 Virtual destructor. More...
 
virtual bool empty () const
 
- Public Member Functions inherited from gtsam::Factor
virtual ~Factor ()=default
 Default destructor. More...
 
KeyVectorkeys ()
 
iterator begin ()
 
iterator end ()
 
virtual void printKeys (const std::string &s="Factor", const KeyFormatter &formatter=DefaultKeyFormatter) const
 print only keys More...
 
Key front () const
 First key. More...
 
Key back () const
 Last key. More...
 
const_iterator find (Key key) const
 find More...
 
const KeyVectorkeys () const
 Access the factor's involved variable keys. More...
 
const_iterator begin () const
 
const_iterator end () const
 
size_t size () const
 

Private Attributes

size_t cardinality0_
 
size_t cardinality1_
 

Additional Inherited Members

- Public Types inherited from gtsam::Constraint
typedef boost::shared_ptr< Constraintshared_ptr
 
- Public Types inherited from gtsam::DiscreteFactor
typedef Factor Base
 Our base class. More...
 
typedef boost::shared_ptr< DiscreteFactorshared_ptr
 shared_ptr to this class More...
 
typedef boost::shared_ptr< ValuessharedValues
 
typedef DiscreteFactor This
 This class. More...
 
typedef Assignment< KeyValues
 
- 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 factor. More...
 
 Constraint (Key j)
 Construct unary factor. More...
 
 Constraint (Key j1, Key j2)
 Construct binary 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)
 
bool equals (const This &other, double tol=1e-9) const
 check equality More...
 
- 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...
 

Detailed Description

Binary AllDiff constraint Returns 1 if values for two keys are different, 0 otherwise DiscreteFactors are all awkward in that they have to store two types of keys: for each variable we have a Index and an Index. In this factor, we keep the Indices locally, and the Indices are stored in IndexFactor.

Definition at line 23 of file BinaryAllDiff.h.

Constructor & Destructor Documentation

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

cardinality

Constructor

Definition at line 30 of file BinaryAllDiff.h.

Member Function Documentation

bool gtsam::BinaryAllDiff::ensureArcConsistency ( size_t  j,
std::vector< Domain > &  domains 
) const
inlineoverridevirtual

Implements gtsam::Constraint.

Definition at line 82 of file BinaryAllDiff.h.

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

equals

Implements gtsam::DiscreteFactor.

Definition at line 43 of file BinaryAllDiff.h.

double gtsam::BinaryAllDiff::operator() ( const Values values) const
inlineoverridevirtual

Calculate value.

Implements gtsam::DiscreteFactor.

Definition at line 53 of file BinaryAllDiff.h.

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

Multiply into a decisiontree.

Implements gtsam::DiscreteFactor.

Definition at line 71 of file BinaryAllDiff.h.

Constraint::shared_ptr gtsam::BinaryAllDiff::partiallyApply ( const Values ) const
inlineoverridevirtual

Partially apply known values.

Implements gtsam::Constraint.

Definition at line 89 of file BinaryAllDiff.h.

Constraint::shared_ptr gtsam::BinaryAllDiff::partiallyApply ( const std::vector< Domain > &  ) const
inlineoverridevirtual

Partially apply known values, domain version.

Implements gtsam::Constraint.

Definition at line 94 of file BinaryAllDiff.h.

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

print

Reimplemented from gtsam::DiscreteFactor.

Definition at line 36 of file BinaryAllDiff.h.

DecisionTreeFactor gtsam::BinaryAllDiff::toDecisionTreeFactor ( ) const
inlineoverridevirtual

Convert into a decisiontree.

Implements gtsam::DiscreteFactor.

Definition at line 58 of file BinaryAllDiff.h.

Member Data Documentation

size_t gtsam::BinaryAllDiff::cardinality0_
private

Definition at line 25 of file BinaryAllDiff.h.

size_t gtsam::BinaryAllDiff::cardinality1_
private

Definition at line 25 of file BinaryAllDiff.h.


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


gtsam
Author(s):
autogenerated on Sat May 8 2021 02:58:04