tabu_list.h

Go to the documentation of this file.

/*PGR-GNU*****************************************************************
 
FILE: tabu_list.h
 
Copyright (c) 2021 pgRouting developers
Mail: [email protected]
 
Created by Joseph Percival on 2020/06/15.
Modified by Vicky
------
 
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
 
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 ********************************************************************PGR-GNU*/
 
#ifndef INCLUDE_OPTIMIZERS_TABU_LIST_H_
#define INCLUDE_OPTIMIZERS_TABU_LIST_H_
#pragma once
 
#include <iosfwd>
#include <string>
#include <deque>
#include <set>
 
#include "optimizers/move.h"
 
namespace vrprouting {
namespace optimizers {
namespace tabu {
 
 
class TabuList {
 public:
    typedef std::deque<Move>::iterator iterator;
 
    typedef std::deque<Move>::const_iterator const_iterator;
 
    void add(const Move &m);
 
    void clear();
 
    bool has_move(const problem::Vehicle_pickDeliver&,
                  const problem::Vehicle_pickDeliver&,
                  const problem::Order& from_order, double obj1, double obj2) const;
 
    bool has_swap(const problem::Vehicle_pickDeliver&,
                  const problem::Vehicle_pickDeliver&,
                  const problem::Order&,
                  const problem::Order&, double obj1, double obj2) const;
 
    bool is_empty() const;
 
    size_t size() const;
 
    size_t max_length() const;
 
    void set_max_length(size_t length);
 
    friend std::ostream& operator<<(std::ostream &, const TabuList &);
 
    const_iterator begin() const {return m_tabu_list.begin();}
 
    const_iterator end() const {return m_tabu_list.end();}
 
    bool has_infeasible(const std::string& candidate);
 
    void add_infeasible(const std::string& candidate);
 
    bool has_seen(const std::string& candidate);
 
    void add_seen(const std::string& candidate);
 
 private:
    bool has(const Move &) const;
 
    size_t m_max_length;
 
    std::deque<Move> m_tabu_list;
 
    std::set<std::string> m_infeasible_list;
 
    std::set<std::string> m_seen_list;
};
 
 
}  //  namespace tabu
}  //  namespace optimizers
}  //  namespace vrprouting
 
#endif  // INCLUDE_OPTIMIZERS_TABU_LIST_H_