LEMON/LEMON-main Changeset - r15:062f361aa520

Repositories » LEMON » LEMON-main

Summary
Changelog
Files
Switch To
- loading...
Options
- Lightweight changelog
- Search
Pull Requests

Changeset - r15:062f361aa520

« 14:8685ef

16:22696f »

r15:062f361aa520

Thu, 03 Jan 2008 01:08:23

[Not Reviewed]

0 comments (0 inline)

kpeter (Peter Kovacs)
kpeter@inf.elte.hu

Improved and fixed dim2.h. Improved and fixed documentation. Bug fix in BoundingBox<>::operator&. Removed \author tags.

0 1 0

default

1 file changed with 72 insertions and 52 deletions:

lemon/dim2.h

↑ Collapse diff ↑

lemon/dim2.h

Show inline comments

@@ -33,11 +33,8 @@
 		/// 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.
 		///
 		///\author Attila Bernath
 		namespace lemon {
 		  ///Tools for handling two dimensional coordinates
@@ -61,11 +58,11 @@
 		    public:
 		      typedef T Value;
-		      ///First co-ordinate
+		      ///First coordinate
 		      T x;
-		      ///Second co-ordinate
+		      ///Second coordinate
 		      T y;
 		      ///Default constructor
 		      Point() {}
@@ -74,10 +71,10 @@
 		      Point(T a, T b) : x(a), y(b) { }
 		      ///The dimension of the vector.
 		      ///This class give back always 2.
 		      ///
 		      ///The dimension of the vector.
 		      ///This function always returns 2.
 		      int size() const { return 2; }
 		      ///Subscripting operator
@@ -137,9 +134,9 @@
 		        Point<T> b=*this;
 		        return b+=u;
+		      }
-		      ///Return the neg of the vectors
+		      ///Return the negative of the vector
 		      Point<T> operator-() const {
 		        Point<T> b=*this;
 		        b.x=-b.x; b.y=-b.y;
 		        return b;
@@ -174,28 +171,28 @@
+		      }
 		    };
-		  ///Return an Point
+		  ///Return a Point
-		  ///Return an Point
+		  ///Return a Point.
 		  ///\relates Point
 		  template <typename T>
 		  inline Point<T> makePoint(const T& x, const T& y) {
 		    return Point<T>(x, y);
+		  }
 		  ///Return a vector multiplied by a scalar
 		  ///Return a vector multiplied by a scalar
+		  ///Return a vector multiplied by a scalar.
 		  ///\relates Point
 		  template<typename T> Point<T> operator*(const T &u,const Point<T> &x) {
 		    return x*u;
+		  }
 		  ///Read a plainvector from a stream
 		  ///Read a plainvector from a stream
+		  ///Read a plainvector from a stream.
 		  ///\relates Point
 		  ///
 		  template<typename T>
 		  inline std::istream& operator>>(std::istream &is, Point<T> &z) {
@@ -221,9 +218,9 @@
+		  }
 		  ///Write a plainvector to a stream
 		  ///Write a plainvector to a stream
+		  ///Write a plainvector to a stream.
 		  ///\relates Point
 		  ///
 		  template<typename T>
 		  inline std::ostream& operator<<(std::ostream &os, const Point<T>& z)
@@ -233,9 +230,9 @@
+		  }
 		  ///Rotate by 90 degrees
-		  ///Returns its parameter rotated by 90 degrees in positive direction.
+		  ///Returns the parameter rotated by 90 degrees in positive direction.
 		  ///\relates Point
 		  ///
 		  template<typename T>
 		  inline Point<T> rot90(const Point<T> &z)
@@ -244,9 +241,9 @@
+		  }
 		  ///Rotate by 180 degrees
-		  ///Returns its parameter rotated by 180 degrees.
+		  ///Returns the parameter rotated by 180 degrees.
 		  ///\relates Point
 		  ///
 		  template<typename T>
 		  inline Point<T> rot180(const Point<T> &z)
@@ -255,9 +252,9 @@
+		  }
 		  ///Rotate by 270 degrees
-		  ///Returns its parameter rotated by 90 degrees in negative direction.
+		  ///Returns the parameter rotated by 90 degrees in negative direction.
 		  ///\relates Point
 		  ///
 		  template<typename T>
 		  inline Point<T> rot270(const Point<T> &z)
