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

Funcion that refers to a factor of another GraphicalModel in which some variables are fixed. More...

#include <view_fix_variables_function.hxx>

+ Inheritance diagram for opengm::ViewFixVariablesFunction< GM >:
+ Collaboration diagram for opengm::ViewFixVariablesFunction< GM >:

Public Types

typedef GM::ValueType ValueType
 
typedef ValueType value_type
 
typedef GM::FactorType FactorType
 
typedef GM::OperatorType OperatorType
 
typedef GM::IndexType IndexType
 
typedef GM::LabelType LabelType
 
- Public Types inherited from opengm::FunctionBase< ViewFixVariablesFunction< GM >, GM::ValueType, GM::IndexType, GM::LabelType >
typedef AccessorIterator< FunctionShapeAccessorType, true > FunctionShapeIteratorType
 

Public Member Functions

 ViewFixVariablesFunction ()
 
 ViewFixVariablesFunction (const FactorType &, const std::vector< PositionAndLabel< IndexType, LabelType > > &)
 
template<class POSITION_AND_TYPE_CONTAINER >
 ViewFixVariablesFunction (const FactorType &, const POSITION_AND_TYPE_CONTAINER &)
 
template<class Iterator >
ValueType operator() (Iterator begin) const
 
IndexType shape (const IndexType) const
 
IndexType dimension () const
 
IndexType size () const
 
template<class GM >
 ViewFixVariablesFunction (const typename ViewFixVariablesFunction< GM >::FactorType &factor, const std::vector< PositionAndLabel< typename GM::IndexType, typename GM::LabelType > > &positionAndLabels)
 
template<class POSITION_AND_TYPE_CONTAINER >
 ViewFixVariablesFunction (const typename ViewFixVariablesFunction< GM >::FactorType &factor, const POSITION_AND_TYPE_CONTAINER &positionAndLabels)
 constructor More...
 
- Public Member Functions inherited from opengm::FunctionBase< ViewFixVariablesFunction< GM >, GM::ValueType, GM::IndexType, GM::LabelType >
bool isPotts () const
 
bool isGeneralizedPotts () const
 
bool isSubmodular () const
 
bool isSquaredDifference () const
 
bool isTruncatedSquaredDifference () const
 
bool isAbsoluteDifference () const
 
bool isTruncatedAbsoluteDifference () const
 
bool isLinearConstraint () const
 
MinMaxFunctor< GM::ValueType > minMax () const
 find minimum and maximum of the function in a single sweep More...
 
ReturnType min () const
 
ReturnType max () const
 
ReturnType sum () const
 
ReturnType product () const
 
ReturnType accumulate () const
 accumulate all values of the function More...
 
void forAllValuesInOrder (FUNCTOR &functor) const
 call a functor for each value of the function (in lexicographical order of the variable indices) More...
 
void forAllValuesInSwitchedOrder (FUNCTOR &functor) const
 
void forAllValuesInAnyOrder (FUNCTOR &functor) const
 call a functor for each value of the function (in un-specified order) More...
 
void forAtLeastAllUniqueValues (FUNCTOR &functor) const
 call a functor for at least all unique values of the function More...
 
void forAllValuesInOrderWithCoordinate (COORDINATE_FUNCTOR &functor) const
 
void forAllValuesInAnyOrderWithCoordinate (COORDINATE_FUNCTOR &functor) const
 
void forAtLeastAllUniqueValuesWithCoordinate (COORDINATE_FUNCTOR &functor) const
 
bool operator== (const ViewFixVariablesFunction< GM > &) const
 
FunctionShapeIteratorType functionShapeBegin () const
 
FunctionShapeIteratorType functionShapeEnd () const
 
size_t numberOfParameters () const
 
GM::IndexType parameterIndex (const size_t paramNumber) const
 

Detailed Description

template<class GM>
class opengm::ViewFixVariablesFunction< GM >

Funcion that refers to a factor of another GraphicalModel in which some variables are fixed.

Definition at line 22 of file view_fix_variables_function.hxx.

Member Typedef Documentation

template<class GM>
typedef GM::FactorType opengm::ViewFixVariablesFunction< GM >::FactorType

Definition at line 27 of file view_fix_variables_function.hxx.

template<class GM>
typedef GM::IndexType opengm::ViewFixVariablesFunction< GM >::IndexType

Definition at line 29 of file view_fix_variables_function.hxx.

template<class GM>
typedef GM::LabelType opengm::ViewFixVariablesFunction< GM >::LabelType

Definition at line 30 of file view_fix_variables_function.hxx.

template<class GM>
typedef GM::OperatorType opengm::ViewFixVariablesFunction< GM >::OperatorType

Definition at line 28 of file view_fix_variables_function.hxx.

template<class GM>
typedef ValueType opengm::ViewFixVariablesFunction< GM >::value_type

Definition at line 26 of file view_fix_variables_function.hxx.

template<class GM>
typedef GM::ValueType opengm::ViewFixVariablesFunction< GM >::ValueType

Definition at line 25 of file view_fix_variables_function.hxx.

Constructor & Destructor Documentation

template<class GM >
opengm::ViewFixVariablesFunction< GM >::ViewFixVariablesFunction ( )
inline

Definition at line 63 of file view_fix_variables_function.hxx.

template<class GM>
opengm::ViewFixVariablesFunction< GM >::ViewFixVariablesFunction ( const FactorType ,
const std::vector< PositionAndLabel< IndexType, LabelType > > &   
)
template<class GM>
template<class POSITION_AND_TYPE_CONTAINER >
opengm::ViewFixVariablesFunction< GM >::ViewFixVariablesFunction ( const FactorType ,
const POSITION_AND_TYPE_CONTAINER &   
)
template<class GM>
template<class GM >
opengm::ViewFixVariablesFunction< GM >::ViewFixVariablesFunction ( const typename ViewFixVariablesFunction< GM >::FactorType factor,
const std::vector< PositionAndLabel< typename GM::IndexType, typename GM::LabelType > > &  positionAndLabels 
)
inline

Definition at line 73 of file view_fix_variables_function.hxx.

template<class GM>
template<class POSITION_AND_TYPE_CONTAINER >
opengm::ViewFixVariablesFunction< GM >::ViewFixVariablesFunction ( const typename ViewFixVariablesFunction< GM >::FactorType factor,
const POSITION_AND_TYPE_CONTAINER &  positionAndLabels 
)
inline

constructor

Template Parameters
POSITION_AND_TYPE_CONTAINERcontainer holding positions and labels of the variable to fix
Parameters
factorthe factor to reference
positionAndLabelspositions and labels of the variable to fix

Definition at line 108 of file view_fix_variables_function.hxx.

Member Function Documentation

template<class GM >
ViewFixVariablesFunction< GM >::IndexType opengm::ViewFixVariablesFunction< GM >::dimension ( ) const
inline

Definition at line 175 of file view_fix_variables_function.hxx.

template<class GM >
template<class Iterator >
ViewFixVariablesFunction< GM >::ValueType opengm::ViewFixVariablesFunction< GM >::operator() ( Iterator  begin) const
inline

Definition at line 139 of file view_fix_variables_function.hxx.

template<class GM>
ViewFixVariablesFunction< GM >::IndexType opengm::ViewFixVariablesFunction< GM >::shape ( const IndexType  ) const
inline

Definition at line 158 of file view_fix_variables_function.hxx.

template<class GM >
ViewFixVariablesFunction< GM >::IndexType opengm::ViewFixVariablesFunction< GM >::size ( ) const
inline

Definition at line 183 of file view_fix_variables_function.hxx.