OpenGM  2.3.x
Discrete Graphical Model Library
Classes | Public Types | Public Member Functions | Public Attributes | List of all members
opengm::ICM< GM, ACC > Class Template Reference

Iterated Conditional Modes Algorithm

J. E. Besag, "On the Statistical Analysis of Dirty Pictures", Journal of the Royal Statistical Society, Series B 48(3):259-302, 1986. More...

#include <icm.hxx>

+ Inheritance diagram for opengm::ICM< GM, ACC >:
+ Collaboration diagram for opengm::ICM< GM, ACC >:

Classes

class  Parameter
 

Public Types

enum  MoveType { SINGLE_VARIABLE = 0, FACTOR = 1 }
 
typedef ACC AccumulationType
 
typedef GM GraphicalModelType
 
typedef Movemaker< GraphicalModelTypeMovemakerType
 
typedef opengm::visitors::VerboseVisitor< ICM< GM, ACC > > VerboseVisitorType
 
typedef opengm::visitors::EmptyVisitor< ICM< GM, ACC > > EmptyVisitorType
 
typedef opengm::visitors::TimingVisitor< ICM< GM, ACC > > TimingVisitorType
 
- Public Types inherited from opengm::Inference< GM, ACC >
typedef GM GraphicalModelType
 
typedef ACC AccumulationType
 
typedef GraphicalModelType::LabelType LabelType
 
typedef GraphicalModelType::IndexType IndexType
 
typedef GraphicalModelType::ValueType ValueType
 
typedef GraphicalModelType::OperatorType OperatorType
 
typedef GraphicalModelType::FactorType FactorType
 
typedef GraphicalModelType::IndependentFactorType IndependentFactorType
 
typedef GraphicalModelType::FunctionIdentifier FunctionIdentifier
 

Public Member Functions

 ICM (const GraphicalModelType &)
 
 ICM (const GraphicalModelType &, const Parameter &)
 
std::string name () const
 
const GraphicalModelTypegraphicalModel () const
 
InferenceTermination infer ()
 
void reset ()
 
template<class VisitorType >
InferenceTermination infer (VisitorType &)
 
void setStartingPoint (typename std::vector< LabelType >::const_iterator)
 set initial labeling More...
 
virtual InferenceTermination arg (std::vector< LabelType > &, const size_t=1) const
 output a solution More...
 
virtual ValueType value () const
 return the solution (value) More...
 
size_t currentMoveType () const
 
- Public Member Functions inherited from opengm::Inference< GM, ACC >
virtual ~Inference ()
 
virtual InferenceTermination args (std::vector< std::vector< LabelType > > &) const
 
virtual InferenceTermination marginal (const size_t, IndependentFactorType &) const
 output a solution for a marginal for a specific variable More...
 
virtual InferenceTermination factorMarginal (const size_t, IndependentFactorType &) const
 output a solution for a marginal for all variables connected to a factor More...
 
virtual ValueType bound () const
 return a bound on the solution More...
 
InferenceTermination constrainedOptimum (std::vector< IndexType > &, std::vector< LabelType > &, std::vector< LabelType > &) const
 
InferenceTermination modeFromMarginal (std::vector< LabelType > &) const
 
InferenceTermination modeFromFactorMarginal (std::vector< LabelType > &) const
 

Public Attributes

 OPENGM_GM_TYPE_TYPEDEFS
 

Detailed Description

template<class GM, class ACC>
class opengm::ICM< GM, ACC >

Iterated Conditional Modes Algorithm

J. E. Besag, "On the Statistical Analysis of Dirty Pictures", Journal of the Royal Statistical Society, Series B 48(3):259-302, 1986.

Examples:
inference_types.cxx, and quick_start.cxx.

Definition at line 24 of file icm.hxx.

Member Typedef Documentation

template<class GM, class ACC>
typedef ACC opengm::ICM< GM, ACC >::AccumulationType

