lemon/path.h
changeset 1184 3c00344f49c9
parent 1044 15d7c5eadaca
child 1130 0759d974de81
     1.1 --- a/lemon/path.h	Mon Jul 16 16:21:40 2018 +0200
     1.2 +++ b/lemon/path.h	Wed Oct 17 19:14:07 2018 +0200
     1.3 @@ -2,7 +2,7 @@
     1.4   *
     1.5   * This file is a part of LEMON, a generic C++ optimization library.
     1.6   *
     1.7 - * Copyright (C) 2003-2010
     1.8 + * Copyright (C) 2003-2013
     1.9   * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
    1.10   * (Egervary Research Group on Combinatorial Optimization, EGRES).
    1.11   *
    1.12 @@ -43,7 +43,7 @@
    1.13    /// \tparam GR The digraph type in which the path is.
    1.14    ///
    1.15    /// In a sense, the path can be treated as a list of arcs. The
    1.16 -  /// lemon path type stores just this list. As a consequence, it
    1.17 +  /// LEMON path type stores just this list. As a consequence, it
    1.18    /// cannot enumerate the nodes of the path and the source node of
    1.19    /// a zero length path is undefined.
    1.20    ///
    1.21 @@ -148,7 +148,7 @@
    1.22      /// \brief Reset the path to an empty one.
    1.23      void clear() { head.clear(); tail.clear(); }
    1.24  
    1.25 -    /// \brief The nth arc.
    1.26 +    /// \brief The n-th arc.
    1.27      ///
    1.28      /// \pre \c n is in the <tt>[0..length() - 1]</tt> range.
    1.29      const Arc& nth(int n) const {
    1.30 @@ -156,7 +156,7 @@
    1.31          *(tail.begin() + (n - head.size()));
    1.32      }
    1.33  
    1.34 -    /// \brief Initialize arc iterator to point to the nth arc
    1.35 +    /// \brief Initialize arc iterator to point to the n-th arc
    1.36      ///
    1.37      /// \pre \c n is in the <tt>[0..length() - 1]</tt> range.
    1.38      ArcIt nthIt(int n) const {
    1.39 @@ -244,7 +244,7 @@
    1.40    /// \tparam GR The digraph type in which the path is.
    1.41    ///
    1.42    /// In a sense, the path can be treated as a list of arcs. The
    1.43 -  /// lemon path type stores just this list. As a consequence it
    1.44 +  /// LEMON path type stores just this list. As a consequence it
    1.45    /// cannot enumerate the nodes in the path and the zero length paths
    1.46    /// cannot store the source.
    1.47    ///
    1.48 @@ -317,7 +317,7 @@
    1.49  
    1.50        /// Constructor with starting point
    1.51        ArcIt(const SimplePath &_path, int _idx)
    1.52 -        : idx(_idx), path(&_path) {}
    1.53 +        : path(&_path), idx(_idx) {}
    1.54  
    1.55      public:
    1.56  
    1.57 @@ -353,14 +353,14 @@
    1.58      /// \brief Reset the path to an empty one.
    1.59      void clear() { data.clear(); }
    1.60  
    1.61 -    /// \brief The nth arc.
    1.62 +    /// \brief The n-th arc.
    1.63      ///
    1.64      /// \pre \c n is in the <tt>[0..length() - 1]</tt> range.
    1.65      const Arc& nth(int n) const {
    1.66        return data[n];
    1.67      }
    1.68  
    1.69 -    /// \brief  Initializes arc iterator to point to the nth arc.
    1.70 +    /// \brief  Initializes arc iterator to point to the n-th arc.
    1.71      ArcIt nthIt(int n) const {
    1.72        return ArcIt(*this, n);
    1.73      }
    1.74 @@ -421,7 +421,7 @@
    1.75    /// \tparam GR The digraph type in which the path is.
    1.76    ///
    1.77    /// In a sense, the path can be treated as a list of arcs. The
    1.78 -  /// lemon path type stores just this list. As a consequence it
    1.79 +  /// LEMON path type stores just this list. As a consequence it
    1.80    /// cannot enumerate the nodes in the path and the zero length paths
    1.81    /// cannot store the source.
    1.82    ///
    1.83 @@ -543,9 +543,9 @@
    1.84        Node *node;
    1.85      };
    1.86  
    1.87 -    /// \brief The nth arc.
    1.88 +    /// \brief The n-th arc.
    1.89      ///
    1.90 -    /// This function looks for the nth arc in O(n) time.
    1.91 +    /// This function looks for the n-th arc in O(n) time.
    1.92      /// \pre \c n is in the <tt>[0..length() - 1]</tt> range.
    1.93      const Arc& nth(int n) const {
    1.94        Node *node = first;
    1.95 @@ -555,7 +555,7 @@
    1.96        return node->arc;
    1.97      }
    1.98  
    1.99 -    /// \brief Initializes arc iterator to point to the nth arc.
   1.100 +    /// \brief Initializes arc iterator to point to the n-th arc.
   1.101      ArcIt nthIt(int n) const {
   1.102        Node *node = first;
   1.103        for (int i = 0; i < n; ++i) {
   1.104 @@ -774,7 +774,7 @@
   1.105    /// \tparam GR The digraph type in which the path is.
   1.106    ///
   1.107    /// In a sense, the path can be treated as a list of arcs. The
   1.108 -  /// lemon path type stores just this list. As a consequence it
   1.109 +  /// LEMON path type stores just this list. As a consequence it
   1.110    /// cannot enumerate the nodes in the path and the source node of
   1.111    /// a zero length path is undefined.
   1.112    ///
   1.113 @@ -883,14 +883,14 @@
   1.114        int idx;
   1.115      };
   1.116  
   1.117 -    /// \brief The nth arc.
   1.118 +    /// \brief The n-th arc.
   1.119      ///
   1.120      /// \pre \c n is in the <tt>[0..length() - 1]</tt> range.
   1.121      const Arc& nth(int n) const {
   1.122        return arcs[n];
   1.123      }
   1.124  
   1.125 -    /// \brief The arc iterator pointing to the nth arc.
   1.126 +    /// \brief The arc iterator pointing to the n-th arc.
   1.127      ArcIt nthIt(int n) const {
   1.128        return ArcIt(*this, n);
   1.129      }
   1.130 @@ -1094,7 +1094,7 @@
   1.131    /// \brief Class which helps to iterate through the nodes of a path
   1.132    ///
   1.133    /// In a sense, the path can be treated as a list of arcs. The
   1.134 -  /// lemon path type stores only this list. As a consequence, it
   1.135 +  /// LEMON path type stores only this list. As a consequence, it
   1.136    /// cannot enumerate the nodes in the path and the zero length paths
   1.137    /// cannot have a source node.
   1.138    ///