@@ -270,9 +267,8 @@
 		  /// A class to calculate or store the bounding box of plainvectors.
 		  /// A class to calculate or store the bounding box of plainvectors.
 		  ///
 		  ///\author Attila Bernath
 		    template<typename T>
 		    class BoundingBox {
 		      Point<T> bottom_left, top_right;
 		      bool _empty;
@@ -285,11 +281,13 @@
 		      BoundingBox(Point<T> a) { bottom_left=top_right=a; _empty = false; }
 		      ///Construct an instance from two points
 		      ///Construct an instance from two points
 		      ///\warning The coordinates of the bottom-left corner must be no more
-		      ///than those of the top-right one
+		      ///Construct an instance from two points.
 		      ///\param a The bottom left corner.
 		      ///\param b The top right corner.
 		      ///\warning The coordinates of the bottom left corner must be no more
 		      ///than those of the top right one.
 		      BoundingBox(Point<T> a,Point<T> b)
+		      {
 			bottom_left=a;
 			top_right=b;
@@ -297,19 +295,28 @@
+		      }
 		      ///Construct an instance from four numbers
 		      ///Construct an instance from four numbers
 		      ///\warning The coordinates of the bottom-left corner must be no more
-		      ///than those of the top-right one
+		      ///Construct an instance from four numbers.
 		      ///\param l The left side of the box.
 		      ///\param b The bottom of the box.
 		      ///\param r The right side of the box.
 		      ///\param t The top of the box.
 		      ///\warning The left side must be no more than the right side and
 		      ///bottom must be no more than the top.
 		      BoundingBox(T l,T b,T r,T t)
+		      {
 			bottom_left=Point<T>(l,b);
 			top_right=Point<T>(r,t);
 			_empty = false;
+		      }
-		      ///Were any points added?
+		      ///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;
+		      }
@@ -328,9 +335,9 @@
 		      ///Set the bottom left corner
 		      ///Set the bottom left corner.
-		      ///It should only bee used for non-empty box.
+		      ///It should only be used for non-empty box.
 		      void bottomLeft(Point<T> p) {
 			bottom_left = p;
+		      }
@@ -344,9 +351,9 @@
 		      ///Set the top right corner
 		      ///Set the top right corner.
-		      ///It should only bee used for non-empty box.
+		      ///It should only be used for non-empty box.
 		      void topRight(Point<T> p) {
 			top_right = p;
+		      }
@@ -360,9 +367,9 @@
 		      ///Set the bottom right corner
 		      ///Set the bottom right corner.
-		      ///It should only bee used for non-empty 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;
+		      }
@@ -377,9 +384,9 @@
 		      ///Set the top left corner
 		      ///Set the top left corner.
-		      ///It should only bee used for non-empty 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;
+		      }
@@ -394,9 +401,9 @@
 		      ///Set the bottom of the box
 		      ///Set the bottom of the box.
-		      ///It should only bee used for non-empty box.
+		      ///It should only be used for non-empty box.
 		      void bottom(T t) {
 			bottom_left.y = t;
+		      }
@@ -410,9 +417,9 @@
 		      ///Set the top of the box
 		      ///Set the top of the box.
-		      ///It should only bee used for non-empty box.
+		      ///It should only be used for non-empty box.
 		      void top(T t) {
 			top_right.y = t;
+		      }
@@ -426,9 +433,9 @@
 		      ///Set the left side of the box
 		      ///Set the left side of the box.
-		      ///It should only bee used for non-empty box
+		      ///It should only be used for non-empty box.
 		      void left(T t) {
 			bottom_left.x = t;
+		      }
@@ -442,9 +449,9 @@
 		      ///Set the right side of the box
 		      ///Set the right side of the box.
-		      ///It should only bee used for non-empty box
+		      ///It should only be used for non-empty box.
 		      void right(T t) {
 			top_right.x = t;
+		      }
@@ -464,9 +471,9 @@
 		        return top_right.x-bottom_left.x;
