Loading...
Searching...
No Matches
gtsam::Constraint Class Referenceabstract
Detailed Description
Base class for constraint factors Derived classes include SingleValue, BinaryAllDiff, and AllDiff.
Inheritance diagram for gtsam::Constraint:
Public Member Functions | |
Standard Constructors | |
| Constraint () | |
| Default constructor for I/O. | |
| ~Constraint () override | |
| Virtual destructor. | |
Standard Interface | |
| virtual bool | ensureArcConsistency (Key j, Domains *domains) const =0 |
| virtual shared_ptr | partiallyApply (const DiscreteValues &) const =0 |
| Partially apply known values. | |
| virtual shared_ptr | partiallyApply (const Domains &) const =0 |
| Partially apply known values, domain version. | |
Wrapper support | |
| 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. | |
| virtual bool | equals (const DiscreteFactor &lf, double tol=1e-9) const =0 |
| equals | |
| void | print (const std::string &s="DiscreteFactor\n", const KeyFormatter &formatter=DefaultKeyFormatter) const override |
| print | |
| virtual double | operator() (const DiscreteValues &) const =0 |
| Find value for given assignment of values to variables. | |
| 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. | |
| virtual DecisionTreeFactor | operator* (const DecisionTreeFactor &) const =0 |
| Multiply in a DecisionTreeFactor and return the result as DecisionTreeFactor. | |
| virtual DecisionTreeFactor | toDecisionTreeFactor () const =0 |
| 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 KeyVector & | keys () 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 | |
| KeyVector & | keys () |
| iterator | begin () |
| Iterator at beginning of involved variable keys. | |
| iterator | end () |
| Iterator at end of involved variable keys. | |
Public Types | |
| typedef boost::shared_ptr< Constraint > | shared_ptr |
| Public Types inherited from gtsam::DiscreteFactor | |
| typedef DiscreteFactor | This |
| This class. | |
| typedef boost::shared_ptr< DiscreteFactor > | shared_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 | |
| 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. | |
Additional Inherited Members | |
| 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
◆ html()
|
inlineoverridevirtual |
Render as html table.
Implements gtsam::DiscreteFactor.
◆ markdown()
|
inlineoverridevirtual |
Render as markdown table.
Implements gtsam::DiscreteFactor.
◆ partiallyApply() [1/2]
|
pure virtual |
Partially apply known values.
Implemented in gtsam::AllDiff, gtsam::BinaryAllDiff, gtsam::Domain, and gtsam::SingleValue.
◆ partiallyApply() [2/2]
|
pure virtual |
Partially apply known values, domain version.
Implemented in gtsam::AllDiff, gtsam::BinaryAllDiff, gtsam::Domain, and gtsam::SingleValue.
The documentation for this class was generated from the following file:
- /tmp/gtsam-4.2-docs.H5EUbA/src/gtsam_unstable/discrete/Constraint.h