Definition at line 31 of file icm.hxx.

template<class GM, class ACC>
typedef opengm::visitors::EmptyVisitor<ICM<GM,ACC> > opengm::ICM< GM, ACC >::EmptyVisitorType

Definition at line 36 of file icm.hxx.

template<class GM, class ACC>
typedef GM opengm::ICM< GM, ACC >::GraphicalModelType

Definition at line 32 of file icm.hxx.

template<class GM, class ACC>
typedef Movemaker<GraphicalModelType> opengm::ICM< GM, ACC >::MovemakerType

Definition at line 34 of file icm.hxx.

template<class GM, class ACC>
typedef opengm::visitors::TimingVisitor<ICM<GM,ACC> > opengm::ICM< GM, ACC >::TimingVisitorType

Definition at line 37 of file icm.hxx.

template<class GM, class ACC>
typedef opengm::visitors::VerboseVisitor<ICM<GM,ACC> > opengm::ICM< GM, ACC >::VerboseVisitorType

Definition at line 35 of file icm.hxx.

Constructor & Destructor Documentation

template<class GM , class ACC >
opengm::ICM< GM, ACC >::ICM ( const GraphicalModelType gm)
inline

Definition at line 97 of file icm.hxx.

template<class GM , class ACC >
opengm::ICM< GM, ACC >::ICM ( const GraphicalModelType gm,
const Parameter parameter 
)

Definition at line 108 of file icm.hxx.

Member Function Documentation

template<class GM , class ACC >
InferenceTermination opengm::ICM< GM, ACC >::arg ( std::vector< LabelType > &  arg,
const size_t  argIndex = 1 
) const
inlinevirtual

output a solution

Parameters
[out]arglabeling
argIndexsolution index (1=best, 2=second best, etc.)

Reimplemented from opengm::Inference< GM, ACC >.

Definition at line 258 of file icm.hxx.

template<class GM , class ACC >
size_t opengm::ICM< GM, ACC >::currentMoveType ( ) const
inline

Definition at line 90 of file icm.hxx.

template<class GM , class ACC >
const ICM< GM, ACC >::GraphicalModelType & opengm::ICM< GM, ACC >::graphicalModel ( ) const
inlinevirtual

Implements opengm::Inference< GM, ACC >.

Definition at line 158 of file icm.hxx.

template<class GM , class ACC >
InferenceTermination opengm::ICM< GM, ACC >::infer ( )
inlinevirtual

Implements opengm::Inference< GM, ACC >.

Definition at line 165 of file icm.hxx.

template<class GM , class ACC >
template<class VisitorType >
InferenceTermination opengm::ICM< GM, ACC >::infer ( VisitorType &  visitor)

Definition at line 175 of file icm.hxx.

template<class GM , class ACC >
std::string opengm::ICM< GM, ACC >::name ( ) const
inlinevirtual

Implements opengm::Inference< GM, ACC >.

Definition at line 151 of file icm.hxx.

template<class GM , class ACC >
void opengm::ICM< GM, ACC >::reset ( )
inline

Definition at line 127 of file icm.hxx.

template<class GM, class ACC>
void opengm::ICM< GM, ACC >::setStartingPoint ( typename std::vector< LabelType >::const_iterator  begin)
inlinevirtual

set initial labeling

Parameters
beginiterator to the beginning of a sequence of labels

Reimplemented from opengm::Inference< GM, ACC >.

Definition at line 143 of file icm.hxx.

template<class GM, class ACC>
virtual ValueType opengm::ICM< GM, ACC >::value ( ) const
inlinevirtual

return the solution (value)

Reimplemented from opengm::Inference< GM, ACC >.

Definition at line 77 of file icm.hxx.

+ Here is the call graph for this function:

Member Data Documentation

template<class GM, class ACC>
opengm::ICM< GM, ACC >::OPENGM_GM_TYPE_TYPEDEFS

Definition at line 33 of file icm.hxx.