Public Types | Protected Member Functions | List of all members
gtsam::Constraint Class Referenceabstract

#include <Constraint.h>

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

Public Types

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

Public Member Functions

Standard Constructors
 Constraint ()
 Default constructor for I/O. More...
 
 ~Constraint () override
 Virtual destructor. More...
 
Standard Interface
virtual bool ensureArcConsistency (size_t j, std::vector< Domain > &domains) const =0
 
virtual shared_ptr partiallyApply (const Values &) const =0
 Partially apply known values. More...
 
virtual shared_ptr partiallyApply (const std::vector< Domain > &) const =0
 Partially apply known values, domain version. More...
 
- Public Member Functions inherited from gtsam::DiscreteFactor
 DiscreteFactor ()
 
template<typename CONTAINER >
 DiscreteFactor (const CONTAINER &keys)
 
virtual ~DiscreteFactor ()
 Virtual destructor. More...
 
virtual bool equals (const DiscreteFactor &lf, double tol=1e-9) const =0
 equals More...
 
void print (const std::string &s="DiscreteFactor\n", const KeyFormatter &formatter=DefaultKeyFormatter) const override
 print More...
 
virtual bool empty () const
 
virtual double operator() (const Values &) const =0
 Find value for given assignment of values to variables. More...
 
virtual DecisionTreeFactor operator* (const DecisionTreeFactor &) const =0
 Multiply in a DecisionTreeFactor and return the result as DecisionTreeFactor. More...
 
virtual DecisionTreeFactor toDecisionTreeFactor () const =0
 
- 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
 

Protected Member Functions

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

Additional Inherited Members

- 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

Base class for discrete probabilistic factors The most general one is the derived DecisionTreeFactor

Definition at line 32 of file Constraint.h.

Member Typedef Documentation

typedef boost::shared_ptr<Constraint> gtsam::Constraint::shared_ptr

Definition at line 36 of file Constraint.h.

Constructor & Destructor Documentation

gtsam::Constraint::Constraint ( const KeyVector js)
inlineprotected

Construct n-way factor.

Definition at line 41 of file Constraint.h.

gtsam::Constraint::Constraint ( Key  j)
inlineprotected

Construct unary factor.

Definition at line 46 of file Constraint.h.

gtsam::Constraint::Constraint ( Key  j1,
Key  j2 
)
inlineprotected

Construct binary factor.

Definition at line 51 of file Constraint.h.

template<class KeyIterator >
gtsam::Constraint::Constraint ( KeyIterator  beginKey,
KeyIterator  endKey 
)
inlineprotected

construct from container

Definition at line 57 of file Constraint.h.

gtsam::Constraint::Constraint ( )

Default constructor for I/O.

gtsam::Constraint::~Constraint ( )
inlineoverride

Virtual destructor.

Definition at line 70 of file Constraint.h.

Member Function Documentation

virtual bool gtsam::Constraint::ensureArcConsistency ( size_t  j,
std::vector< Domain > &  domains 
) const
pure virtual
virtual shared_ptr gtsam::Constraint::partiallyApply ( const Values ) const
pure virtual

Partially apply known values.

Implemented in gtsam::Domain, gtsam::BinaryAllDiff, gtsam::SingleValue, and gtsam::AllDiff.

virtual shared_ptr gtsam::Constraint::partiallyApply ( const std::vector< Domain > &  ) const
pure virtual

Partially apply known values, domain version.

Implemented in gtsam::Domain, gtsam::BinaryAllDiff, gtsam::SingleValue, and gtsam::AllDiff.


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


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