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 std::shared_ptr< SingleValueshared_ptr
 
- Public Types inherited from gtsam::Constraint
typedef std::shared_ptr< Constraintshared_ptr
 
- Public Types inherited from gtsam::DiscreteFactor
typedef Factor Base
 Our base class. More...
 
typedef std::shared_ptr< DiscreteFactorshared_ptr
 shared_ptr to this class More...
 
typedef DiscreteFactor This
 This class. More...
 
using Values = DiscreteValues
 backwards compatibility More...
 
using Names = DiscreteValues::Names
 Translation table from values to strings. More...
 
- 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 (Key j, Domains *domains) const override
 
bool equals (const DiscreteFactor &other, double tol) const override
 equals More...
 
double operator() (const DiscreteValues &values) const override
 Calculate value. More...
 
DecisionTreeFactor operator* (const DecisionTreeFactor &f) const override
 Multiply into a decisiontree. More...
 
Constraint::shared_ptr partiallyApply (const DiscreteValues &values) const override
 Partially apply known values. More...
 
Constraint::shared_ptr partiallyApply (const Domains &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)
 Construct from key, cardinality, and given value. More...
 
 SingleValue (const DiscreteKey &dkey, size_t value)
 Construct from DiscreteKey and given value. 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...
 
std::string markdown (const KeyFormatter &keyFormatter=DefaultKeyFormatter, const Names &names={}) const override
 Render as markdown table. More...
 
std::string html (const KeyFormatter &keyFormatter=DefaultKeyFormatter, const Names &names={}) const override
 Render as html table. More...
 
- Public Member Functions inherited from gtsam::DiscreteFactor
 DiscreteFactor ()
 
template<typename CONTAINER >
 DiscreteFactor (const CONTAINER &keys)
 
double error (const DiscreteValues &values) const
 Error is just -log(value) More...
 
double error (const HybridValues &c) const override
 
- Public Member Functions inherited from gtsam::Factor
virtual ~Factor ()=default
 Default destructor. More...
 
bool empty () const
 Whether the factor is empty (involves zero variables). 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...
 
bool equals (const This &other, double tol=1e-9) const
 check equality More...
 
KeyVectorkeys ()
 
iterator begin ()
 
iterator end ()
 

Private Member Functions

DiscreteKey discreteKey () const
 

Private Attributes

size_t cardinality_
 
size_t value_
 < Number of values More...
 

Additional Inherited Members

- Protected Member Functions inherited from gtsam::Constraint
 Constraint (Key j)
 Construct unary constraint factor. More...
 
 Constraint (Key j1, Key j2)
 Construct binary constraint factor. More...
 
 Constraint (const KeyVector &js)
 Construct n-way constraint 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)
 
- 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: ensures a variable takes on a certain value. This could of course also be implemented by changing its Domain.

Definition at line 19 of file SingleValue.h.

Member Typedef Documentation

◆ shared_ptr

typedef std::shared_ptr<SingleValue> gtsam::SingleValue::shared_ptr

Definition at line 28 of file SingleValue.h.

Constructor & Destructor Documentation

◆ SingleValue() [1/2]

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

Construct from key, cardinality, and given value.

Definition at line 31 of file SingleValue.h.

◆ SingleValue() [2/2]

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

Construct from DiscreteKey and given value.

Definition at line 35 of file SingleValue.h.

Member Function Documentation

◆ discreteKey()

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

Definition at line 23 of file SingleValue.h.

◆ ensureArcConsistency()

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

Implements gtsam::Constraint.

Definition at line 45 of file SingleValue.cpp.

◆ equals()

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

equals

Implements gtsam::DiscreteFactor.

Definition at line 43 of file SingleValue.h.

◆ operator()()

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

Calculate value.

Implements gtsam::DiscreteFactor.

Definition at line 25 of file SingleValue.cpp.

◆ operator*()

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

Multiply into a decisiontree.

Implements gtsam::DiscreteFactor.

Definition at line 39 of file SingleValue.cpp.

◆ partiallyApply() [1/2]

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

Partially apply known values.

Implements gtsam::Constraint.

Definition at line 58 of file SingleValue.cpp.

◆ partiallyApply() [2/2]

Constraint::shared_ptr gtsam::SingleValue::partiallyApply ( const Domains domains) const
overridevirtual

Partially apply known values, domain version.

Implements gtsam::Constraint.

Definition at line 66 of file SingleValue.cpp.

◆ print()

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.

◆ toDecisionTreeFactor()

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

Convert into a decisiontree.

Implements gtsam::DiscreteFactor.

Definition at line 30 of file SingleValue.cpp.

Member Data Documentation

◆ cardinality_

size_t gtsam::SingleValue::cardinality_
private

Definition at line 20 of file SingleValue.h.

◆ value_

size_t gtsam::SingleValue::value_
private

< Number of values

allowed value

Definition at line 21 of file SingleValue.h.


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


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:47:09