linear_constraint_function_base.hxx

Go to the documentation of this file.

#ifndef OPENGM_LINEAR_CONSTRAINT_FUNCTION_BASE_HXX_
#define OPENGM_LINEAR_CONSTRAINT_FUNCTION_BASE_HXX_

#include <opengm/functions/function_properties_base.hxx>

namespace opengm {

/*********************
 * class definition *
 *********************/

struct LinearConstraintFunctionTraitsUndefined
{};

template <typename LINEAR_CONSTRAINT_FUNCTION_TYPE>
struct LinearConstraintFunctionTraits
{
   typedef LinearConstraintFunctionTraitsUndefined ValueType;
};

template<class LINEAR_CONSTRAINT_FUNCTION_TYPE>
class LinearConstraintFunctionBase :  public FunctionBase<LINEAR_CONSTRAINT_FUNCTION_TYPE, typename LinearConstraintFunctionTraits<LINEAR_CONSTRAINT_FUNCTION_TYPE>::ValueType, typename LinearConstraintFunctionTraits<LINEAR_CONSTRAINT_FUNCTION_TYPE>::IndexType, typename LinearConstraintFunctionTraits<LINEAR_CONSTRAINT_FUNCTION_TYPE>::LabelType> {
public:
   // typedefs
   typedef LINEAR_CONSTRAINT_FUNCTION_TYPE                                                           LinearConstraintFunctionType;
   typedef LinearConstraintFunctionTraits<LinearConstraintFunctionType>                              LinearConstraintFunctionTraitsType;
   typedef typename LinearConstraintFunctionTraitsType::ValueType                                    ValueType;
   typedef typename LinearConstraintFunctionTraitsType::IndexType                                    IndexType;
   typedef typename LinearConstraintFunctionTraitsType::LabelType                                    LabelType;
   typedef typename LinearConstraintFunctionTraitsType::LinearConstraintType                         LinearConstraintType;
   typedef typename LinearConstraintFunctionTraitsType::LinearConstraintsIteratorType                LinearConstraintsIteratorType;
   typedef typename LinearConstraintFunctionTraitsType::ViolatedLinearConstraintsIteratorType        ViolatedLinearConstraintsIteratorType;
   typedef typename LinearConstraintFunctionTraitsType::ViolatedLinearConstraintsWeightsIteratorType ViolatedLinearConstraintsWeightsIteratorType;
   typedef typename LinearConstraintFunctionTraitsType::IndicatorVariablesIteratorType               IndicatorVariablesIteratorType;

   // const access
   LinearConstraintsIteratorType  linearConstraintsBegin() const;
   LinearConstraintsIteratorType  linearConstraintsEnd() const;
   IndicatorVariablesIteratorType indicatorVariablesOrderBegin() const;
   IndicatorVariablesIteratorType indicatorVariablesOrderEnd() const;

   template <class LABEL_ITERATOR>
   void challenge(ViolatedLinearConstraintsIteratorType& violatedConstraintsBegin, ViolatedLinearConstraintsIteratorType& violatedConstraintsEnd, ViolatedLinearConstraintsWeightsIteratorType& violatedConstraintsWeightsBegin, LABEL_ITERATOR labelingBegin, const ValueType tolerance = 0.0) const;
   template <class LABEL_ITERATOR>
   void challengeRelaxed(ViolatedLinearConstraintsIteratorType& violatedConstraintsBegin, ViolatedLinearConstraintsIteratorType& violatedConstraintsEnd, ViolatedLinearConstraintsWeightsIteratorType& violatedConstraintsWeightsBegin, LABEL_ITERATOR labelingBegin, const ValueType tolerance = 0.0) const;

