kpeter@1201: /* -*- mode: C++; indent-tabs-mode: nil; -*-
kpeter@1201:  *
kpeter@1201:  * This file is a part of LEMON, a generic C++ optimization library.
kpeter@1201:  *
alpar@1270:  * Copyright (C) 2003-2013
kpeter@1201:  * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
kpeter@1201:  * (Egervary Research Group on Combinatorial Optimization, EGRES).
kpeter@1201:  *
kpeter@1201:  * Permission to use, modify and distribute this software is granted
kpeter@1201:  * provided that this copyright notice appears in all copies. For
kpeter@1201:  * precise terms see the accompanying LICENSE file.
kpeter@1201:  *
kpeter@1201:  * This software is provided "AS IS" with no warranty of any kind,
kpeter@1201:  * express or implied, and with no claim as to its suitability for any
kpeter@1201:  * purpose.
kpeter@1201:  *
kpeter@1201:  */
kpeter@1201: 
f4c3@1199: #ifndef LEMON_NEAREST_NEIGHBOUR_TSP_H
f4c3@1199: #define LEMON_NEAREST_NEIGHBOUR_TSP_H
f4c3@1199: 
kpeter@1201: /// \ingroup tsp
kpeter@1201: /// \file
kpeter@1201: /// \brief Nearest neighbor algorithm for symmetric TSP
kpeter@1201: 
f4c3@1199: #include <deque>
kpeter@1202: #include <vector>
kpeter@1201: #include <limits>
f4c3@1199: #include <lemon/full_graph.h>
f4c3@1199: #include <lemon/maps.h>
f4c3@1199: 
f4c3@1199: namespace lemon {
f4c3@1199: 
kpeter@1202:   /// \ingroup tsp
kpeter@1202:   ///
kpeter@1201:   /// \brief Nearest neighbor algorithm for symmetric TSP.
kpeter@1201:   ///
kpeter@1201:   /// NearestNeighborTsp implements the nearest neighbor heuristic for solving
kpeter@1201:   /// symmetric \ref tsp "TSP".
kpeter@1201:   ///
kpeter@1201:   /// This is probably the simplest TSP heuristic.
kpeter@1201:   /// It starts with a minimum cost edge and at each step, it connects the
kpeter@1201:   /// nearest unvisited node to the current path.
kpeter@1201:   /// Finally, it connects the two end points of the path to form a tour.
kpeter@1201:   ///
kpeter@1201:   /// This method runs in O(n<sup>2</sup>) time.
kpeter@1204:   /// It quickly finds a relatively short tour for most TSP instances,
kpeter@1204:   /// but it could also yield a really bad (or even the worst) solution
kpeter@1204:   /// in special cases.
kpeter@1201:   ///
kpeter@1201:   /// \tparam CM Type of the cost map.
f4c3@1199:   template <typename CM>
kpeter@1201:   class NearestNeighborTsp
kpeter@1201:   {
kpeter@1201:     public:
kpeter@1201: 
kpeter@1201:       /// Type of the cost map
kpeter@1201:       typedef CM CostMap;
kpeter@1201:       /// Type of the edge costs
kpeter@1201:       typedef typename CM::Value Cost;
kpeter@1201: 
f4c3@1199:     private:
kpeter@1201: 
f4c3@1199:       GRAPH_TYPEDEFS(FullGraph);
f4c3@1199: 
kpeter@1201:       const FullGraph &_gr;
kpeter@1201:       const CostMap &_cost;
kpeter@1201:       Cost _sum;
kpeter@1202:       std::vector<Node> _path;
kpeter@1201: 
f4c3@1199:     public:
f4c3@1199: 
kpeter@1201:       /// \brief Constructor
kpeter@1201:       ///
kpeter@1201:       /// Constructor.
kpeter@1201:       /// \param gr The \ref FullGraph "full graph" the algorithm runs on.
kpeter@1201:       /// \param cost The cost map.
kpeter@1201:       NearestNeighborTsp(const FullGraph &gr, const CostMap &cost)
kpeter@1201:         : _gr(gr), _cost(cost) {}
kpeter@1201: 
kpeter@1201:       /// \name Execution Control
kpeter@1201:       /// @{
kpeter@1201: 
kpeter@1201:       /// \brief Runs the algorithm.
kpeter@1201:       ///
kpeter@1201:       /// This function runs the algorithm.
kpeter@1201:       ///
kpeter@1201:       /// \return The total cost of the found tour.
f4c3@1199:       Cost run() {
f4c3@1199:         _path.clear();
kpeter@1202:         if (_gr.nodeNum() == 0) {
kpeter@1202:           return _sum = 0;
kpeter@1202:         }
kpeter@1201:         else if (_gr.nodeNum() == 1) {
kpeter@1201:           _path.push_back(_gr(0));
kpeter@1201:           return _sum = 0;
kpeter@1201:         }
kpeter@1201: 
kpeter@1202:         std::deque<Node> path_dq;
f4c3@1199:         Edge min_edge1 = INVALID,
f4c3@1199:              min_edge2 = INVALID;
kpeter@1201: 
f4c3@1199:         min_edge1 = mapMin(_gr, _cost);
kpeter@1201:         Node n1 = _gr.u(min_edge1),
f4c3@1199:              n2 = _gr.v(min_edge1);
kpeter@1202:         path_dq.push_back(n1);
kpeter@1202:         path_dq.push_back(n2);
f4c3@1199: 
kpeter@1201:         FullGraph::NodeMap<bool> used(_gr, false);
f4c3@1199:         used[n1] = true;
f4c3@1199:         used[n2] = true;
f4c3@1199: 
f4c3@1199:         min_edge1 = INVALID;
kpeter@1202:         while (int(path_dq.size()) != _gr.nodeNum()) {
f4c3@1199:           if (min_edge1 == INVALID) {
kpeter@1201:             for (IncEdgeIt e(_gr, n1); e != INVALID; ++e) {
kpeter@1201:               if (!used[_gr.runningNode(e)] &&
alpar@1294:                   (min_edge1 == INVALID || _cost[e] < _cost[min_edge1])) {
kpeter@1201:                 min_edge1 = e;
f4c3@1199:               }
f4c3@1199:             }
f4c3@1199:           }
f4c3@1199: 
f4c3@1199:           if (min_edge2 == INVALID) {
kpeter@1201:             for (IncEdgeIt e(_gr, n2); e != INVALID; ++e) {
kpeter@1201:               if (!used[_gr.runningNode(e)] &&
alpar@1294:                   (min_edge2 == INVALID||_cost[e] < _cost[min_edge2])) {
kpeter@1201:                 min_edge2 = e;
f4c3@1199:               }
f4c3@1199:             }
f4c3@1199:           }
f4c3@1199: 
kpeter@1201:           if (_cost[min_edge1] < _cost[min_edge2]) {
kpeter@1201:             n1 = _gr.oppositeNode(n1, min_edge1);
kpeter@1202:             path_dq.push_front(n1);
f4c3@1199: 
f4c3@1199:             used[n1] = true;
f4c3@1199:             min_edge1 = INVALID;
f4c3@1199: 
kpeter@1201:             if (_gr.u(min_edge2) == n1 || _gr.v(min_edge2) == n1)
f4c3@1199:               min_edge2 = INVALID;
f4c3@1199:           } else {
kpeter@1201:             n2 = _gr.oppositeNode(n2, min_edge2);
kpeter@1202:             path_dq.push_back(n2);
f4c3@1199: 
f4c3@1199:             used[n2] = true;
f4c3@1199:             min_edge2 = INVALID;
f4c3@1199: 
kpeter@1201:             if (_gr.u(min_edge1) == n2 || _gr.v(min_edge1) == n2)
f4c3@1199:               min_edge1 = INVALID;
f4c3@1199:           }
f4c3@1199:         }
f4c3@1199: 
kpeter@1202:         n1 = path_dq.back();
kpeter@1202:         n2 = path_dq.front();
kpeter@1202:         _path.push_back(n2);
kpeter@1202:         _sum = _cost[_gr.edge(n1, n2)];
kpeter@1202:         for (int i = 1; i < int(path_dq.size()); ++i) {
kpeter@1202:           n1 = n2;
kpeter@1202:           n2 = path_dq[i];
kpeter@1202:           _path.push_back(n2);
kpeter@1202:           _sum += _cost[_gr.edge(n1, n2)];
kpeter@1201:         }
f4c3@1199: 
f4c3@1199:         return _sum;
f4c3@1199:       }
f4c3@1199: 
kpeter@1201:       /// @}
kpeter@1201: 
kpeter@1201:       /// \name Query Functions
kpeter@1201:       /// @{
kpeter@1201: 
kpeter@1201:       /// \brief The total cost of the found tour.
kpeter@1201:       ///
kpeter@1201:       /// This function returns the total cost of the found tour.
kpeter@1201:       ///
kpeter@1201:       /// \pre run() must be called before using this function.
kpeter@1201:       Cost tourCost() const {
kpeter@1201:         return _sum;
f4c3@1199:       }
f4c3@1199: 
kpeter@1201:       /// \brief Returns a const reference to the node sequence of the
kpeter@1201:       /// found tour.
kpeter@1201:       ///
kpeter@1202:       /// This function returns a const reference to a vector
kpeter@1201:       /// that stores the node sequence of the found tour.
kpeter@1201:       ///
kpeter@1201:       /// \pre run() must be called before using this function.
kpeter@1202:       const std::vector<Node>& tourNodes() const {
f4c3@1199:         return _path;
f4c3@1199:       }
kpeter@1201: 
kpeter@1201:       /// \brief Gives back the node sequence of the found tour.
kpeter@1201:       ///
kpeter@1201:       /// This function copies the node sequence of the found tour into
kpeter@1205:       /// an STL container through the given output iterator. The
kpeter@1205:       /// <tt>value_type</tt> of the container must be <tt>FullGraph::Node</tt>.
kpeter@1205:       /// For example,
kpeter@1205:       /// \code
kpeter@1205:       /// std::vector<FullGraph::Node> nodes(countNodes(graph));
kpeter@1205:       /// tsp.tourNodes(nodes.begin());
kpeter@1205:       /// \endcode
kpeter@1205:       /// or
kpeter@1205:       /// \code
kpeter@1205:       /// std::list<FullGraph::Node> nodes;
kpeter@1205:       /// tsp.tourNodes(std::back_inserter(nodes));
kpeter@1205:       /// \endcode
kpeter@1201:       ///
kpeter@1201:       /// \pre run() must be called before using this function.
kpeter@1205:       template <typename Iterator>
kpeter@1205:       void tourNodes(Iterator out) const {
kpeter@1205:         std::copy(_path.begin(), _path.end(), out);
kpeter@1201:       }
kpeter@1201: 
kpeter@1201:       /// \brief Gives back the found tour as a path.
kpeter@1201:       ///
kpeter@1201:       /// This function copies the found tour as a list of arcs/edges into
alpar@1250:       /// the given \ref lemon::concepts::Path "path structure".
kpeter@1201:       ///
kpeter@1201:       /// \pre run() must be called before using this function.
kpeter@1201:       template <typename Path>
kpeter@1201:       void tour(Path &path) const {
kpeter@1201:         path.clear();
kpeter@1201:         for (int i = 0; i < int(_path.size()) - 1; ++i) {
kpeter@1201:           path.addBack(_gr.arc(_path[i], _path[i+1]));
f4c3@1199:         }
kpeter@1201:         if (int(_path.size()) >= 2) {
kpeter@1201:           path.addBack(_gr.arc(_path.back(), _path.front()));
kpeter@1201:         }
f4c3@1199:       }
f4c3@1199: 
kpeter@1201:       /// @}
kpeter@1201: 
f4c3@1199:   };
f4c3@1199: 
f4c3@1199: }; // namespace lemon
f4c3@1199: 
f4c3@1199: #endif