gtsam 4.2.0
gtsam
|
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.
Wrapper support | |
using | Names = DiscreteValues::Names |
Translation table from values to strings. | |
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... | |
Public Member Functions | |
Standard Constructors | |
DiscreteFactor () | |
Default constructor creates empty factor. | |
template<typename CONTAINER > | |
DiscreteFactor (const CONTAINER &keys) | |
Construct from container of keys. More... | |
virtual | ~DiscreteFactor () |
Virtual destructor. | |
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... | |
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) | |
double | error (const HybridValues &c) const override |
All factor types need to implement an error function. More... | |
virtual DecisionTreeFactor | operator* (const DecisionTreeFactor &) const =0 |
Multiply in a DecisionTreeFactor and return the result as DecisionTreeFactor. More... | |
virtual DecisionTreeFactor | toDecisionTreeFactor () const =0 |
![]() | |
virtual | ~Factor ()=default |
Default destructor. | |
bool | empty () const |
Whether the factor is empty (involves zero variables). | |
Key | front () const |
First key. | |
Key | back () const |
Last key. | |
const_iterator | find (Key key) const |
find | |
const KeyVector & | keys () const |
Access the factor's involved variable keys. | |
const_iterator | begin () const |
Iterator at beginning of involved variable keys. | |
const_iterator | end () const |
Iterator at end of involved variable keys. | |
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 | |
KeyVector & | keys () |
iterator | begin () |
Iterator at beginning of involved variable keys. | |
iterator | end () |
Iterator at end of involved variable keys. | |
Public Types | |
typedef DiscreteFactor | This |
This class. | |
typedef boost::shared_ptr< DiscreteFactor > | shared_ptr |
shared_ptr to this class | |
typedef Factor | Base |
Our base class. | |
using | Values = DiscreteValues |
backwards compatibility | |
![]() | |
typedef KeyVector::iterator | iterator |
Iterator over keys. | |
typedef KeyVector::const_iterator | const_iterator |
Const iterator over keys. | |
Additional Inherited Members | |
![]() | |
Factor () | |
Default constructor for I/O. | |
template<typename CONTAINER > | |
Factor (const CONTAINER &keys) | |
Construct factor from container of keys. More... | |
template<typename ITERATOR > | |
Factor (ITERATOR first, ITERATOR last) | |
Construct factor from iterator keys. More... | |
![]() | |
template<typename CONTAINER > | |
static Factor | FromKeys (const CONTAINER &keys) |
Construct factor from container of keys. More... | |
template<typename ITERATOR > | |
static Factor | FromIterators (ITERATOR first, ITERATOR last) |
Construct factor from iterator keys. More... | |
![]() | |
KeyVector | keys_ |
The keys involved in this factor. | |
|
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.
|
pure virtual |
equals
Implemented in gtsam::DecisionTreeFactor, and gtsam::DiscreteConditional.
|
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::DiscreteConditional.
|
pure virtual |
Render as html table.
keyFormatter | GTSAM-style Key formatter. |
names | optional, category names corresponding to choices. |
Implemented in gtsam::DecisionTreeFactor, and gtsam::DiscreteConditional.
|
pure virtual |
Render as markdown table.
keyFormatter | GTSAM-style Key formatter. |
names | optional, category names corresponding to choices. |
Implemented in gtsam::DecisionTreeFactor, and gtsam::DiscreteConditional.
|
pure virtual |
Find value for given assignment of values to variables.
Implemented in gtsam::DecisionTreeFactor.
|
pure virtual |
Multiply in a DecisionTreeFactor and return the result as DecisionTreeFactor.
Implemented in gtsam::DecisionTreeFactor.
|
inlineoverridevirtual |
|
pure virtual |
Implemented in gtsam::DecisionTreeFactor.