gtsam 4.2
gtsam
Loading...
Searching...
No Matches
gtsam::AllDiff Class Reference

Detailed Description

General AllDiff constraint.

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

Inheritance diagram for gtsam::AllDiff:

Public Member Functions

 AllDiff (const DiscreteKeys &dkeys)
 Construct from keys.
void print (const std::string &s="", const KeyFormatter &formatter=DefaultKeyFormatter) const override
 print
bool equals (const DiscreteFactor &other, double tol) const override
 equals
double operator() (const DiscreteValues &values) const override
 Calculate value = expensive !
DecisionTreeFactor toDecisionTreeFactor () const override
 Convert into a decisiontree, can be very expensive !
DecisionTreeFactor operator* (const DecisionTreeFactor &f) const override
 Multiply into a decisiontree.
bool ensureArcConsistency (Key j, Domains *domains) const override
Constraint::shared_ptr partiallyApply (const DiscreteValues &) const override
 Partially apply known values.
Constraint::shared_ptr partiallyApply (const Domains &) const override
 Partially apply known values, domain version.
Public Member Functions inherited from gtsam::Constraint
 Constraint ()
 Default constructor for I/O.
 ~Constraint () override
 Virtual destructor.
std::string markdown (const KeyFormatter &keyFormatter=DefaultKeyFormatter, const Names &names={}) const override
 Render as markdown table.
std::string html (const KeyFormatter &keyFormatter=DefaultKeyFormatter, const Names &names={}) const override
 Render as html table.
Public Member Functions inherited from gtsam::DiscreteFactor
 DiscreteFactor ()
 Default constructor creates empty factor.
template<typename CONTAINER>
 DiscreteFactor (const CONTAINER &keys)
 Construct from container of keys.
virtual ~DiscreteFactor ()
 Virtual destructor.
void print (const std::string &s="DiscreteFactor\n", const KeyFormatter &formatter=DefaultKeyFormatter) const override
 print
double error (const DiscreteValues &values) const
 Error is just -log(value).
double error (const HybridValues &c) const override
 All factor types need to implement an error function.
Public Member Functions inherited from gtsam::Factor
virtual ~Factor ()=default
 Default destructor.
bool empty () const
 Whether the factor is empty (involves zero variables).
Key front () const
 First key.
Key back () const
 Last key.
const_iterator find (Key key) const
 find
const KeyVectorkeys () const
 Access the factor's involved variable keys.
const_iterator begin () const
 Iterator at beginning of involved variable keys.
const_iterator end () const
 Iterator at end of involved variable keys.
size_t size () const
virtual void printKeys (const std::string &s="Factor", const KeyFormatter &formatter=DefaultKeyFormatter) const
 print only keys
bool equals (const This &other, double tol=1e-9) const
 check equality
KeyVectorkeys ()
iterator begin ()
 Iterator at beginning of involved variable keys.
iterator end ()
 Iterator at end of involved variable keys.

Additional Inherited Members

Public Types inherited from gtsam::Constraint
typedef boost::shared_ptr< Constraintshared_ptr
Public Types inherited from gtsam::DiscreteFactor
typedef DiscreteFactor This
 This class.
typedef boost::shared_ptr< DiscreteFactorshared_ptr
 shared_ptr to this class
typedef Factor Base
 Our base class.
using Values = DiscreteValues
 backwards compatibility
using Names = DiscreteValues::Names
 Translation table from values to strings.
Public Types inherited from gtsam::Factor
typedef KeyVector::iterator iterator
 Iterator over keys.
typedef KeyVector::const_iterator const_iterator
 Const iterator over keys.
Protected Member Functions inherited from gtsam::Constraint
 Constraint (Key j)
 Construct unary constraint factor.
 Constraint (Key j1, Key j2)
 Construct binary constraint factor.
 Constraint (const KeyVector &js)
 Construct n-way constraint factor.
template<class KeyIterator>
 Constraint (KeyIterator beginKey, KeyIterator endKey)
 construct from container
 Factor ()
 Default constructor for I/O.
template<typename CONTAINER>
 Factor (const CONTAINER &keys)
 Construct factor from container of keys.
template<typename ITERATOR>
 Factor (ITERATOR first, ITERATOR last)
 Construct factor from iterator keys.
template<typename CONTAINER>
static Factor FromKeys (const CONTAINER &keys)
 Construct factor from container of keys.
template<typename ITERATOR>
static Factor FromIterators (ITERATOR first, ITERATOR last)
 Construct factor from iterator keys.
Protected Attributes inherited from gtsam::Factor
KeyVector keys_
 The keys involved in this factor.

Member Function Documentation

◆ ensureArcConsistency()

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

Implements gtsam::Constraint.

◆ equals()

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

equals

Implements gtsam::DiscreteFactor.

◆ operator()()

double gtsam::AllDiff::operator() ( const DiscreteValues & values) const
overridevirtual

Calculate value = expensive !

Implements gtsam::DiscreteFactor.

◆ operator*()

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

Multiply into a decisiontree.

Implements gtsam::DiscreteFactor.

◆ partiallyApply() [1/2]

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

Partially apply known values.

Implements gtsam::Constraint.

◆ partiallyApply() [2/2]

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

Partially apply known values, domain version.

Implements gtsam::Constraint.

◆ print()

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

print

Reimplemented from gtsam::Factor.

◆ toDecisionTreeFactor()

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

Convert into a decisiontree, can be very expensive !

Implements gtsam::DiscreteFactor.


The documentation for this class was generated from the following files:
  • /tmp/gtsam-4.2-docs.H5EUbA/src/gtsam_unstable/discrete/AllDiff.h
  • /tmp/gtsam-4.2-docs.H5EUbA/src/gtsam_unstable/discrete/AllDiff.cpp