costcomponent.hh

Go to the documentation of this file.

#if !defined(_COST_COMPONENT_HH_)
#define _COST_COMPONENT_HH_

#include <iostream>
#include <vector>
#include "easylocal/utils/printable.hh"

namespace EasyLocal {
  
  namespace Core {
    
    template <class Input, class State, typename CFtype = int>
    class CostComponent : public Printable
    {
      static size_t last_index;
    public:
      
      virtual void Print(std::ostream& os = std::cout) const;
      
      virtual CFtype ComputeCost(const State& st) const = 0;
      
      CFtype Cost(const State& st) const { return weight * ComputeCost(st); }
      
      virtual void PrintViolations(const State& st, std::ostream& os = std::cout) const = 0;
      
      CFtype Weight() const { return weight; }
      
      void SetWeight(const CFtype& w) { weight = w; }
      
      void SetHard() { is_hard = true; }
      
      void SetSoft() { is_hard = false; }
      
      bool IsHard() const { return is_hard; }
      
      bool IsSoft() const { return !is_hard; }
      
      const std::string name;      
      
      size_t Index() const
      {
        return index;
      }
      
      static const size_t CostComponents()
      {
        return last_index;
      }

      
      static const CostComponent<Input, State, CFtype>& Component(size_t i)
      {
        return *cost_components[i];
      }
      
      virtual ~CostComponent() {}

    protected:
      
      CostComponent(const Input& in, const CFtype& weight, bool is_hard, std::string name);
      
      const Input& in;
      
      CFtype weight;
      
      bool is_hard;            
      
      
    protected:
      const size_t index;

      static std::vector<CostComponent<Input, State, CFtype>*> cost_components;
    };
    
    
    
    template <class Input, class State, typename CFtype>
    CostComponent<Input, State, CFtype>::CostComponent(const Input& in, const CFtype& weight, bool is_hard, std::string name)
    : name(name), in(in), weight(weight), is_hard(is_hard), index(last_index++)
    {
      cost_components.push_back(this);
    }
    
    template <class Input, class State, typename CFtype>
    void CostComponent<Input, State, CFtype>::Print(std::ostream& os) const
    {
      os  << "Cost Component " << name << ": weight " << weight << (is_hard ? "*" : "") << std::endl;
    }
    
    template <class Input, class State, typename CFtype>
    size_t CostComponent<Input, State, CFtype>::last_index = 0;
    
    template <class Input, class State, typename CFtype>
    std::vector<CostComponent<Input, State, CFtype>*> CostComponent<Input, State, CFtype>::cost_components;
  }
}

#endif // _COST_COMPONENT_HH_