1.1 --- a/lemon/base.cc Mon Jan 07 19:44:18 2008 +0100
1.2 +++ b/lemon/base.cc Tue Jan 08 02:53:42 2008 +0100
1.3 @@ -17,7 +17,7 @@
1.4 */
1.5
1.6 ///\file
1.7 -///\brief Some basic non inline function and static global data.
1.8 +///\brief Some basic non-inline functions and static global data.
1.9
1.10 #include<lemon/tolerance.h>
1.11 #include<lemon/bits/invalid.h>
2.1 --- a/lemon/bits/invalid.h Mon Jan 07 19:44:18 2008 +0100
2.2 +++ b/lemon/bits/invalid.h Tue Jan 08 02:53:42 2008 +0100
2.3 @@ -26,6 +26,7 @@
2.4
2.5 /// \brief Dummy type to make it easier to create invalid iterators.
2.6 ///
2.7 + /// Dummy type to make it easier to create invalid iterators.
2.8 /// See \ref INVALID for the usage.
2.9 struct Invalid {
2.10 public:
3.1 --- a/lemon/dim2.h Mon Jan 07 19:44:18 2008 +0100
3.2 +++ b/lemon/dim2.h Tue Jan 08 02:53:42 2008 +0100
3.3 @@ -27,8 +27,7 @@
3.4 ///\brief A simple two dimensional vector and a bounding box implementation
3.5 ///
3.6 /// The class \ref lemon::dim2::Point "dim2::Point" implements
3.7 -///a two dimensional vector with the usual
3.8 -/// operations.
3.9 +/// a two dimensional vector with the usual operations.
3.10 ///
3.11 /// The class \ref lemon::dim2::BoundingBox "dim2::BoundingBox"
3.12 /// can be used to determine
3.13 @@ -49,9 +48,7 @@
3.14 /// A simple two dimensional vector (plainvector) implementation
3.15
3.16 /// A simple two dimensional vector (plainvector) implementation
3.17 - ///with the usual vector
3.18 - /// operators.
3.19 - ///
3.20 + /// with the usual vector operations.
3.21 template<typename T>
3.22 class Point {
3.23
3.24 @@ -70,7 +67,7 @@
3.25 ///Construct an instance from coordinates
3.26 Point(T a, T b) : x(a), y(b) { }
3.27
3.28 - ///The dimension of the vector.
3.29 + ///Returns the dimension of the vector (i.e. returns 2).
3.30
3.31 ///The dimension of the vector.
3.32 ///This function always returns 2.
3.33 @@ -96,14 +93,14 @@
3.34 return x*x+y*y;
3.35 }
3.36
3.37 - ///Increment the left hand side by u
3.38 + ///Increment the left hand side by \c u
3.39 Point<T>& operator +=(const Point<T>& u) {
3.40 x += u.x;
3.41 y += u.y;
3.42 return *this;
3.43 }
3.44
3.45 - ///Decrement the left hand side by u
3.46 + ///Decrement the left hand side by \c u
3.47 Point<T>& operator -=(const Point<T>& u) {
3.48 x -= u.x;
3.49 y -= u.y;
3.50 @@ -315,6 +312,7 @@
3.51 ///Return \c true if the bounding box is empty (i.e. return \c false
3.52 ///if at least one point was added to the box or the coordinates of
3.53 ///the box were set).
3.54 + ///
3.55 ///The coordinates of an empty bounding box are not defined.
3.56 bool empty() const {
3.57 return _empty;
3.58 @@ -325,66 +323,66 @@
3.59 _empty=1;
3.60 }
3.61
3.62 - ///Give back the bottom left corner
3.63 + ///Give back the bottom left corner of the box
3.64
3.65 - ///Give back the bottom left corner.
3.66 + ///Give back the bottom left corner of the box.
3.67 ///If the bounding box is empty, then the return value is not defined.
3.68 Point<T> bottomLeft() const {
3.69 return bottom_left;
3.70 }
3.71
3.72 - ///Set the bottom left corner
3.73 + ///Set the bottom left corner of the box
3.74
3.75 - ///Set the bottom left corner.
3.76 + ///Set the bottom left corner of the box.
3.77 ///It should only be used for non-empty box.
3.78 void bottomLeft(Point<T> p) {
3.79 bottom_left = p;
3.80 }
3.81
3.82 - ///Give back the top right corner
3.83 + ///Give back the top right corner of the box
3.84
3.85 - ///Give back the top right corner.
3.86 + ///Give back the top right corner of the box.
3.87 ///If the bounding box is empty, then the return value is not defined.
3.88 Point<T> topRight() const {
3.89 return top_right;
3.90 }
3.91
3.92 - ///Set the top right corner
3.93 + ///Set the top right corner of the box
3.94
3.95 - ///Set the top right corner.
3.96 + ///Set the top right corner of the box.
3.97 ///It should only be used for non-empty box.
3.98 void topRight(Point<T> p) {
3.99 top_right = p;
3.100 }
3.101
3.102 - ///Give back the bottom right corner
3.103 + ///Give back the bottom right corner of the box
3.104
3.105 - ///Give back the bottom right corner.
3.106 + ///Give back the bottom right corner of the box.
3.107 ///If the bounding box is empty, then the return value is not defined.
3.108 Point<T> bottomRight() const {
3.109 return Point<T>(top_right.x,bottom_left.y);
3.110 }
3.111
3.112 - ///Set the bottom right corner
3.113 + ///Set the bottom right corner of the box
3.114
3.115 - ///Set the bottom right corner.
3.116 + ///Set the bottom right corner of the box.
3.117 ///It should only be used for non-empty box.
3.118 void bottomRight(Point<T> p) {
3.119 top_right.x = p.x;
3.120 bottom_left.y = p.y;
3.121 }
3.122
3.123 - ///Give back the top left corner
3.124 + ///Give back the top left corner of the box
3.125
3.126 - ///Give back the top left corner.
3.127 + ///Give back the top left corner of the box.
3.128 ///If the bounding box is empty, then the return value is not defined.
3.129 Point<T> topLeft() const {
3.130 return Point<T>(bottom_left.x,top_right.y);
3.131 }
3.132
3.133 - ///Set the top left corner
3.134 + ///Set the top left corner of the box
3.135
3.136 - ///Set the top left corner.
3.137 + ///Set the top left corner of the box.
3.138 ///It should only be used for non-empty box.
3.139 void topLeft(Point<T> p) {
3.140 top_right.y = p.y;
3.141 @@ -533,10 +531,10 @@
3.142 };//class Boundingbox
3.143
3.144
3.145 - ///Map of x-coordinates of a Point map
3.146 + ///Map of x-coordinates of a \ref Point "Point"-map
3.147
3.148 ///\ingroup maps
3.149 - ///Map of x-coordinates of a \ref dim2::Point "Point"-map.
3.150 + ///Map of x-coordinates of a \ref Point "Point"-map.
3.151 ///
3.152 template<class M>
3.153 class XMap
3.154 @@ -570,7 +568,7 @@
3.155 return XMap<M>(m);
3.156 }
3.157
3.158 - ///Constant (read only) version of XMap
3.159 + ///Constant (read only) version of \ref XMap
3.160
3.161 ///\ingroup maps
3.162 ///Constant (read only) version of \ref XMap
3.163 @@ -600,7 +598,7 @@
3.164 return ConstXMap<M>(m);
3.165 }
3.166
3.167 - ///Map of y-coordinates of a Point map
3.168 + ///Map of y-coordinates of a \ref Point "Point"-map
3.169
3.170 ///\ingroup maps
3.171 ///Map of y-coordinates of a \ref Point "Point"-map.
3.172 @@ -637,7 +635,7 @@
3.173 return YMap<M>(m);
3.174 }
3.175
3.176 - ///Constant (read only) version of YMap
3.177 + ///Constant (read only) version of \ref YMap
3.178
3.179 ///\ingroup maps
3.180 ///Constant (read only) version of \ref YMap
3.181 @@ -668,13 +666,12 @@
3.182 }
3.183
3.184
3.185 - ///\brief Map of the normSquare()
3.186 - ///of a Point map
3.187 - ///
3.188 - ///Map of the \ref Point::normSquare() "normSquare()"
3.189 - ///of a \ref Point "Point"-map.
3.190 - ///\ingroup maps
3.191 - ///
3.192 + ///\brief Map of the \ref Point::normSquare() "normSquare()"
3.193 + ///of a \ref Point "Point"-map
3.194 + ///
3.195 + ///Map of the \ref Point::normSquare() "normSquare()"
3.196 + ///of a \ref Point "Point"-map.
3.197 + ///\ingroup maps
3.198 template<class M>
3.199 class NormSquareMap
3.200 {
4.1 --- a/lemon/random.h Mon Jan 07 19:44:18 2008 +0100
4.2 +++ b/lemon/random.h Tue Jan 08 02:53:42 2008 +0100
4.3 @@ -510,7 +510,7 @@
4.4 /// bool h = rnd.boolean(0.8); // P(h = true) = 0.8
4.5 ///\endcode
4.6 ///
4.7 - /// The lemon provides a global instance of the random number
4.8 + /// LEMON provides a global instance of the random number
4.9 /// generator which name is \ref lemon::rnd "rnd". Usually it is a
4.10 /// good programming convenience to use this global generator to get
4.11 /// random numbers.
4.12 @@ -526,12 +526,12 @@
4.13
4.14 public:
4.15
4.16 - /// \brief Constructor
4.17 + /// \brief Default constructor
4.18 ///
4.19 /// Constructor with constant seeding.
4.20 Random() { core.initState(); }
4.21
4.22 - /// \brief Constructor
4.23 + /// \brief Constructor with seed
4.24 ///
4.25 /// Constructor with seed. The current number type will be converted
4.26 /// to the architecture word type.
4.27 @@ -540,7 +540,7 @@
4.28 _random_bits::Initializer<Number, Word>::init(core, seed);
4.29 }
4.30
4.31 - /// \brief Constructor
4.32 + /// \brief Constructor with array seeding
4.33 ///
4.34 /// Constructor with array seeding. The given range should contain
4.35 /// any number type and the numbers will be converted to the
4.36 @@ -577,7 +577,7 @@
4.37 /// \brief Returns a random real number from the range [0, 1)
4.38 ///
4.39 /// It returns a random real number from the range [0, 1). The
4.40 - /// default Number type is double.
4.41 + /// default Number type is \c double.
4.42 template <typename Number>
4.43 Number real() {
4.44 return _random_bits::RealConversion<Number, Word>::convert(core);
4.45 @@ -653,8 +653,8 @@
4.46 /// \brief Returns a random non-negative integer
4.47 ///
4.48 /// It returns a random non-negative integer uniformly from the
4.49 - /// whole range of the current \c Number type. The default result
4.50 - /// type of this function is unsigned int.
4.51 + /// whole range of the current \c Number type. The default result
4.52 + /// type of this function is <tt>unsigned int</tt>.
4.53 template <typename Number>
4.54 Number uinteger() {
4.55 return _random_bits::IntConversion<Number, Word>::convert(core);
4.56 @@ -668,7 +668,7 @@
4.57 ///
4.58 /// It returns a random integer uniformly from the whole range of
4.59 /// the current \c Number type. The default result type of this
4.60 - /// function is int.
4.61 + /// function is \c int.
4.62 template <typename Number>
4.63 Number integer() {
4.64 static const int nb = std::numeric_limits<Number>::digits +
4.65 @@ -689,7 +689,7 @@
4.66 return bool_producer.convert(core);
4.67 }
4.68
4.69 - ///\name Nonuniform distributions
4.70 + ///\name Non-uniform distributions
4.71 ///
4.72
4.73 ///@{
5.1 --- a/lemon/tolerance.h Mon Jan 07 19:44:18 2008 +0100
5.2 +++ b/lemon/tolerance.h Tue Jan 08 02:53:42 2008 +0100
5.3 @@ -36,25 +36,21 @@
5.4 ///handle the comparison of numbers that are obtained
5.5 ///as a result of a probably inexact computation.
5.6 ///
5.7 - ///Tolerance is a class to provide a basic way to
5.8 + ///\ref Tolerance is a class to provide a basic way to
5.9 ///handle the comparison of numbers that are obtained
5.10 ///as a result of a probably inexact computation.
5.11 ///
5.12 ///This is an abstract class, it should be specialized for all numerical
5.13 - ///data types. These specialized classes like Tolerance<double>
5.14 + ///data types. These specialized classes like \ref Tolerance<double>
5.15 ///may offer additional tuning parameters.
5.16 ///
5.17 ///\sa Tolerance<float>
5.18 ///\sa Tolerance<double>
5.19 ///\sa Tolerance<long double>
5.20 ///\sa Tolerance<int>
5.21 -#if defined __GNUC__ && !defined __STRICT_ANSI__
5.22 ///\sa Tolerance<long long int>
5.23 -#endif
5.24 ///\sa Tolerance<unsigned int>
5.25 -#if defined __GNUC__ && !defined __STRICT_ANSI__
5.26 ///\sa Tolerance<unsigned long long int>
5.27 -#endif
5.28
5.29 template<class T>
5.30 class Tolerance
5.31 @@ -63,7 +59,7 @@
5.32 typedef T Value;
5.33
5.34 ///\name Comparisons
5.35 - ///The concept is that these bool functions return with \c true only if
5.36 + ///The concept is that these bool functions return \c true only if
5.37 ///the related comparisons hold even if some numerical error appeared
5.38 ///during the computations.
5.39
5.40 @@ -107,21 +103,21 @@
5.41
5.42 ///Constructor setting the epsilon tolerance to the default value.
5.43 Tolerance() : _epsilon(def_epsilon) {}
5.44 - ///Constructor setting the epsilon tolerance.
5.45 + ///Constructor setting the epsilon tolerance to the given value.
5.46 Tolerance(float e) : _epsilon(e) {}
5.47
5.48 - ///Return the epsilon value.
5.49 + ///Returns the epsilon value.
5.50 Value epsilon() const {return _epsilon;}
5.51 - ///Set the epsilon value.
5.52 + ///Sets the epsilon value.
5.53 void epsilon(Value e) {_epsilon=e;}
5.54
5.55 - ///Return the default epsilon value.
5.56 + ///Returns the default epsilon value.
5.57 static Value defaultEpsilon() {return def_epsilon;}
5.58 - ///Set the default epsilon value.
5.59 + ///Sets the default epsilon value.
5.60 static void defaultEpsilon(Value e) {def_epsilon=e;}
5.61
5.62 ///\name Comparisons
5.63 - ///See class Tolerance for more details.
5.64 + ///See \ref Tolerance for more details.
5.65
5.66 ///@{
5.67
5.68 @@ -158,21 +154,21 @@
5.69
5.70 ///Constructor setting the epsilon tolerance to the default value.
5.71 Tolerance() : _epsilon(def_epsilon) {}
5.72 - ///Constructor setting the epsilon tolerance.
5.73 + ///Constructor setting the epsilon tolerance to the given value.
5.74 Tolerance(double e) : _epsilon(e) {}
5.75
5.76 - ///Return the epsilon value.
5.77 + ///Returns the epsilon value.
5.78 Value epsilon() const {return _epsilon;}
5.79 - ///Set the epsilon value.
5.80 + ///Sets the epsilon value.
5.81 void epsilon(Value e) {_epsilon=e;}
5.82
5.83 - ///Return the default epsilon value.
5.84 + ///Returns the default epsilon value.
5.85 static Value defaultEpsilon() {return def_epsilon;}
5.86 - ///Set the default epsilon value.
5.87 + ///Sets the default epsilon value.
5.88 static void defaultEpsilon(Value e) {def_epsilon=e;}
5.89
5.90 ///\name Comparisons
5.91 - ///See class Tolerance for more details.
5.92 + ///See \ref Tolerance for more details.
5.93
5.94 ///@{
5.95
5.96 @@ -209,21 +205,21 @@
5.97
5.98 ///Constructor setting the epsilon tolerance to the default value.
5.99 Tolerance() : _epsilon(def_epsilon) {}
5.100 - ///Constructor setting the epsilon tolerance.
5.101 + ///Constructor setting the epsilon tolerance to the given value.
5.102 Tolerance(long double e) : _epsilon(e) {}
5.103
5.104 - ///Return the epsilon value.
5.105 + ///Returns the epsilon value.
5.106 Value epsilon() const {return _epsilon;}
5.107 - ///Set the epsilon value.
5.108 + ///Sets the epsilon value.
5.109 void epsilon(Value e) {_epsilon=e;}
5.110
5.111 - ///Return the default epsilon value.
5.112 + ///Returns the default epsilon value.
5.113 static Value defaultEpsilon() {return def_epsilon;}
5.114 - ///Set the default epsilon value.
5.115 + ///Sets the default epsilon value.
5.116 static void defaultEpsilon(Value e) {def_epsilon=e;}
5.117
5.118 ///\name Comparisons
5.119 - ///See class Tolerance for more details.
5.120 + ///See \ref Tolerance for more details.
5.121
5.122 ///@{
5.123
5.124 @@ -256,7 +252,7 @@
5.125 typedef int Value;
5.126
5.127 ///\name Comparisons
5.128 - ///See Tolerance for more details.
5.129 + ///See \ref Tolerance for more details.
5.130
5.131 ///@{
5.132
5.133 @@ -289,7 +285,7 @@
5.134 typedef unsigned int Value;
5.135
5.136 ///\name Comparisons
5.137 - ///See Tolerance for more details.
5.138 + ///See \ref Tolerance for more details.
5.139
5.140 ///@{
5.141
5.142 @@ -323,7 +319,7 @@
5.143 typedef long int Value;
5.144
5.145 ///\name Comparisons
5.146 - ///See Tolerance for more details.
5.147 + ///See \ref Tolerance for more details.
5.148
5.149 ///@{
5.150
5.151 @@ -356,7 +352,7 @@
5.152 typedef unsigned long int Value;
5.153
5.154 ///\name Comparisons
5.155 - ///See Tolerance for more details.
5.156 + ///See \ref Tolerance for more details.
5.157
5.158 ///@{
5.159