+		      }
 		      ///Checks whether a point is inside a bounding box
 		      bool inside(const Point<T>& u){
+		      bool inside(const Point<T>& u) const {
 		        if (_empty)
 		          return false;
 		        else{
 		          return ((u.x-bottom_left.x)*(top_right.x-u.x) >= 0 &&
@@ -474,8 +481,11 @@
+		        }
+		      }
 		      ///Increments a bounding box with a point
 		      ///Increments a bounding box with a point.
 		      ///
 		      BoundingBox& add(const Point<T>& u){
 		        if (_empty){
 		          bottom_left=top_right=u;
 		          _empty = false;
@@ -488,9 +498,12 @@
+		        }
 		        return *this;
+		      }
 		      ///Increments a bounding to contain another bounding box
+		      ///Increments a bounding box to contain another bounding box
 		      ///Increments a bounding box to contain another bounding box.
 		      ///
 		      BoundingBox& add(const BoundingBox &u){
 		        if ( !u.empty() ){
 		          this->add(u.bottomLeft());
 			  this->add(u.topRight());
@@ -498,26 +511,33 @@
 		        return *this;
+		      }
 		      ///Intersection of two bounding boxes
-		      BoundingBox operator &(const BoundingBox& u){
 		      ///Intersection of two bounding boxes.
 		      ///
 		      BoundingBox operator&(const BoundingBox& u) const {
 		        BoundingBox b;
 			b.bottom_left.x=std::max(this->bottom_left.x,u.bottom_left.x);
 			b.bottom_left.y=std::max(this->bottom_left.y,u.bottom_left.y);
 			b.top_right.x=std::min(this->top_right.x,u.top_right.x);
 			b.top_right.y=std::min(this->top_right.y,u.top_right.y);
 			b._empty = this->_empty || u._empty ||
 			  b.bottom_left.x>top_right.x && b.bottom_left.y>top_right.y;
 		        if (this->_empty || u._empty) {
 			  b._empty = true;
 			} else {
 			  b.bottom_left.x = std::max(this->bottom_left.x,u.bottom_left.x);
 			  b.bottom_left.y = std::max(this->bottom_left.y,u.bottom_left.y);
 			  b.top_right.x = std::min(this->top_right.x,u.top_right.x);
 			  b.top_right.y = std::min(this->top_right.y,u.top_right.y);
 			  b._empty = b.bottom_left.x > b.top_right.x ||
 			             b.bottom_left.y > b.top_right.y;
+			}
 		        return b;
+		      }
 		    };//class Boundingbox
-		  ///Map of x-coordinates of a dim2::Point<>-map
+		  ///Map of x-coordinates of a \ref Point "Point"-map
 		  ///\ingroup maps
-		  ///Map of x-coordinates of a dim2::Point<>-map
+		  ///Map of x-coordinates of a \ref Point "Point"-map.
 		  ///
 		  template<class M>
 		  class XMap
+		  {
@@ -569,9 +589,9 @@
 		  };
 		  ///Returns a \ref ConstXMap class
-		  ///This function just returns an \ref ConstXMap class.
+		  ///This function just returns a \ref ConstXMap class.
 		  ///
 		  ///\ingroup maps
 		  ///\relates ConstXMap
 		  template<class M>
@@ -579,12 +599,12 @@
+		  {
 		    return ConstXMap<M>(m);
+		  }
-		  ///Map of y-coordinates of a dim2::Point<>-map
+		  ///Map of y-coordinates of a \ref Point "Point"-map
 		  ///\ingroup maps
-		  ///Map of y-coordinates of a dim2::Point<>-map
+		  ///Map of y-coordinates of a \ref Point "Point"-map.
 		  ///
 		  template<class M>
 		  class YMap
+		  {
@@ -598,11 +618,11 @@
 		    Value operator[](Key k) const {return _map[k].y;}
 		    void set(Key k,Value v) {_map.set(k,typename M::Value(_map[k].x,v));}
 		  };
-		  ///Returns an \ref YMap class
+		  ///Returns a \ref YMap class
-		  ///This function just returns an \ref YMap class.
+		  ///This function just returns a \ref YMap class.
 		  ///
 		  ///\ingroup maps
 		  ///\relates YMap
 		  template<class M>
@@ -636,9 +656,9 @@
 		  };
 		  ///Returns a \ref ConstYMap class
-		  ///This function just returns an \ref ConstYMap class.
+		  ///This function just returns a \ref ConstYMap class.
 		  ///
 		  ///\ingroup maps
 		  ///\relates ConstYMap
 		  template<class M>
@@ -648,12 +668,12 @@
+		  }
 		    ///\brief Map of the \ref Point::normSquare() "normSquare()"
-		    ///of an \ref Point "Point"-map
+		    ///of a \ref Point "Point"-map
 		    ///
 		    ///Map of the \ref Point::normSquare() "normSquare()"
-		    ///of an \ref Point "Point"-map
+		    ///of a \ref Point "Point"-map.
 		    ///\ingroup maps
 		    ///
 		  template<class M>
 		  class NormSquareMap
@@ -669,9 +689,9 @@
 		  };
 		  ///Returns a \ref NormSquareMap class
-		  ///This function just returns an \ref NormSquareMap class.
+		  ///This function just returns a \ref NormSquareMap class.
 		  ///
 		  ///\ingroup maps
 		  ///\relates NormSquareMap
 		  template<class M>

0 comments (0 inline)

RhodeCode

Login to your account