   // specializations
   bool isLinearConstraint() const;
};

/***********************
 * class documentation *
 ***********************/
/******************
 * implementation *
 ******************/
template<class LINEAR_CONSTRAINT_FUNCTION_TYPE>
inline typename LinearConstraintFunctionBase<LINEAR_CONSTRAINT_FUNCTION_TYPE>::LinearConstraintsIteratorType LinearConstraintFunctionBase<LINEAR_CONSTRAINT_FUNCTION_TYPE>::linearConstraintsBegin() const {
   return static_cast<const LinearConstraintFunctionType*>(this)->linearConstraintsBegin_impl();
}

template<class LINEAR_CONSTRAINT_FUNCTION_TYPE>
inline typename LinearConstraintFunctionBase<LINEAR_CONSTRAINT_FUNCTION_TYPE>::LinearConstraintsIteratorType LinearConstraintFunctionBase<LINEAR_CONSTRAINT_FUNCTION_TYPE>::linearConstraintsEnd() const {
   return static_cast<const LinearConstraintFunctionType*>(this)->linearConstraintsEnd_impl();
}

template<class LINEAR_CONSTRAINT_FUNCTION_TYPE>
inline typename LinearConstraintFunctionBase<LINEAR_CONSTRAINT_FUNCTION_TYPE>::IndicatorVariablesIteratorType LinearConstraintFunctionBase<LINEAR_CONSTRAINT_FUNCTION_TYPE>::indicatorVariablesOrderBegin() const {
   return static_cast<const LinearConstraintFunctionType*>(this)->indicatorVariablesOrderBegin_impl();
}

template<class LINEAR_CONSTRAINT_FUNCTION_TYPE>
inline typename LinearConstraintFunctionBase<LINEAR_CONSTRAINT_FUNCTION_TYPE>::IndicatorVariablesIteratorType LinearConstraintFunctionBase<LINEAR_CONSTRAINT_FUNCTION_TYPE>::indicatorVariablesOrderEnd() const {
   return static_cast<const LinearConstraintFunctionType*>(this)->indicatorVariablesOrderEnd_impl();
}

template<class LINEAR_CONSTRAINT_FUNCTION_TYPE>
template <class LABEL_ITERATOR>
inline void LinearConstraintFunctionBase<LINEAR_CONSTRAINT_FUNCTION_TYPE>::challenge(ViolatedLinearConstraintsIteratorType& violatedConstraintsBegin, ViolatedLinearConstraintsIteratorType& violatedConstraintsEnd, ViolatedLinearConstraintsWeightsIteratorType& violatedConstraintsWeightsBegin, LABEL_ITERATOR labelingBegin, const ValueType tolerance) const {
   return static_cast<const LinearConstraintFunctionType*>(this)->challenge_impl(violatedConstraintsBegin, violatedConstraintsEnd, violatedConstraintsWeightsBegin, labelingBegin, tolerance);
}

template<class LINEAR_CONSTRAINT_FUNCTION_TYPE>
template <class LABEL_ITERATOR>
inline void LinearConstraintFunctionBase<LINEAR_CONSTRAINT_FUNCTION_TYPE>::challengeRelaxed(ViolatedLinearConstraintsIteratorType& violatedConstraintsBegin, ViolatedLinearConstraintsIteratorType& violatedConstraintsEnd, ViolatedLinearConstraintsWeightsIteratorType& violatedConstraintsWeightsBegin, LABEL_ITERATOR labelingBegin, const ValueType tolerance) const {
   return static_cast<const LinearConstraintFunctionType*>(this)->challengeRelaxed_impl(violatedConstraintsBegin, violatedConstraintsEnd, violatedConstraintsWeightsBegin, labelingBegin, tolerance);
}

template<class LINEAR_CONSTRAINT_FUNCTION_TYPE>
inline bool LinearConstraintFunctionBase<LINEAR_CONSTRAINT_FUNCTION_TYPE>::isLinearConstraint() const {
   return true;
}

} // namespace opengm

#endif /* OPENGM_LINEAR_CONSTRAINT_FUNCTION_BASE_HXX_ */