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

#include <SingleValue.h>

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

Public Types

typedef boost::shared_ptr< SingleValueshared_ptr
 
- 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 ensureArcConsistency (size_t j, std::vector< Domain > &domains) const override
 
bool equals (const DiscreteFactor &other, double tol) const override
 equals More...
 
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...
 
 SingleValue (Key key, size_t n, size_t value)
 Constructor. More...
 
 SingleValue (const DiscreteKey &dkey, size_t value)
 Constructor. 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...
 
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...
 
KeyVectorkeys ()
 
iterator begin ()
 
iterator end ()
 

Private Member Functions

DiscreteKey discreteKey () const
 

Private Attributes

size_t cardinality_
 Number of values. More...
 
size_t value_
 allowed value 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

SingleValue constraint

Definition at line 18 of file SingleValue.h.

Member Typedef Documentation

typedef boost::shared_ptr<SingleValue> gtsam::SingleValue::shared_ptr

Definition at line 32 of file SingleValue.h.

Constructor & Destructor Documentation

gtsam::SingleValue::SingleValue ( Key  key,
size_t  n,
size_t  value 
)
inline

Constructor.

Definition at line 35 of file SingleValue.h.

gtsam::SingleValue::SingleValue ( const DiscreteKey dkey,
size_t  value 
)
inline

Constructor.

Definition at line 40 of file SingleValue.h.

Member Function Documentation

DiscreteKey gtsam::SingleValue::discreteKey ( ) const
inlineprivate

Definition at line 26 of file SingleValue.h.

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

Implements gtsam::Constraint.

Definition at line 48 of file SingleValue.cpp.

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

equals

Implements gtsam::DiscreteFactor.

Definition at line 49 of file SingleValue.h.

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

Calculate value.

Implements gtsam::DiscreteFactor.

Definition at line 26 of file SingleValue.cpp.

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

Multiply into a decisiontree.

Implements gtsam::DiscreteFactor.

Definition at line 42 of file SingleValue.cpp.

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

Partially apply known values.

Implements gtsam::Constraint.

Definition at line 62 of file SingleValue.cpp.

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

Partially apply known values, domain version.

Implements gtsam::Constraint.

Definition at line 70 of file SingleValue.cpp.

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

print

Reimplemented from gtsam::DiscreteFactor.

Definition at line 19 of file SingleValue.cpp.

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

Convert into a decisiontree.

Implements gtsam::DiscreteFactor.

Definition at line 31 of file SingleValue.cpp.

Member Data Documentation

size_t gtsam::SingleValue::cardinality_
private

Number of values.

Definition at line 21 of file SingleValue.h.

size_t gtsam::SingleValue::value_
private

allowed value

Definition at line 24 of file SingleValue.h.


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


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