Changeset 1037:d3dcc49e6403 in lemon-main for lemon

Timestamp:

02/28/13 17:13:14 (11 years ago)

Author:

Peter Kovacs <kpeter@…>

Branch:

default

Phase:

public

Message:

Use output iterator instead of a container (#386)
in tourNodes() functions of TSP algorithms

Location:

lemon

Files:

• christofides_tsp.h (modified) (1 diff)
• greedy_tsp.h (modified) (1 diff)
• insertion_tsp.h (modified) (1 diff)
• nearest_neighbor_tsp.h (modified) (1 diff)
• opt2_tsp.h (modified) (1 diff)

lemon/christofides_tsp.h

@@ -210 +210 @@
       ///
       /// This function copies the node sequence of the found tour into
-      /// the given standard container.
-      ///
-      /// \pre run() must be called before using this function.
-      template <typename Container>
-      void tourNodes(Container &container) const {
-        container.assign(_path.begin(), _path.end());
+      /// an STL container through the given output iterator. The
+      /// <tt>value_type</tt> of the container must be <tt>FullGraph::Node</tt>.
+      /// For example,
+      /// \code
+      /// std::vector<FullGraph::Node> nodes(countNodes(graph));
+      /// tsp.tourNodes(nodes.begin());
+      /// \endcode
+      /// or
+      /// \code
+      /// std::list<FullGraph::Node> nodes;
+      /// tsp.tourNodes(std::back_inserter(nodes));
+      /// \endcode
+      ///
+      /// \pre run() must be called before using this function.
+      template <typename Iterator>
+      void tourNodes(Iterator out) const {
+        std::copy(_path.begin(), _path.end(), out);
       }
       

lemon/greedy_tsp.h

@@ -207 +207 @@
       ///
       /// This function copies the node sequence of the found tour into
-      /// the given standard container.
-      ///
-      /// \pre run() must be called before using this function.
-      template <typename Container>
-      void tourNodes(Container &container) const {
-        container.assign(_path.begin(), _path.end());
+      /// an STL container through the given output iterator. The
+      /// <tt>value_type</tt> of the container must be <tt>FullGraph::Node</tt>.
+      /// For example,
+      /// \code
+      /// std::vector<FullGraph::Node> nodes(countNodes(graph));
+      /// tsp.tourNodes(nodes.begin());
+      /// \endcode
+      /// or
+      /// \code
+      /// std::list<FullGraph::Node> nodes;
+      /// tsp.tourNodes(std::back_inserter(nodes));
+      /// \endcode
+      ///
+      /// \pre run() must be called before using this function.
+      template <typename Iterator>
+      void tourNodes(Iterator out) const {
+        std::copy(_path.begin(), _path.end(), out);
       }
 

lemon/insertion_tsp.h

@@ -204 +204 @@
       ///
       /// This function copies the node sequence of the found tour into
-      /// the given standard container.
+      /// an STL container through the given output iterator. The
+      /// <tt>value_type</tt> of the container must be <tt>FullGraph::Node</tt>.
+      /// For example,
+      /// \code
+      /// std::vector<FullGraph::Node> nodes(countNodes(graph));
+      /// tsp.tourNodes(nodes.begin());
+      /// \endcode
+      /// or
+      /// \code
+      /// std::list<FullGraph::Node> nodes;
+      /// tsp.tourNodes(std::back_inserter(nodes));
+      /// \endcode
       ///
       /// \pre run() must be called before using this function.
-      template <typename Container>
-      void tourNodes(Container &container) const {
-        container.assign(_tour.begin(), _tour.end());
+      template <typename Iterator>
+      void tourNodes(Iterator out) const {
+        std::copy(_tour.begin(), _tour.end(), out);
       }
 

lemon/nearest_neighbor_tsp.h

@@ -194 +194 @@
       ///
       /// This function copies the node sequence of the found tour into
-      /// the given standard container.
-      ///
-      /// \pre run() must be called before using this function.
-      template <typename Container>
-      void tourNodes(Container &container) const {
-        container.assign(_path.begin(), _path.end());
+      /// an STL container through the given output iterator. The
+      /// <tt>value_type</tt> of the container must be <tt>FullGraph::Node</tt>.
+      /// For example,
+      /// \code
+      /// std::vector<FullGraph::Node> nodes(countNodes(graph));
+      /// tsp.tourNodes(nodes.begin());
+      /// \endcode
+      /// or
+      /// \code
+      /// std::list<FullGraph::Node> nodes;
+      /// tsp.tourNodes(std::back_inserter(nodes));
+      /// \endcode
+      ///
+      /// \pre run() must be called before using this function.
+      template <typename Iterator>
+      void tourNodes(Iterator out) const {
+        std::copy(_path.begin(), _path.end(), out);
       }
 

lemon/opt2_tsp.h

@@ -231 +231 @@
       ///
       /// This function copies the node sequence of the found tour into
-      /// the given standard container.
+      /// an STL container through the given output iterator. The
+      /// <tt>value_type</tt> of the container must be <tt>FullGraph::Node</tt>.
+      /// For example,
+      /// \code
+      /// std::vector<FullGraph::Node> nodes(countNodes(graph));
+      /// tsp.tourNodes(nodes.begin());
+      /// \endcode
+      /// or
+      /// \code
+      /// std::list<FullGraph::Node> nodes;
+      /// tsp.tourNodes(std::back_inserter(nodes));
+      /// \endcode
       ///
       /// \pre run() must be called before using this function.
-      template <typename Container>
-      void tourNodes(Container &container) const {
-        container.assign(_path.begin(), _path.end());
+      template <typename Iterator>
+      void tourNodes(Iterator out) const {
+        std::copy(_path.begin(), _path.end(), out);
       }