Public Types | List of all members
gtsam::DiscreteFactor Class Referenceabstract

#include <DiscreteFactor.h>

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

Public Types

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
 DiscreteFactor ()
 
template<typename CONTAINER >
 DiscreteFactor (const CONTAINER &keys)
 
virtual ~DiscreteFactor ()
 Virtual destructor. More...
 
Testable
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
 
Standard Interface
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
 

Additional Inherited Members

- 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

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

Definition at line 34 of file DiscreteFactor.h.

Member Typedef Documentation

Our base class.

Definition at line 41 of file DiscreteFactor.h.

shared_ptr to this class

Definition at line 40 of file DiscreteFactor.h.

typedef boost::shared_ptr<Values> gtsam::DiscreteFactor::sharedValues

Definition at line 54 of file DiscreteFactor.h.

This class.

Definition at line 39 of file DiscreteFactor.h.

A map from keys to values TODO: Do we need this? Should we just use gtsam::Values? We just need another special DiscreteValue to represent labels, However, all other Lie's operators are undefined in this class. The good thing is we can have a Hybrid graph of discrete/continuous variables together.. Another good thing is we don't need to have the special DiscreteKey which stores cardinality of a Discrete variable. It should be handled naturally in the new class DiscreteValue, as the varible's type (domain)

Definition at line 53 of file DiscreteFactor.h.

Constructor & Destructor Documentation

gtsam::DiscreteFactor::DiscreteFactor ( )
inline

Default constructor creates empty factor

Definition at line 62 of file DiscreteFactor.h.

template<typename CONTAINER >
gtsam::DiscreteFactor::DiscreteFactor ( const CONTAINER &  keys)
inline

Construct from container of keys. This constructor is used internally from derived factor constructors, either from a container of keys or from a boost::assign::list_of.

Definition at line 67 of file DiscreteFactor.h.

virtual gtsam::DiscreteFactor::~DiscreteFactor ( )
inlinevirtual

Virtual destructor.

Definition at line 70 of file DiscreteFactor.h.

Member Function Documentation

virtual bool gtsam::DiscreteFactor::empty ( ) const
inlinevirtual

Test whether the factor is empty

Definition at line 88 of file DiscreteFactor.h.

virtual bool gtsam::DiscreteFactor::equals ( const DiscreteFactor lf,
double  tol = 1e-9 
) const
pure virtual
virtual double gtsam::DiscreteFactor::operator() ( const Values ) const
pure virtual

Find value for given assignment of values to variables.

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

virtual DecisionTreeFactor gtsam::DiscreteFactor::operator* ( const DecisionTreeFactor ) const
pure virtual
void gtsam::DiscreteFactor::print ( const std::string &  s = "DiscreteFactor\n",
const KeyFormatter formatter = DefaultKeyFormatter 
) const
inlineoverridevirtual

print

Reimplemented from gtsam::Factor.

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

Definition at line 81 of file DiscreteFactor.h.

virtual DecisionTreeFactor gtsam::DiscreteFactor::toDecisionTreeFactor ( ) const
pure virtual

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


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