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

#include <Domain.h>

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

Public Types

typedef boost::shared_ptr< Domainshared_ptr
 allowed values More...
 
- 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...
 

Public Member Functions

bool checkAllDiff (const KeyVector keys, std::vector< Domain > &domains)
 
bool contains (size_t value) const
 
 Domain (const DiscreteKey &dkey)
 
 Domain (const DiscreteKey &dkey, size_t v)
 
 Domain (const Domain &other)
 Constructor. More...
 
bool ensureArcConsistency (size_t j, std::vector< Domain > &domains) const override
 
bool equals (const DiscreteFactor &other, double tol) const override
 equals More...
 
void erase (size_t value)
 erase a value, non const :-( More...
 
size_t firstValue () const
 
void insert (size_t value)
 insert a value, non const :-( More...
 
bool isSingleton () const
 
size_t nrValues () const
 
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 &values) const override
 Partially apply known values. More...
 
Constraint::shared_ptr partiallyApply (const std::vector< Domain > &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. 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 cardinality_
 
std::set< size_tvalues_
 Cardinality. More...
 

Additional Inherited Members

- 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

Domain restriction constraint

Definition at line 18 of file Domain.h.

Member Typedef Documentation

typedef boost::shared_ptr<Domain> gtsam::Domain::shared_ptr

allowed values

Definition at line 25 of file Domain.h.

Constructor & Destructor Documentation

gtsam::Domain::Domain ( const DiscreteKey dkey)
inline

Definition at line 28 of file Domain.h.

gtsam::Domain::Domain ( const DiscreteKey dkey,
size_t  v 
)
inline

Definition at line 36 of file Domain.h.

gtsam::Domain::Domain ( const Domain other)
inline

Constructor.

Definition at line 42 of file Domain.h.

Member Function Documentation

bool gtsam::Domain::checkAllDiff ( const KeyVector  keys,
std::vector< Domain > &  domains 
)

Check for a value in domain that does not occur in any other connected domain. If found, we make this a singleton... Called in AllDiff::ensureArcConsistency

Parameters
keysconnected domains through alldiff

Definition at line 60 of file Domain.cpp.

bool gtsam::Domain::contains ( size_t  value) const
inline

Definition at line 82 of file Domain.h.

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

Implements gtsam::Constraint.

Definition at line 50 of file Domain.cpp.

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

equals

Implements gtsam::DiscreteFactor.

Definition at line 73 of file Domain.h.

void gtsam::Domain::erase ( size_t  value)
inline

erase a value, non const :-(

Definition at line 52 of file Domain.h.

size_t gtsam::Domain::firstValue ( ) const
inline

Definition at line 64 of file Domain.h.

void gtsam::Domain::insert ( size_t  value)
inline

insert a value, non const :-(

Definition at line 47 of file Domain.h.

bool gtsam::Domain::isSingleton ( ) const
inline

Definition at line 60 of file Domain.h.

size_t gtsam::Domain::nrValues ( ) const
inline

Definition at line 56 of file Domain.h.

double gtsam::Domain::operator() ( const Values values) const
overridevirtual

Calculate value.

Implements gtsam::DiscreteFactor.

Definition at line 28 of file Domain.cpp.

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

Multiply into a decisiontree.

Implements gtsam::DiscreteFactor.

Definition at line 44 of file Domain.cpp.

Constraint::shared_ptr gtsam::Domain::partiallyApply ( const Values values) const
overridevirtual

Partially apply known values.

Implements gtsam::Constraint.

Definition at line 78 of file Domain.cpp.

Constraint::shared_ptr gtsam::Domain::partiallyApply ( const std::vector< Domain > &  domains) const
overridevirtual

Partially apply known values, domain version.

Implements gtsam::Constraint.

Definition at line 87 of file Domain.cpp.

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

print

Reimplemented from gtsam::DiscreteFactor.

Definition at line 18 of file Domain.cpp.

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

Convert into a decisiontree.

Implements gtsam::DiscreteFactor.

Definition at line 33 of file Domain.cpp.

Member Data Documentation

size_t gtsam::Domain::cardinality_
private

Definition at line 20 of file Domain.h.

std::set<size_t> gtsam::Domain::values_
private

Cardinality.

Definition at line 21 of file Domain.h.


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


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