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

Function that scales a factor of another graphical model. More...

#include <scaled_view.hxx>

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

Public Types

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

Public Member Functions

 ScaledViewFunction (const std::vector< IndexType > &)
 Constructor. More...
 
 ScaledViewFunction (const GM &, const IndexType, const ValueType)
 
template<class Iterator >
ValueType operator() (Iterator begin) const
 
size_t dimension () const
 
size_t shape (const size_t) const
 
size_t size () const
 
- Public Member Functions inherited from opengm::FunctionBase< ScaledViewFunction< 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 ScaledViewFunction< 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::ScaledViewFunction< GM >

Function that scales a factor of another graphical model.

Definition at line 12 of file scaled_view.hxx.

Member Typedef Documentation

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

Definition at line 20 of file scaled_view.hxx.

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

Definition at line 21 of file scaled_view.hxx.

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

Definition at line 22 of file scaled_view.hxx.

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

Definition at line 19 of file scaled_view.hxx.

Constructor & Destructor Documentation

template<class GM >
opengm::ScaledViewFunction< GM >::ScaledViewFunction ( const std::vector< IndexType > &  shape)
inline

Constructor.

Parameters
shapeshape of the function

Definition at line 67 of file scaled_view.hxx.

template<class GM>
opengm::ScaledViewFunction< GM >::ScaledViewFunction ( const GM &  ,
const IndexType  ,
const ValueType   
)

Member Function Documentation

template<class GM >
size_t opengm::ScaledViewFunction< GM >::dimension ( ) const
inline

Definition at line 114 of file scaled_view.hxx.

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

Definition at line 92 of file scaled_view.hxx.

template<class GM >
size_t opengm::ScaledViewFunction< GM >::shape ( const size_t  i) const
inline

Definition at line 106 of file scaled_view.hxx.

template<class GM >
size_t opengm::ScaledViewFunction< GM >::size ( ) const
inline

Definition at line 83 of file scaled_view.hxx.