gravatar
kpeter (Peter Kovacs)
kpeter@inf.elte.hu
Using \tparam commands + removing \author commands (ticket #29, #39)
0 14 0
default
14 files changed with 47 insertions and 77 deletions:
↑ Collapse diff ↑
Show white space 16 line context
... ...
@@ -32,17 +32,17 @@
32 32

	
33 33
namespace lemon {
34 34

	
35 35

	
36 36
  
37 37
  ///Default traits class of Bfs class.
38 38

	
39 39
  ///Default traits class of Bfs class.
40
  ///\param GR Digraph type.
40
  ///\tparam GR Digraph type.
41 41
  template<class GR>
42 42
  struct BfsDefaultTraits
43 43
  {
44 44
    ///The digraph type the algorithm runs on. 
45 45
    typedef GR Digraph;
46 46
    ///\brief The type of the map that stores the last
47 47
    ///arcs of the shortest paths.
48 48
    /// 
... ...
@@ -110,26 +110,24 @@
110 110
    }
111 111
  };
112 112
  
113 113
  ///%BFS algorithm class.
114 114
  
115 115
  ///\ingroup search
116 116
  ///This class provides an efficient implementation of the %BFS algorithm.
117 117
  ///
118
  ///\param GR The digraph type the algorithm runs on. The default value is
118
  ///\tparam GR The digraph type the algorithm runs on. The default value is
119 119
  ///\ref ListDigraph. The value of GR is not used directly by Bfs, it
120 120
  ///is only passed to \ref BfsDefaultTraits.
121
  ///\param TR Traits class to set various data types used by the algorithm.
121
  ///\tparam TR Traits class to set various data types used by the algorithm.
122 122
  ///The default traits class is
123 123
  ///\ref BfsDefaultTraits "BfsDefaultTraits<GR>".
124 124
  ///See \ref BfsDefaultTraits for the documentation of
125 125
  ///a Bfs traits class.
126
  ///
127
  ///\author Alpar Juttner
128 126

	
129 127
#ifdef DOXYGEN
130 128
  template <typename GR,
131 129
	    typename TR>
132 130
#else
133 131
  template <typename GR=ListDigraph,
134 132
	    typename TR=BfsDefaultTraits<GR> >
135 133
#endif
... ...
@@ -751,17 +749,17 @@
751 749
    bool reached(Node v) { return (*_reached)[v]; }
752 750
    
753 751
    ///@}
754 752
  };
755 753

	
756 754
  ///Default traits class of Bfs function.
757 755

	
758 756
  ///Default traits class of Bfs function.
759
  ///\param GR Digraph type.
757
  ///\tparam GR Digraph type.
760 758
  template<class GR>
761 759
  struct BfsWizardDefaultTraits
762 760
  {
763 761
    ///The digraph type the algorithm runs on. 
764 762
    typedef GR Digraph;
765 763
    ///\brief The type of the map that stores the last
766 764
    ///arcs of the shortest paths.
767 765
    /// 
... ...
@@ -1160,17 +1158,17 @@
1160 1158
      _Visitor& visitor;
1161 1159
    };
1162 1160
  };
1163 1161
#endif
1164 1162

	
1165 1163
  /// \brief Default traits class of BfsVisit class.
1166 1164
  ///
1167 1165
  /// Default traits class of BfsVisit class.
1168
  /// \param _Digraph Digraph type.
1166
  /// \tparam _Digraph Digraph type.
1169 1167
  template<class _Digraph>
