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 std::shared_ptr< DiscreteFactorshared_ptr
 shared_ptr to this class More...
 
typedef DiscreteFactor This
 This class. More...
 
using Values = DiscreteValues
 backwards compatibility 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

Standard Constructors
 DiscreteFactor ()
 
template<typename CONTAINER >
 DiscreteFactor (const CONTAINER &keys)
 
Testable
virtual bool equals (const DiscreteFactor &lf, double tol=1e-9) const =0
 equals More...
 
void print (const std::string &s="DiscreteFactor\, const KeyFormatter &formatter=DefaultKeyFormatter) const override
 print More...
 
Standard Interface
virtual double operator() (const DiscreteValues &) const =0
 Find value for given assignment of values to variables. More...
 
double error (const DiscreteValues &values) const
 Error is just -log(value) More...
 
double error (const HybridValues &c) const override
 
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...
 
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 ()
 

Wrapper support

using Names = DiscreteValues::Names
 Translation table from values to strings. More...
 
virtual std::string markdown (const KeyFormatter &keyFormatter=DefaultKeyFormatter, const Names &names={}) const =0
 Render as markdown table. More...
 
virtual std::string html (const KeyFormatter &keyFormatter=DefaultKeyFormatter, const Names &names={}) const =0
 Render as html table. More...
 

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

DecisionTreeFactor, which represent a discrete distribution over a set of variables.

Definition at line 38 of file DiscreteFactor.h.

Member Typedef Documentation

◆ Base

Our base class.

Definition at line 45 of file DiscreteFactor.h.

◆ Names

Translation table from values to strings.

Definition at line 102 of file DiscreteFactor.h.

◆ shared_ptr

shared_ptr to this class

Definition at line 44 of file DiscreteFactor.h.

◆ This

This class.

Definition at line 43 of file DiscreteFactor.h.

◆ Values

backwards compatibility

Definition at line 47 of file DiscreteFactor.h.

Constructor & Destructor Documentation

◆ DiscreteFactor() [1/2]

gtsam::DiscreteFactor::DiscreteFactor ( )
inline

Default constructor creates empty factor

Definition at line 55 of file DiscreteFactor.h.

◆ DiscreteFactor() [2/2]

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 60 of file DiscreteFactor.h.

Member Function Documentation

◆ equals()

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

◆ error() [1/2]

double DiscreteFactor::error ( const DiscreteValues values) const

Error is just -log(value)

Definition at line 32 of file DiscreteFactor.cpp.

◆ error() [2/2]

double DiscreteFactor::error ( const HybridValues c) const
overridevirtual

All factor types need to implement an error function. In factor graphs, this is the negative log-likelihood.

Reimplemented from gtsam::Factor.

Reimplemented in gtsam::TableFactor.

Definition at line 37 of file DiscreteFactor.cpp.

◆ html()

virtual std::string gtsam::DiscreteFactor::html ( const KeyFormatter keyFormatter = DefaultKeyFormatter,
const Names names = {} 
) const
pure virtual

Render as html table.

Parameters
keyFormatterGTSAM-style Key formatter.
namesoptional, category names corresponding to choices.
Returns
std::string a html string.

Implemented in gtsam::TableFactor, gtsam::DecisionTreeFactor, gtsam::DiscreteConditional, and gtsam::Constraint.

◆ markdown()

virtual std::string gtsam::DiscreteFactor::markdown ( const KeyFormatter keyFormatter = DefaultKeyFormatter,
const Names names = {} 
) const
pure virtual

Render as markdown table.

Parameters
keyFormatterGTSAM-style Key formatter.
namesoptional, category names corresponding to choices.
Returns
std::string a markdown string.

Implemented in gtsam::TableFactor, gtsam::DecisionTreeFactor, gtsam::DiscreteConditional, and gtsam::Constraint.

◆ operator()()

virtual double gtsam::DiscreteFactor::operator() ( const DiscreteValues ) const
pure virtual

Find value for given assignment of values to variables.

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

◆ operator*()

virtual DecisionTreeFactor gtsam::DiscreteFactor::operator* ( const DecisionTreeFactor ) const
pure virtual

◆ print()

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

◆ toDecisionTreeFactor()

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

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


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:46:17