simplelocalsearch.hh

Go to the documentation of this file.

#if !defined(_SIMPLE_LOCAL_SEARCH_HH_)
#define _SIMPLE_LOCAL_SEARCH_HH_

#include <future>

#include "easylocal/helpers/statemanager.hh"
#include "easylocal/helpers/outputmanager.hh"
#include "easylocal/solvers/abstractlocalsearch.hh"
#include "easylocal/searchengines/searchengine.hh"

namespace EasyLocal {
  
  namespace Core {
    
    template <class Input, class Output, class State, typename CFtype = int>
    class SimpleLocalSearch
    : public AbstractLocalSearch<Input, Output, State, CFtype>
    {
    public:
      typedef SearchEngine<Input, State, CFtype> SearchEngineType;
      SimpleLocalSearch(const Input& in,
                        StateManager<Input, State, CFtype>& e_sm,
                        OutputManager<Input, Output, State, CFtype>& e_om,
                        std::string name);
      void SetSearchEngine(SearchEngine<Input, State, CFtype>& r);
      void Print(std::ostream& os = std::cout) const;
      void ReadParameters(std::istream& is = std::cin, std::ostream& os = std::cout);
    protected:
      void Go();
      void AtTimeoutExpired();
      SearchEngineType* p_searchengine; 
    };
    
    /*************************************************************************
     * Implementation
     *************************************************************************/
    
    template <class Input, class Output, class State, typename CFtype>
    SimpleLocalSearch<Input, Output, State, CFtype>::SimpleLocalSearch(const Input& in,
                                                                       StateManager<Input, State, CFtype>& e_sm,
                                                                       OutputManager<Input, Output, State, CFtype>& e_om,
                                                                       std::string name)
    : AbstractLocalSearch<Input, Output, State, CFtype>(in, e_sm, e_om, name, "Simple Local Search Solver"), p_searchengine(nullptr)
    {}
    
    template <class Input, class Output, class State, typename CFtype>
    void SimpleLocalSearch<Input, Output, State, CFtype>::ReadParameters(std::istream& is, std::ostream& os)
    {
      os << "Simple Local Search Solver: " << this->name << " parameters" << std::endl;
      os << "SearchEngine: " << std::endl;
      if (this->p_searchengine)
        this->p_searchengine->ReadParameters(is, os);
    }
    
    template <class Input, class Output, class State, typename CFtype>
    void SimpleLocalSearch<Input, Output, State, CFtype>::Print(std::ostream& os) const
    {
      os  << "Simple Local Search Solver: " << this->name << std::endl;
      if (this->p_searchengine)
        this->p_searchengine->Print(os);
      else
        os  << "<no searchengine attached>" << std::endl;
    }
    
    
    template <class Input, class Output, class State, typename CFtype>
    void SimpleLocalSearch<Input, Output, State, CFtype>::SetSearchEngine(SearchEngine<Input, State, CFtype>& r)
    { this->p_searchengine = &r; }
    
    
    template <class Input, class Output, class State, typename CFtype>
    void SimpleLocalSearch<Input, Output, State, CFtype>::Go()
    {
      if (!p_searchengine)
        // FIXME: add a more specific exception behavior
        throw std::logic_error("SearchEngine not set in object " + this->name);
      this->current_state_cost = p_searchengine->Go(*this->p_current_state);
      
      *this->p_best_state = *this->p_current_state;
      this->best_state_cost = this->current_state_cost;
    }
    
    template <class Input, class Output, class State, typename CFtype>
    void SimpleLocalSearch<Input, Output, State, CFtype>::AtTimeoutExpired()
    {
      p_searchengine->Interrupt();
    }
  }
}

#endif // _SIMPLE_LOCAL_SEARCH_HH_