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

#include <AllDiff.h>

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

Public Member Functions

 AllDiff (const DiscreteKeys &dkeys)
 Construct from keys. More...
 
bool ensureArcConsistency (Key j, Domains *domains) const override
 
bool equals (const DiscreteFactor &other, double tol) const override
 equals More...
 
AlgebraicDecisionTree< KeyerrorTree () const override
 Compute error for each assignment and return as a tree. More...
 
double evaluate (const Assignment< Key > &values) const override
 Calculate value = expensive ! 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, can be very expensive ! 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_tcardinalities () 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
 
- 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 KeyVectorkeys () 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...
 
KeyVectorkeys ()
 
iterator begin ()
 
iterator end ()
 

Private Member Functions

DiscreteKey discreteKey (size_t i) const
 

Private Attributes

std::map< Key, size_tcardinalities_
 

Additional Inherited Members

- Public Types inherited from gtsam::Constraint
typedef std::shared_ptr< Constraintshared_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< DiscreteFactorshared_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...
 
- 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_tcardinalities_
 Map of Keys and their cardinalities. More...
 
- Protected Attributes inherited from gtsam::Factor
KeyVector keys_
 The keys involved in this factor. More...
 

Detailed Description

General AllDiff constraint. Returns 1 if values for all keys are different, 0 otherwise.

Definition at line 19 of file AllDiff.h.

Constructor & Destructor Documentation

◆ AllDiff()

gtsam::AllDiff::AllDiff ( const DiscreteKeys dkeys)

Construct from keys.

Definition at line 17 of file AllDiff.cpp.

Member Function Documentation

◆ discreteKey()

DiscreteKey gtsam::AllDiff::discreteKey ( size_t  i) const
inlineprivate

Definition at line 22 of file AllDiff.h.

◆ ensureArcConsistency()

bool gtsam::AllDiff::ensureArcConsistency ( Key  j,
Domains domains 
) const
overridevirtual

Implements gtsam::Constraint.

Definition at line 60 of file AllDiff.cpp.

◆ equals()

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

equals

Reimplemented from gtsam::DiscreteFactor.

Definition at line 36 of file AllDiff.h.

◆ errorTree()

AlgebraicDecisionTree<Key> gtsam::AllDiff::errorTree ( ) const
inlineoverridevirtual

Compute error for each assignment and return as a tree.

Reimplemented from gtsam::DiscreteFactor.

Definition at line 57 of file AllDiff.h.

◆ evaluate()

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

Calculate value = expensive !

Implements gtsam::DiscreteFactor.

Definition at line 29 of file AllDiff.cpp.

◆ operator*()

DecisionTreeFactor gtsam::AllDiff::operator* ( const DecisionTreeFactor f) const
overridevirtual

Multiply into a decisiontree.

Implements gtsam::DiscreteFactor.

Definition at line 54 of file AllDiff.cpp.

◆ partiallyApply() [1/2]

Constraint::shared_ptr gtsam::AllDiff::partiallyApply ( const DiscreteValues values) const
overridevirtual

Partially apply known values.

Implements gtsam::Constraint.

Definition at line 91 of file AllDiff.cpp.

◆ partiallyApply() [2/2]

Constraint::shared_ptr gtsam::AllDiff::partiallyApply ( const Domains domains) const
overridevirtual

Partially apply known values, domain version.

Implements gtsam::Constraint.

Definition at line 102 of file AllDiff.cpp.

◆ print()

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

print

Reimplemented from gtsam::DiscreteFactor.

Definition at line 22 of file AllDiff.cpp.

◆ toDecisionTreeFactor()

DecisionTreeFactor gtsam::AllDiff::toDecisionTreeFactor ( ) const
overridevirtual

Convert into a decisiontree, can be very expensive !

Implements gtsam::DiscreteFactor.

Definition at line 40 of file AllDiff.cpp.

Member Data Documentation

◆ cardinalities_

std::map<Key, size_t> gtsam::AllDiff::cardinalities_
private

Definition at line 20 of file AllDiff.h.


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


gtsam
Author(s):
autogenerated on Sun Dec 22 2024 04:23:31