lemon-main: comparison lemon/dim2.h

equal deleted inserted replaced

-:41c9d131f25e
+:0ec0a16fabe7
 ///\ingroup misc
 ///\file
 ///\brief A simple two dimensional vector and a bounding box implementation
 ///
 /// The class \ref lemon::dim2::Point "dim2::Point" implements
-///a two dimensional vector with the usual
+/// a two dimensional vector with the usual operations.
-/// operations.
 ///
 /// The class \ref lemon::dim2::BoundingBox "dim2::BoundingBox"
 /// can be used to determine
 /// the rectangular bounding box of a set of
 /// \ref lemon::dim2::Point "dim2::Point"'s.
 /// @{
 /// A simple two dimensional vector (plainvector) implementation
 /// A simple two dimensional vector (plainvector) implementation
-///with the usual vector
+/// with the usual vector operations.
-/// operators.
-///
 template<typename T>
 class Point {
 public:
 Point() {}
 ///Construct an instance from coordinates
 Point(T a, T b) : x(a), y(b) { }
-///The dimension of the vector.
+///Returns the dimension of the vector (i.e. returns 2).
 ///The dimension of the vector.
 ///This function always returns 2.
 int size() const { return 2; }
 ///Give back the square of the norm of the vector
 T normSquare() const {
 return x*x+y*y;
 }
-///Increment the left hand side by u
+///Increment the left hand side by \c u
 Point<T>& operator +=(const Point<T>& u) {
 x += u.x;
 y += u.y;
 return *this;
 }
-///Decrement the left hand side by u
+///Decrement the left hand side by \c u
 Point<T>& operator -=(const Point<T>& u) {
 x -= u.x;
 y -= u.y;
 return *this;
 }
 ///Return \c true if the bounding box is empty.
 ///Return \c true if the bounding box is empty (i.e. return \c false
 ///if at least one point was added to the box or the coordinates of
 ///the box were set).
+///
 ///The coordinates of an empty bounding box are not defined.
 bool empty() const {
 return _empty;
 }
 ///Make the BoundingBox empty
 void clear() {
 _empty=1;
 }
-///Give back the bottom left corner
+///Give back the bottom left corner of the box
-///Give back the bottom left corner.
+///Give back the bottom left corner of the box.
 ///If the bounding box is empty, then the return value is not defined.
 Point<T> bottomLeft() const {
 return bottom_left;
 }
-///Set the bottom left corner
+///Set the bottom left corner of the box
-///Set the bottom left corner.
+///Set the bottom left corner of the box.
 ///It should only be used for non-empty box.
 void bottomLeft(Point<T> p) {
 	bottom_left = p;
 }
-///Give back the top right corner
+///Give back the top right corner of the box
-///Give back the top right corner.
+///Give back the top right corner of the box.
 ///If the bounding box is empty, then the return value is not defined.
 Point<T> topRight() const {
 return top_right;
 }
-///Set the top right corner
+///Set the top right corner of the box
-///Set the top right corner.
+///Set the top right corner of the box.
 ///It should only be used for non-empty box.
 void topRight(Point<T> p) {
 	top_right = p;
 }
-///Give back the bottom right corner
+///Give back the bottom right corner of the box
-///Give back the bottom right corner.
+///Give back the bottom right corner of the box.
 ///If the bounding box is empty, then the return value is not defined.
 Point<T> bottomRight() const {
 return Point<T>(top_right.x,bottom_left.y);
 }
-///Set the bottom right corner
+///Set the bottom right corner of the box
-///Set the bottom right corner.
+///Set the bottom right corner of the box.
 ///It should only be used for non-empty box.
 void bottomRight(Point<T> p) {
 	top_right.x = p.x;
 	bottom_left.y = p.y;
 }
-///Give back the top left corner
+///Give back the top left corner of the box
-///Give back the top left corner.
+///Give back the top left corner of the box.
 ///If the bounding box is empty, then the return value is not defined.
 Point<T> topLeft() const {
 return Point<T>(bottom_left.x,top_right.y);
 }
-///Set the top left corner
+///Set the top left corner of the box
-///Set the top left corner.
+///Set the top left corner of the box.
 ///It should only be used for non-empty box.
 void topLeft(Point<T> p) {
 	top_right.y = p.y;
 	bottom_left.x = p.x;
 }
 }
 };//class Boundingbox
-///Map of x-coordinates of a Point map
+///Map of x-coordinates of a \ref Point "Point"-map
 ///\ingroup maps
-///Map of x-coordinates of a \ref dim2::Point "Point"-map.
+///Map of x-coordinates of a \ref Point "Point"-map.
 ///
 template<class M>
 class XMap
 {
 M& _map;
 inline XMap<M> xMap(const M &m)
 {
 return XMap<M>(m);
 }
-///Constant (read only) version of XMap
+///Constant (read only) version of \ref XMap
 ///\ingroup maps
 ///Constant (read only) version of \ref XMap
 ///
 template<class M>
 inline ConstXMap<M> xMap(const M &m)
 {
 return ConstXMap<M>(m);
 }
-///Map of y-coordinates of a Point map
+///Map of y-coordinates of a \ref Point "Point"-map
 ///\ingroup maps
 ///Map of y-coordinates of a \ref Point "Point"-map.
 ///
 template<class M>
 inline YMap<M> yMap(const M &m)
 {
 return YMap<M>(m);
 }
-///Constant (read only) version of YMap
+///Constant (read only) version of \ref YMap
 ///\ingroup maps
 ///Constant (read only) version of \ref YMap
 ///
 template<class M>
 {
 return ConstYMap<M>(m);
 }
-///\brief Map of the normSquare()
+///\brief Map of the \ref Point::normSquare() "normSquare()"
-///of a Point map
+///of a \ref Point "Point"-map
 ///
 ///Map of the \ref Point::normSquare() "normSquare()"
 ///of a \ref Point "Point"-map.
 ///\ingroup maps
-///
 template<class M>
 class NormSquareMap
 {
 const M& _map;
 public:

changeset 203	215bfc30b14f
parent 42	3a98515e9bc3
child 209	765619b7cbb2