Changeset - r920:745312f9b441
« 919:e0cef6
922:9312d6 »
gravatar
kpeter (Peter Kovacs)
kpeter@inf.elte.hu
Improve the doc of path structures (#406)
0 1 0
default
1 file changed with 14 insertions and 14 deletions:
lemon/path.h
14
14
↑ Collapse diff ↑
lemon/path.h
Show white space 6 line context
... ... 
@@ -43,7 +43,7 @@
43 43 
  /// \tparam GR The digraph type in which the path is.
44 44 
  ///
45 45 
  /// In a sense, the path can be treated as a list of arcs. The
46 
  /// lemon path type stores just this list. As a consequence, it
46 
  /// LEMON path type stores just this list. As a consequence, it
47 47 
  /// cannot enumerate the nodes of the path and the source node of
48 48 
  /// a zero length path is undefined.
49 49 
  ///
... ... 
@@ -135,7 +135,7 @@
135 135 
    /// \brief Reset the path to an empty one.
136 136 
    void clear() { head.clear(); tail.clear(); }
137 137 

			




	138
	
	
		
    /// \brief The nth arc.


			




	
	138
	
		
    /// \brief The n-th arc.


			




	139
	139
	
		
    ///


			




	140
	140
	
		
    /// \pre \c n is in the <tt>[0..length() - 1]</tt> range.


			




	141
	141
	
		
    const Arc& nth(int n) const {


			




	...
	...
	
		
@@ -143,7 +143,7 @@


			




	143
	143
	
		
        *(tail.begin() + (n - head.size()));


			




	144
	144
	
		
    }


			




	145
	145
	
		

			




	146
	
	
		
    /// \brief Initialize arc iterator to point to the nth arc


			




	
	146
	
		
    /// \brief Initialize arc iterator to point to the n-th arc


			




	147
	147
	
		
    ///


			




	148
	148
	
		
    /// \pre \c n is in the <tt>[0..length() - 1]</tt> range.


			




	149
	149
	
		
    ArcIt nthIt(int n) const {


			




	...
	...
	
		
@@ -231,7 +231,7 @@


			




	231
	231
	
		
  /// \tparam GR The digraph type in which the path is.


			




	232
	232
	
		
  ///


			




	233
	233
	
		
  /// In a sense, the path can be treated as a list of arcs. The


			




	234
	
	
		
  /// lemon path type stores just this list. As a consequence it


			




	
	234
	
		
  /// LEMON path type stores just this list. As a consequence it


			




	235
	235
	
		
  /// cannot enumerate the nodes in the path and the zero length paths


			




	236
	236
	
		
  /// cannot store the source.


			




	237
	237
	
		
  ///


			




	...
	...
	
		
@@ -327,14 +327,14 @@


			




	327
	327
	
		
    /// \brief Reset the path to an empty one.


			




	328
	328
	
		
    void clear() { data.clear(); }


			




	329
	329
	
		

			




	330
	
	
		
    /// \brief The nth arc.


			




	
	330
	
		
    /// \brief The n-th arc.


			




	331
	331
	
		
    ///


			




	332
	332
	
		
    /// \pre \c n is in the <tt>[0..length() - 1]</tt> range.


			




	333
	333
	
		
    const Arc& nth(int n) const {


			




	334
	334
	
		
      return data[n];


			




	335
	335
	
		
    }


			




	336
	336
	
		

			




	337
	
	
		
    /// \brief  Initializes arc iterator to point to the nth arc.


			




	
	337
	
		
    /// \brief  Initializes arc iterator to point to the n-th arc.


			




	338
	338
	
		
    ArcIt nthIt(int n) const {


			




	339
	339
	
		
      return ArcIt(*this, n);


			




	340
	340
	
		
    }


			




	...
	...
	
		
@@ -395,7 +395,7 @@


			




	395
	395
	
		
  /// \tparam GR The digraph type in which the path is.


			




	396
	396
	
		
  ///


			




	397
	397
	
		
  /// In a sense, the path can be treated as a list of arcs. The


			




	398
	
	
		
  /// lemon path type stores just this list. As a consequence it


			




	
	398
	
		
  /// LEMON path type stores just this list. As a consequence it


			




	399
	399
	
		
  /// cannot enumerate the nodes in the path and the zero length paths


			




	400
	400
	
		
  /// cannot store the source.


			




	401
	401
	
		
  ///


			




	...
	...
	
		
@@ -504,9 +504,9 @@


			




	504
	504
	
		
      Node *node;


			




	505
	505
	
		
    };


			




	506
	506
	
		

			




	507
	
	
		
    /// \brief The nth arc.


			




	
	507
	
		
    /// \brief The n-th arc.


			




	508
	508
	
		
    ///


			




	509
	
	
		
    /// This function looks for the nth arc in O(n) time.


			




	
	509
	
		
    /// This function looks for the n-th arc in O(n) time.


			




	510
	510
	
		
    /// \pre \c n is in the <tt>[0..length() - 1]</tt> range.


			




	511
	511
	
		
    const Arc& nth(int n) const {


			




	512
	512
	
		
      Node *node = first;


			




	...
	...
	
		
@@ -516,7 +516,7 @@


			




	516
	516
	
		
      return node->arc;


			




	517
	517
	
		
    }


			




	518
	518
	
		

			




	519
	
	
		
    /// \brief Initializes arc iterator to point to the nth arc.


			




	
	519
	
		
    /// \brief Initializes arc iterator to point to the n-th arc.


			




	520
	520
	
		
    ArcIt nthIt(int n) const {


			




	521
	521
	
		
      Node *node = first;


			




	522
	522
	
		
      for (int i = 0; i < n; ++i) {


			




	...
	...
	
		
@@ -735,7 +735,7 @@


			




	735
	735
	
		
  /// \tparam GR The digraph type in which the path is.


			




	736
	736
	
		
  ///


			




	737
	737
	
		
  /// In a sense, the path can be treated as a list of arcs. The


			




	738
	
	
		
  /// lemon path type stores just this list. As a consequence it


			




	
	738
	
		
  /// LEMON path type stores just this list. As a consequence it


			




	739
	739
	
		
  /// cannot enumerate the nodes in the path and the source node of


			




	740
	740
	
		
  /// a zero length path is undefined.


			




	741
	741
	
		
  ///


			




	...
	...
	
		
@@ -831,14 +831,14 @@


			




	831
	831
	
		
      int idx;


			




	832
	832
	
		
    };


			




	833
	833
	
		

			




	834
	
	
		
    /// \brief The nth arc.


			




	
	834
	
		
    /// \brief The n-th arc.


			




	835
	835
	
		
    ///


			




	836
	836
	
		
    /// \pre \c n is in the <tt>[0..length() - 1]</tt> range.


			




	837
	837
	
		
    const Arc& nth(int n) const {


			




	838
	838
	
		
      return arcs[n];


			




	839
	839
	
		
    }


			




	840
	840
	
		

			




	841
	
	
		
    /// \brief The arc iterator pointing to the nth arc.


			




	
	841
	
		
    /// \brief The arc iterator pointing to the n-th arc.


			




	842
	842
	
		
    ArcIt nthIt(int n) const {


			




	843
	843
	
		
      return ArcIt(*this, n);


			




	844
	844
	
		
    }


			




	...
	...
	
		
@@ -1042,7 +1042,7 @@


			




	1042
	1042
	
		
  /// \brief Class which helps to iterate through the nodes of a path


			




	1043
	1043
	
		
  ///


			




	1044
	1044
	
		
  /// In a sense, the path can be treated as a list of arcs. The


			




	1045
	
	
		
  /// lemon path type stores only this list. As a consequence, it


			




	
	1045
	
		
  /// LEMON path type stores only this list. As a consequence, it


			




	1046
	1046
	
		
  /// cannot enumerate the nodes in the path and the zero length paths


			




	1047
	1047
	
		
  /// cannot have a source node.


			




	1048
	1048
	
		
  ///


			




        

    






    
    



    


    

     
    
0 comments (0 inline)