1170 1168
  struct BfsVisitDefaultTraits {
1171 1169

	
1172 1170
    /// \brief The digraph type the algorithm runs on. 
1173 1171
    typedef _Digraph Digraph;
1174 1172

	
1175 1173
    /// \brief The type of the map that indicates which nodes are reached.
1176 1174
    /// 
... ...
@@ -1196,30 +1194,28 @@
1196 1194
  ///  
1197 1195
  /// This class provides an efficient implementation of the %BFS algorithm
1198 1196
  /// with visitor interface.
1199 1197
  ///
1200 1198
  /// The %BfsVisit class provides an alternative interface to the Bfs
1201 1199
  /// class. It works with callback mechanism, the BfsVisit object calls
1202 1200
  /// on every bfs event the \c Visitor class member functions. 
1203 1201
  ///
1204
  /// \param _Digraph The digraph type the algorithm runs on. The default value is
1202
  /// \tparam _Digraph The digraph type the algorithm runs on. The default value is
1205 1203
  /// \ref ListDigraph. The value of _Digraph is not used directly by Bfs, it
1206 1204
  /// is only passed to \ref BfsDefaultTraits.
1207
  /// \param _Visitor The Visitor object for the algorithm. The 
1205
  /// \tparam _Visitor The Visitor object for the algorithm. The 
1208 1206
  /// \ref BfsVisitor "BfsVisitor<_Digraph>" is an empty Visitor which
1209 1207
  /// does not observe the Bfs events. If you want to observe the bfs
1210 1208
  /// events you should implement your own Visitor class.
1211
  /// \param _Traits Traits class to set various data types used by the 
1209
  /// \tparam _Traits Traits class to set various data types used by the 
1212 1210
  /// algorithm. The default traits class is
1213 1211
  /// \ref BfsVisitDefaultTraits "BfsVisitDefaultTraits<_Digraph>".
1214 1212
  /// See \ref BfsVisitDefaultTraits for the documentation of
1215 1213
  /// a Bfs visit traits class.
1216
  ///
1217
  /// \author Jacint Szabo, Alpar Juttner and Balazs Dezso
1218 1214
#ifdef DOXYGEN
1219 1215
  template <typename _Digraph, typename _Visitor, typename _Traits>
1220 1216
#else
1221 1217
  template <typename _Digraph = ListDigraph,
1222 1218
	    typename _Visitor = BfsVisitor<_Digraph>,
1223 1219
	    typename _Traits = BfsDefaultTraits<_Digraph> >
1224 1220
#endif
1225 1221
  class BfsVisit {
Show white space 16 line context
... ...
@@ -34,20 +34,20 @@
34 34
  ///\brief A Binary Heap implementation.
35 35
  ///
36 36
  ///This class implements the \e binary \e heap data structure. A \e heap
37 37
  ///is a data structure for storing items with specified values called \e
38 38
  ///priorities in such a way that finding the item with minimum priority is
39 39
  ///efficient. \c Compare specifies the ordering of the priorities. In a heap
40 40
  ///one can change the priority of an item, add or erase an item, etc.
41 41
  ///
42
  ///\param _Prio Type of the priority of the items.
43
  ///\param _ItemIntMap A read and writable Item int map, used internally
42
  ///\tparam _Prio Type of the priority of the items.
43
  ///\tparam _ItemIntMap A read and writable Item int map, used internally
44 44
  ///to handle the cross references.
45
  ///\param _Compare A class for the ordering of the priorities. The
45
  ///\tparam _Compare A class for the ordering of the priorities. The
46 46
  ///default is \c std::less<_Prio>.
47 47
  ///
48 48
  ///\sa FibHeap
49 49
  ///\sa Dijkstra
50 50
  template <typename _Prio, typename _ItemIntMap,
51 51
	    typename _Compare = std::less<_Prio> >
52 52
  class BinHeap {
53 53

	
Show white space 16 line context
... ...
@@ -89,18 +89,16 @@
89 89
  /// unreliable functionality. Because the alteration observing signals
90 90
  /// only erasing and adding but not the reversing it will stores bad
91 91
  /// degrees. The sub graph adaptors cannot signal the alterations because
92 92
  /// just a setting in the filter map can modify the graph and this cannot
93 93
  /// be watched in any way.
94 94
  ///
95 95
  /// \param _Container The container which is observed.
96 96
  /// \param _Item The item type which is obserbved.
97
  ///
98
  /// \author Balazs Dezso
99 97

	
100 98
  template <typename _Container, typename _Item>
101 99
  class AlterationNotifier {
102 100
  public:
103 101

	
104 102
    typedef True Notifier;
105 103

	
106 104
    typedef _Container Container;
... ...
@@ -125,18 +123,16 @@
125 123
    /// The observer interface contains some pure virtual functions
126 124
    /// to override. The add() and erase() functions are
127 125
    /// to notify the oberver when one item is added or
128 126
    /// erased.
129 127
    ///
130 128
    /// The build() and clear() members are to notify the observer
131 129
    /// about the container is built from an empty container or
132 130
    /// is cleared to an empty container. 
133
    /// 
134
    /// \author Balazs Dezso
135 131

	
136 132
    class ObserverBase {
137 133
    protected:
138 134
      typedef AlterationNotifier Notifier;
139 135

	
140 136
      friend class AlterationNotifier;
141 137

	
142 138
      /// \brief Default constructor.
Show white space 16 line context
... ...
@@ -19,18 +19,16 @@
19 19
#ifndef LEMON_BEZIER_H
20 20
#define LEMON_BEZIER_H
21 21

	
22 22
///\ingroup misc
23 23
///\file
24 24
///\brief Classes to compute with Bezier curves.
25 25
///
26 26
///Up to now this file is used internally by \ref graph_to_eps.h
27
///
28
///\author Alpar Juttner
29 27

	
30 28
#include<lemon/dim2.h>
31 29

	
32 30
namespace lemon {
33 31
  namespace dim2 {
34 32

	
35 33
class BezierBase {
36 34
public:
Show white space 16 line context
... ...
@@ -39,21 +39,20 @@
39 39
  /// \ingroup graphbits
40 40
  ///
41 41
  /// \brief Graph map based on the std::vector storage.
42 42
  ///
43 43
  /// The VectorMap template class is graph map structure what
44 44
  /// automatically updates the map when a key is added to or erased from
45 45
  /// the map. This map type uses the std::vector to store the values.
46 46
  ///
47
  /// \param Notifier The AlterationNotifier that will notify this map.
48
  /// \param Item The item type of the graph items.
49
  /// \param Value The value type of the map.
50
  /// 
51
  /// \author Balazs Dezso  	
47
  /// \tparam _Notifier The AlterationNotifier that will notify this map.
48
  /// \tparam _Item The item type of the graph items.
49
  /// \tparam _Value The value type of the map.
50
  /// \todo Fix the doc: there is _Graph parameter instead of _Notifier.
52 51
  template <typename _Graph, typename _Item, typename _Value>
53 52
  class VectorMap 
54 53
    : public ItemSetTraits<_Graph, _Item>::ItemNotifier::ObserverBase {
55 54
  private:
56 55
		
57 56
    /// The container type of the map.
58 57
    typedef std::vector<_Value> Container;	
59 58

	
Show white space 16 line context
... ...
@@ -22,18 +22,16 @@
22 22
#include<vector>
23 23
#include<lemon/math.h>
24 24
#include<lemon/maps.h>
25 25

	
26 26

	
27 27
///\ingroup misc
28 28
///\file
29 29
///\brief Tools to manage RGB colors.
30
///
31
///\author Alpar Juttner
32 30

	
33 31
namespace lemon {
34 32

	
35 33

	
36 34
  /// \addtogroup misc
37 35
  /// @{
38 36

	
39 37
  ///Data structure representing RGB colors.
Show white space 16 line context
... ...
@@ -35,17 +35,17 @@
35 35
    /// \addtogroup concept
36 36
    /// @{
37 37

	
38 38
    /// \brief A skeleton structure for representing directed paths in
39 39
    /// a digraph.
40 40
    ///
41 41
    /// A skeleton structure for representing directed paths in a
42 42
    /// digraph.  
43
    /// \param _Digraph The digraph type in which the path is.
43
    /// \tparam _Digraph 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 46
    /// lemon path type stores just this list. As a consequence it
47 47
    /// cannot enumerate the nodes in the path and the zero length
48 48
    /// paths cannot store the source.
49 49
    ///
50 50
    template <typename _Digraph>
51 51
    class Path {
... ...
@@ -200,17 +200,17 @@
200 200
    /// The main purpose of this concept is that the shortest path
201 201
    /// algorithms can enumerate easily the arcs in reverse order.
202 202
    /// If we would like to give back a real path from these
203 203
    /// algorithms then we should create a temporarly path object. In
204 204
    /// Lemon such algorithms gives back a path dumper what can
205 205
    /// assigned to a real path and the dumpers can be implemented as
206 206
    /// an adaptor class to the predecessor map.
207 207

	
208
    /// \param _Digraph  The digraph type in which the path is.
208
    /// \tparam _Digraph  The digraph type in which the path is.
209 209
    ///
210 210
    /// The paths can be constructed from any path type by a
211 211
    /// template constructor or a template assignment operator.
212 212
    /// 
213 213
    template <typename _Digraph>
214 214
    class PathDumper {
215 215
    public:
216 216

	
Show white space 16 line context
... ...
@@ -33,17 +33,17 @@
33 33
#include <lemon/concept_check.h>
34 34

	
35 35
namespace lemon {
36 36

	
37 37
  
38 38
  ///Default traits class of Dfs class.
39 39

	
40 40
  ///Default traits class of Dfs class.
41
  ///\param GR Digraph type.
41
  ///\tparam GR Digraph type.
42 42
  template<class GR>
43 43
  struct DfsDefaultTraits
44 44
  {
45 45
    ///The digraph type the algorithm runs on. 
46 46
    typedef GR Digraph;
47 47
    ///\brief The type of the map that stores the last
48 48
    ///arcs of the %DFS paths.
49 49
    /// 
... ...
@@ -112,26 +112,24 @@
112 112
    }
113 113
  };
114 114
  
115 115
  ///%DFS algorithm class.
116 116
  
117 117
  ///\ingroup search
118 118
  ///This class provides an efficient implementation of the %DFS algorithm.
119 119
  ///
120
  ///\param GR The digraph type the algorithm runs on. The default value is
120
  ///\tparam GR The digraph type the algorithm runs on. The default value is
121 121
  ///\ref ListDigraph. The value of GR is not used directly by Dfs, it
122 122
  ///is only passed to \ref DfsDefaultTraits.
123
  ///\param TR Traits class to set various data types used by the algorithm.
123
  ///\tparam TR Traits class to set various data types used by the algorithm.
124 124
  ///The default traits class is
125 125
  ///\ref DfsDefaultTraits "DfsDefaultTraits<GR>".
126 126
  ///See \ref DfsDefaultTraits for the documentation of
127 127
  ///a Dfs traits class.
128
  ///
129
  ///\author Jacint Szabo and Alpar Juttner
130 128
#ifdef DOXYGEN
131 129
  template <typename GR,
132 130
	    typename TR>
133 131
#else
134 132
  template <typename GR=ListDigraph,
135 133
	    typename TR=DfsDefaultTraits<GR> >
136 134
#endif
137 135
  class Dfs {
... ...
@@ -734,17 +732,17 @@
734 732
    bool reached(Node v) { return (*_reached)[v]; }
735 733
    
736 734
    ///@}
737 735
  };
738 736

	
739 737
  ///Default traits class of Dfs function.
740 738

	
741 739
  ///Default traits class of Dfs function.
742
  ///\param GR Digraph type.
740
  ///\tparam GR Digraph type.
743 741
  template<class GR>
744 742
  struct DfsWizardDefaultTraits
745 743
  {
746 744
    ///The digraph type the algorithm runs on. 
747 745
    typedef GR Digraph;
748 746
    ///\brief The type of the map that stores the last
749 747
    ///arcs of the %DFS paths.
750 748
    /// 
... ...
@@ -1155,17 +1153,17 @@
1155 1153
      _Visitor& visitor;
1156 1154
    };
1157 1155
  };
1158 1156
#endif
1159 1157

	
1160 1158
  /// \brief Default traits class of DfsVisit class.
1161 1159
  ///
1162 1160
  /// Default traits class of DfsVisit class.
1163
  /// \param _Digraph Digraph type.
1161
  /// \tparam _Digraph Digraph type.
1164 1162
  template<class _Digraph>
1165 1163
  struct DfsVisitDefaultTraits {
1166 1164

	
1167 1165
    /// \brief The digraph type the algorithm runs on. 
1168 1166
    typedef _Digraph Digraph;
1169 1167

	
1170 1168
    /// \brief The type of the map that indicates which nodes are reached.
1171 1169
    /// 
... ...
@@ -1190,24 +1188,24 @@
1190 1188
  /// \ingroup search
1191 1189
  /// This class provides an efficient implementation of the %DFS algorithm
1192 1190
  /// with visitor interface.
1193 1191
  ///
1194 1192
  /// The %DfsVisit class provides an alternative interface to the Dfs
1195 1193
  /// class. It works with callback mechanism, the DfsVisit object calls
1196 1194
  /// on every dfs event the \c Visitor class member functions. 
1197 1195
  ///
1198
  /// \param _Digraph The digraph type the algorithm runs on. The default value is
1196
  /// \tparam _Digraph The digraph type the algorithm runs on. The default value is
1199 1197
  /// \ref ListDigraph. The value of _Digraph is not used directly by Dfs, it
1200 1198
  /// is only passed to \ref DfsDefaultTraits.
1201
  /// \param _Visitor The Visitor object for the algorithm. The 
1199
  /// \tparam _Visitor The Visitor object for the algorithm. The 
1202 1200
  /// \ref DfsVisitor "DfsVisitor<_Digraph>" is an empty Visitor which
1203 1201
  /// does not observe the Dfs events. If you want to observe the dfs
1204 1202
  /// events you should implement your own Visitor class.
1205
  /// \param _Traits Traits class to set various data types used by the 
1203
  /// \tparam _Traits Traits class to set various data types used by the 
1206 1204
  /// algorithm. The default traits class is
1207 1205
  /// \ref DfsVisitDefaultTraits "DfsVisitDefaultTraits<_Digraph>".
1208 1206
  /// See \ref DfsVisitDefaultTraits for the documentation of
1209 1207
  /// a Dfs visit traits class.
1210 1208
  ///
1211 1209
  /// \author Jacint Szabo, Alpar Juttner and Balazs Dezso
1212 1210
#ifdef DOXYGEN
1213 1211
  template <typename _Digraph, typename _Visitor, typename _Traits>
Show white space 16 line context
... ...
@@ -72,18 +72,18 @@
72 72
    static bool less(const Value& left, const Value& right) {
73 73
      return left < right;
74 74
    }
75 75
  };
76 76
  
77 77
  ///Default traits class of Dijkstra class.
78 78

	
79 79
  ///Default traits class of Dijkstra class.
80
  ///\param GR Digraph type.
81
  ///\param LM Type of length map.
80
  ///\tparam GR Digraph type.
81
  ///\tparam LM Type of length map.
82 82
  template<class GR, class LM>
83 83
  struct DijkstraDefaultTraits
84 84
  {
85 85
    ///The digraph type the algorithm runs on. 
86 86
    typedef GR Digraph;
87 87
    ///The type of the map that stores the arc lengths.
88 88

	
89 89
    ///The type of the map that stores the arc lengths.
... ...
@@ -189,33 +189,32 @@
189 189
  ///\ref concepts::ReadMap "ReadMap",
190 190
  ///so it is easy to change it to any kind of length.
191 191
  ///
192 192
  ///The type of the length is determined by the
193 193
  ///\ref concepts::ReadMap::Value "Value" of the length map.
194 194
  ///
195 195
  ///It is also possible to change the underlying priority heap.
196 196
  ///
197
  ///\param GR The digraph type the algorithm runs on. The default value
197
  ///\tparam GR The digraph type the algorithm runs on. The default value
198 198
  ///is \ref ListDigraph. The value of GR is not used directly by
199 199
  ///Dijkstra, it is only passed to \ref DijkstraDefaultTraits.
200
  ///\param LM This read-only ArcMap determines the lengths of the
200
  ///\tparam LM This read-only ArcMap determines the lengths of the
201 201
  ///arcs. It is read once for each arc, so the map may involve in
202 202
  ///relatively time consuming process to compute the arc length if
203 203
  ///it is necessary. The default map type is \ref
204 204
  ///concepts::Digraph::ArcMap "Digraph::ArcMap<int>".  The value
205 205
  ///of LM is not used directly by Dijkstra, it is only passed to \ref
206
  ///DijkstraDefaultTraits.  \param TR Traits class to set
206
  ///DijkstraDefaultTraits.  
207
  ///\tparam TR Traits class to set
207 208
  ///various data types used by the algorithm.  The default traits
208 209
  ///class is \ref DijkstraDefaultTraits
209 210
  ///"DijkstraDefaultTraits<GR,LM>".  See \ref
210 211
  ///DijkstraDefaultTraits for the documentation of a Dijkstra traits
211 212
  ///class.
212
  ///
213
  ///\author Jacint Szabo and Alpar Juttner
214 213

	
215 214
#ifdef DOXYGEN
216 215
  template <typename GR, typename LM, typename TR>
217 216
#else
218 217
  template <typename GR=ListDigraph,
219 218
	    typename LM=typename GR::template ArcMap<int>,
220 219
	    typename TR=DijkstraDefaultTraits<GR,LM> >
221 220
#endif
... ...
@@ -870,18 +869,18 @@
870 869

	
871 870

	
872 871

	
873 872

	
874 873
 
875 874
  ///Default traits class of Dijkstra function.
876 875

	
877 876
  ///Default traits class of Dijkstra function.
878
  ///\param GR Digraph type.
879
  ///\param LM Type of length map.
877
  ///\tparam GR Digraph type.
878
  ///\tparam LM Type of length map.
880 879
  template<class GR, class LM>
881 880
  struct DijkstraWizardDefaultTraits
882 881
  {
883 882
    ///The digraph type the algorithm runs on. 
884 883
    typedef GR Digraph;
885 884
    ///The type of the map that stores the arc lengths.
886 885

	
887 886
    ///The type of the map that stores the arc lengths.
Show white space 16 line context
... ...
@@ -411,17 +411,17 @@
411 411
  }
412 412
  template<class X> struct ArcWidthsTraits : public T {
413 413
    const X &_arcWidths;
414 414
    ArcWidthsTraits(const T &t,const X &x) : T(t), _arcWidths(x) {}
415 415
  };
416 416
  ///Sets the map of the arc widths
417 417

	
418 418
  ///Sets the map of the arc widths
419
  ///\param x must be a arc map with \c double (or convertible) values. 
419
  ///\param x must be an arc map with \c double (or convertible) values. 
420 420
  template<class X> GraphToEps<ArcWidthsTraits<X> > arcWidths(const X &x)
421 421
  {
422 422
    dontPrint=true;
423 423
    return GraphToEps<ArcWidthsTraits<X> >(ArcWidthsTraits<X>(*this,x));
424 424
  }
425 425

	
426 426
  template<class X> struct NodeColorsTraits : public T {
427 427
    const X &_nodeColors;
... ...
@@ -459,17 +459,17 @@
459 459
  }
460 460
  template<class X> struct ArcColorsTraits : public T {
461 461
    const X &_arcColors;
462 462
    ArcColorsTraits(const T &t,const X &x) : T(t), _arcColors(x) {}
463 463
  };
464 464
  ///Sets the map of the arc colors
465 465

	
466 466
  ///Sets the map of the arc colors
467
  ///\param x must be a arc map with \ref Color values. 
467
  ///\param x must be an arc map with \ref Color values. 
468 468
  ///
469 469
  ///\sa Palette
470 470
  template<class X> GraphToEps<ArcColorsTraits<X> >
471 471
  arcColors(const X &x)
472 472
  {
473 473
    dontPrint=true;
474 474
    return GraphToEps<ArcColorsTraits<X> >(ArcColorsTraits<X>(*this,x));
475 475
  }
Show white space 16 line context
... ...
@@ -349,18 +349,16 @@
349 349
  ///   ...
350 350
  /// }
351 351
  ///\endcode
352 352
  /// 
353 353
  ///\sa findArc()
354 354
  ///\sa ArcLookUp
355 355
  ///\sa AllArcLookUp
356 356
  ///\sa DynArcLookUp
357
  ///
358
  /// \author Balazs Dezso 
359 357
  template <typename _Graph>
360 358
  class ConArcIt : public _Graph::Arc {
361 359
  public:
362 360

	
363 361
    typedef _Graph Graph;
364 362
    typedef typename Graph::Arc Parent;
365 363

	
366 364
    typedef typename Graph::Arc Arc;
... ...
@@ -473,18 +471,16 @@
473 471
  /// use it the following way:
474 472
  ///\code
475 473
  /// for (ConEdgeIt<Graph> it(g, src, trg); it != INVALID; ++it) {
476 474
  ///   ...
477 475
  /// }
478 476
  ///\endcode
479 477
  ///
480 478
  ///\sa findEdge()
481
  ///
482
  /// \author Balazs Dezso 
483 479
  template <typename _Graph>
484 480
  class ConEdgeIt : public _Graph::Edge {
485 481
  public:
486 482

	
487 483
    typedef _Graph Graph;
488 484
    typedef typename Graph::Edge Parent;
489 485

	
490 486
    typedef typename Graph::Edge Edge;
... ...
@@ -1237,19 +1233,19 @@
1237 1233
  /// This type provides simple invertable graph-maps. 
1238 1234
  /// The InvertableMap wraps an arbitrary ReadWriteMap 
1239 1235
  /// and if a key is set to a new value then store it
1240 1236
  /// in the inverse map.
1241 1237
  ///
1242 1238
  /// The values of the map can be accessed
1243 1239
  /// with stl compatible forward iterator.
1244 1240
  ///
1245
  /// \param _Graph The graph type.
1246
  /// \param _Item The item type of the graph.
1247
  /// \param _Value The value type of the map.
1241
  /// \tparam _Graph The graph type.
1242
  /// \tparam _Item The item type of the graph.
1243
  /// \tparam _Value The value type of the map.
1248 1244
  ///
1249 1245
  /// \see IterableValueMap
1250 1246
  template <typename _Graph, typename _Item, typename _Value>
1251 1247
  class InvertableMap : protected DefaultMap<_Graph, _Item, _Value> {
1252 1248
  private:
1253 1249
    
1254 1250
    typedef DefaultMap<_Graph, _Item, _Value> Map;
1255 1251
    typedef _Graph Graph;
... ...
@@ -1442,18 +1438,18 @@
1442 1438
  /// descriptor (id) for each item of the same type (e.g. node) in the
1443 1439
  /// graph. This id is <ul><li>\b unique: different items (nodes) get
1444 1440
  /// different ids <li>\b continuous: the range of the ids is the set of
1445 1441
  /// integers between 0 and \c n-1, where \c n is the number of the items of
1446 1442
  /// this type (e.g. nodes) (so the id of a node can change if you delete an
1447 1443
  /// other node, i.e. this id is mutable).  </ul> This map can be inverted
1448 1444
  /// with its member class \c InverseMap, or with the \c operator() member.
1449 1445
  ///
1450
  /// \param _Graph The graph class the \c DescriptorMap belongs to.
1451
  /// \param _Item The Item is the Key of the Map. It may be Node, Arc or 
1446
  /// \tparam _Graph The graph class the \c DescriptorMap belongs to.
1447
  /// \tparam _Item The Item is the Key of the Map. It may be Node, Arc or 
1452 1448
  /// Edge.
1453 1449
  template <typename _Graph, typename _Item>
1454 1450
  class DescriptorMap : protected DefaultMap<_Graph, _Item, int> {
1455 1451

	
1456 1452
    typedef _Item Item;
1457 1453
    typedef DefaultMap<_Graph, _Item, int> Map;
1458 1454

	
1459 1455
  public:
... ...
@@ -1632,17 +1628,16 @@
1632 1628
      return InverseMap(*this);
1633 1629
    }
1634 1630
  };
1635 1631

	
1636 1632
  /// \brief Returns the source of the given arc.
1637 1633
  ///
1638 1634
  /// The SourceMap gives back the source Node of the given arc. 
1639 1635
  /// \see TargetMap
1640
  /// \author Balazs Dezso
1641 1636
  template <typename Digraph>
1642 1637
  class SourceMap {
1643 1638
  public:
1644 1639

	
1645 1640
    typedef typename Digraph::Node Value;
1646 1641
    typedef typename Digraph::Arc Key;
1647 1642

	
1648 1643
    /// \brief Constructor
... ...
@@ -1672,17 +1667,16 @@
1672 1667
  inline SourceMap<Digraph> sourceMap(const Digraph& digraph) {
1673 1668
    return SourceMap<Digraph>(digraph);
1674 1669
  } 
1675 1670

	
1676 1671
  /// \brief Returns the target of the given arc.
1677 1672
  ///
1678 1673
  /// The TargetMap gives back the target Node of the given arc. 
1679 1674
  /// \see SourceMap
1680
  /// \author Balazs Dezso
1681 1675
  template <typename Digraph>
1682 1676
  class TargetMap {
1683 1677
  public:
1684 1678

	
1685 1679
    typedef typename Digraph::Node Value;
1686 1680
    typedef typename Digraph::Arc Key;
1687 1681

	
1688 1682
    /// \brief Constructor
... ...
@@ -1712,17 +1706,16 @@
1712 1706
  inline TargetMap<Digraph> targetMap(const Digraph& digraph) {
1713 1707
    return TargetMap<Digraph>(digraph);
1714 1708
  }
1715 1709

	
1716 1710
  /// \brief Returns the "forward" directed arc view of an edge.
1717 1711
  ///
1718 1712
  /// Returns the "forward" directed arc view of an edge.
1719 1713
  /// \see BackwardMap
1720
  /// \author Balazs Dezso
1721 1714
  template <typename Graph>
1722 1715
  class ForwardMap {
1723 1716
  public:
1724 1717

	
1725 1718
    typedef typename Graph::Arc Value;
1726 1719
    typedef typename Graph::Edge Key;
1727 1720

	
1728 1721
    /// \brief Constructor
... ...
@@ -1752,17 +1745,16 @@
1752 1745
  inline ForwardMap<Graph> forwardMap(const Graph& graph) {
1753 1746
    return ForwardMap<Graph>(graph);
1754 1747
  }
1755 1748

	
1756 1749
  /// \brief Returns the "backward" directed arc view of an edge.
1757 1750
  ///
1758 1751
  /// Returns the "backward" directed arc view of an edge.
1759 1752
  /// \see ForwardMap
1760
  /// \author Balazs Dezso
1761 1753
  template <typename Graph>
1762 1754
  class BackwardMap {
1763 1755
  public:
1764 1756

	
1765 1757
    typedef typename Graph::Arc Value;
1766 1758
    typedef typename Graph::Edge Key;
1767 1759

	
1768 1760
    /// \brief Constructor
... ...
@@ -2091,17 +2083,17 @@
2091 2083
  ///digraph is not changed so frequently.
2092 2084
  ///
2093 2085
  ///This class uses a self-adjusting binary search tree, Sleator's
2094 2086
  ///and Tarjan's Splay tree for guarantee the logarithmic amortized
2095 2087
  ///time bound for arc lookups. This class also guarantees the
2096 2088
  ///optimal time bound in a constant factor for any distribution of
2097 2089
  ///queries.
2098 2090
  ///
2099
  ///\param G The type of the underlying digraph.  
2091
  ///\tparam G The type of the underlying digraph.  
2100 2092
  ///
2101 2093
  ///\sa ArcLookUp  
2102 2094
  ///\sa AllArcLookUp  
2103 2095
  template<class G>
2104 2096
  class DynArcLookUp 
2105 2097
    : protected ItemSetTraits<G, typename G::Arc>::ItemNotifier::ObserverBase
2106 2098
  {
2107 2099
  public:
... ...
@@ -2532,17 +2524,17 @@
2532 2524
  ///It is not possible to find \e all parallel arcs between two nodes.
2533 2525
  ///Use \ref AllArcLookUp for this purpose.
2534 2526
  ///
2535 2527
  ///\warning This class is static, so you should refresh() (or at least
2536 2528
  ///refresh(Node)) this data structure
2537 2529
  ///whenever the digraph changes. This is a time consuming (superlinearly
2538 2530
  ///proportional (<em>O(m</em>log<em>m)</em>) to the number of arcs).
2539 2531
  ///
2540
  ///\param G The type of the underlying digraph.
2532
  ///\tparam G The type of the underlying digraph.
2541 2533
  ///
2542 2534
  ///\sa DynArcLookUp
2543 2535
  ///\sa AllArcLookUp  
2544 2536
  template<class G>
2545 2537
  class ArcLookUp 
2546 2538
  {
2547 2539
  public:
2548 2540
    TEMPLATE_DIGRAPH_TYPEDEFS(G);
... ...
@@ -2645,17 +2637,17 @@
2645 2637
  ///This class is the same as \ref ArcLookUp, with the addition
2646 2638
  ///that it makes it possible to find all arcs between given endpoints.
2647 2639
  ///
2648 2640
  ///\warning This class is static, so you should refresh() (or at least
2649 2641
  ///refresh(Node)) this data structure
2650 2642
  ///whenever the digraph changes. This is a time consuming (superlinearly
2651 2643
  ///proportional (<em>O(m</em>log<em>m)</em>) to the number of arcs).
2652 2644
  ///
2653
  ///\param G The type of the underlying digraph.
2645
  ///\tparam G The type of the underlying digraph.
2654 2646
  ///
2655 2647
  ///\sa DynArcLookUp
2656 2648
  ///\sa ArcLookUp  
2657 2649
  template<class G>
2658 2650
  class AllArcLookUp : public ArcLookUp<G>
2659 2651
  {
2660 2652
    using ArcLookUp<G>::_g;
2661 2653
    using ArcLookUp<G>::_right;
Show white space 16 line context
... ...
@@ -35,17 +35,17 @@
35 35

	
36 36
  /// \addtogroup paths
37 37
  /// @{
38 38

	
39 39

	
40 40
  /// \brief A structure for representing directed paths in a digraph.
41 41
  ///
42 42
  /// A structure for representing directed path in a digraph.
43
  /// \param Digraph The digraph type in which the path is.
43
  /// \tparam _Digraph 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 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
  ///
50 50
  /// This implementation is a back and front insertable and erasable
51 51
  /// path type. It can be indexed in O(1) time. The front and back
... ...
@@ -223,17 +223,17 @@
223 223
    typedef std::vector<Arc> Container;
224 224
    Container head, tail;
225 225

	
226 226
  };
227 227

	
228 228
  /// \brief A structure for representing directed paths in a digraph.
229 229
  ///
230 230
  /// A structure for representing directed path in a digraph.
231
  /// \param Digraph The digraph type in which the path is.
231
  /// \tparam _Digraph 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 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
  ///
238 238
  /// This implementation is a just back insertable and erasable path
239 239
  /// type. It can be indexed in O(1) time. The back insertion and
... ...
@@ -387,17 +387,17 @@
387 387
    typedef std::vector<Arc> Container;
388 388
    Container data;
389 389

	
390 390
  };
391 391

	
392 392
  /// \brief A structure for representing directed paths in a digraph.
393 393
  ///
394 394
  /// A structure for representing directed path in a digraph.
395
  /// \param Digraph The digraph type in which the path is.
395
  /// \tparam _Digraph 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 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
  ///
402 402
  /// This implementation is a back and front insertable and erasable
403 403
  /// path type. It can be indexed in O(k) time, where k is the rank
... ...
@@ -727,17 +727,17 @@
727 727
      }
728 728
    }
729 729

	
730 730
  };
731 731

	
732 732
  /// \brief A structure for representing directed paths in a digraph.
733 733
  ///
734 734
  /// A structure for representing directed path in a digraph.
735
  /// \param Digraph The digraph type in which the path is.
735
  /// \tparam _Digraph 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 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
  ///
742 742
  /// This implementation is completly static, i.e. it can be copy constucted
743 743
  /// or copy assigned from another path, but otherwise it cannot be
Show white space 16 line context
... ...
@@ -197,18 +197,16 @@
197 197
  ///It is also quite memory efficient, but at the price
198 198
  ///that <b> it does support only limited (only stack-like)
199 199
  ///node and arc deletions</b>.
200 200
  ///It conforms to the \ref concepts::Digraph "Digraph concept" with
201 201
  ///an important extra feature that its maps are real \ref
202 202
  ///concepts::ReferenceMap "reference map"s.
203 203
  ///
204 204
  ///\sa concepts::Digraph.
205
  ///
206
  ///\author Alpar Juttner
207 205
  class SmartDigraph : public ExtendedSmartDigraphBase {
208 206
  public:
209 207

	
210 208
    typedef ExtendedSmartDigraphBase Parent;
211 209

	
212 210
  private:
213 211

	
214 212
    ///SmartDigraph is \e not copy constructible. Use DigraphCopy() instead.
Show white space 16 line context
... ...
@@ -51,18 +51,16 @@
51 51
  /// - a user cpu time of children
52 52
  /// - a system cpu time of children
53 53
  ///
54 54
  /// TimeStamp's can be added to or substracted from each other and
55 55
  /// they can be pushed to a stream.
56 56
  ///
57 57
  /// In most cases, perhaps the \ref Timer or the \ref TimeReport
58 58
  /// class is what you want to use instead.
59
  ///
60
  ///\author Alpar Juttner
61 59

	
62 60
  class TimeStamp
63 61
  {
64 62
    double utime;
65 63
    double stime;
66 64
    double cutime;
67 65
    double cstime;
68 66
    double rtime;
... ...
@@ -291,18 +289,16 @@
291 289
  ///Also, if you start and stop the timer very frequently, it could lead to
292 290
  ///distorted results.
293 291
  ///
294 292
  ///\note If you want to measure the running time of the execution of a certain
295 293
  ///function, consider the usage of \ref TimeReport instead.
296 294
  ///
297 295
  ///\todo This shouldn't be Unix (Linux) specific.
298 296
  ///\sa TimeReport
299
  ///
300
  ///\author Alpar Juttner
301 297
  class Timer
302 298
  {
303 299
    int _running; //Timer is running iff _running>0; (_running>=0 always holds)
304 300
    TimeStamp start_time; //This is the relativ start-time if the timer
305 301
                          //is _running, the collected _running time otherwise.
306 302
    
307 303
    void _reset() {if(_running) start_time.stamp(); else start_time.reset();}
308 304
  
0 comments (0 inline)