lemon-1.0: comparison lemon/dim2.h

equal deleted inserted replaced

-:dd9c19843b40
+:6f3cb84bd930
 ///\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 operations.
 ///
-/// The class \ref lemon::dim2::BoundingBox "dim2::BoundingBox"
+/// The class \ref lemon::dim2::Box "dim2::Box" can be used to determine
-/// can be used to determine
 /// the rectangular bounding box of a set of
 /// \ref lemon::dim2::Point "dim2::Point"'s.
 namespace lemon {
 namespace dim2 {
 /// \addtogroup misc
 /// @{
-/// A simple two dimensional vector (plain vector) implementation
+/// Two dimensional vector (plain vector)
 /// A simple two dimensional vector (plain vector) implementation
 /// with the usual vector operations.
 template<typename T>
 class Point {
 return Point<T>(z.y,-z.x);
 }
-/// A class to calculate or store the bounding box of plain vectors.
+/// Bounding box of plain vectors (\ref Point points).
-/// A class to calculate or store the bounding box of plain vectors.
+/// A class to calculate or store the bounding box of plain vectors
-///
+/// (\ref Point points).
 template<typename T>
-class BoundingBox {
+class Box {
 Point<T> _bottom_left, _top_right;
 bool _empty;
 public:
-///Default constructor: creates an empty bounding box
+///Default constructor: creates an empty box
-BoundingBox() { _empty = true; }
+Box() { _empty = true; }
-///Construct an instance from one point
+///Construct a box from one point
-BoundingBox(Point<T> a) {
+Box(Point<T> a) {
 _bottom_left = _top_right = a;
 _empty = false;
 }
-///Construct an instance from two points
+///Construct a box from two points
-///Construct an instance from two points.
+///Construct a box 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)
+Box(Point<T> a,Point<T> b)
 {
 _bottom_left = a;
 _top_right = b;
 _empty = false;
 }
-///Construct an instance from four numbers
+///Construct a box from four numbers
-///Construct an instance from four numbers.
+///Construct a box 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)
+Box(T l,T b,T r,T t)
 {
 _bottom_left=Point<T>(l,b);
 _top_right=Point<T>(r,t);
 _empty = false;
 }
-///Return \c true if the bounding box is empty.
+///Return \c true if the box is empty.
-///Return \c true if the bounding box is empty (i.e. return \c false
+///Return \c true if the 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.
+///The coordinates of an empty box are not defined.
 bool empty() const {
 return _empty;
 }
-///Make the BoundingBox empty
+///Make the box empty
 void clear() {
 _empty = true;
 }
 ///Give back the bottom left corner of the box
 ///Give back the bottom left corner of the box.
-///If the bounding box is empty, then the return value is not defined.
+///If the box is empty, then the return value is not defined.
 Point<T> bottomLeft() const {
 return _bottom_left;
 }
 ///Set the bottom left corner of the box
 }
 ///Give back the top right corner of the box
 ///Give back the top right corner of the box.
-///If the bounding box is empty, then the return value is not defined.
+///If the box is empty, then the return value is not defined.
 Point<T> topRight() const {
 return _top_right;
 }
 ///Set the top right corner of the box
 }
 ///Give back the bottom right corner of the box
 ///Give back the bottom right corner of the box.
-///If the bounding box is empty, then the return value is not defined.
+///If the 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 of the box
 }
 ///Give back the top left corner of the box
 ///Give back the top left corner of the box.
-///If the bounding box is empty, then the return value is not defined.
+///If the 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 of the box
 }
 ///Give back the bottom of the box
 ///Give back the bottom of the box.
-///If the bounding box is empty, then the return value is not defined.
+///If the box is empty, then the return value is not defined.
 T bottom() const {
 return _bottom_left.y;
 }
 ///Set the bottom of the box
 }
 ///Give back the top of the box
 ///Give back the top of the box.
-///If the bounding box is empty, then the return value is not defined.
+///If the box is empty, then the return value is not defined.
 T top() const {
 return _top_right.y;
 }
 ///Set the top of the box
 }
 ///Give back the left side of the box
 ///Give back the left side of the box.
-///If the bounding box is empty, then the return value is not defined.
+///If the box is empty, then the return value is not defined.
 T left() const {
 return _bottom_left.x;
 }
 ///Set the left side of the box
 }
 /// Give back the right side of the box
 /// Give back the right side of the box.
-///If the bounding box is empty, then the return value is not defined.
+///If the box is empty, then the return value is not defined.
 T right() const {
 return _top_right.x;
 }
 ///Set the right side of the box
 }
 ///Give back the height of the box
 ///Give back the height of the box.
-///If the bounding box is empty, then the return value is not defined.
+///If the box is empty, then the return value is not defined.
 T height() const {
 return _top_right.y-_bottom_left.y;
 }
 ///Give back the width of the box
 ///Give back the width of the box.
-///If the bounding box is empty, then the return value is not defined.
+///If the box is empty, then the return value is not defined.
 T width() const {
 return _top_right.x-_bottom_left.x;
 }
-///Checks whether a point is inside a bounding box
+///Checks whether a point is inside the box
 bool inside(const Point<T>& u) const {
 if (_empty)
 return false;
 else {
 return ( (u.x-_bottom_left.x)*(_top_right.x-u.x) >= 0 &&
 (u.y-_bottom_left.y)*(_top_right.y-u.y) >= 0 );
 }
 }
-///Increments a bounding box with a point
+///Increments the box with a point
-///Increments a bounding box with a point.
+///Increments the box with a point.
 ///
-BoundingBox& add(const Point<T>& u){
+Box& add(const Point<T>& u){
 if (_empty) {
 _bottom_left = _top_right = u;
 _empty = false;
 }
 else {
 if (_top_right.y < u.y) _top_right.y = u.y;
 }
 return *this;
 }
-///Increments a bounding box to contain another bounding box
+///Increments the box to contain another box
-///Increments a bounding box to contain another bounding box.
+///Increments the box to contain another box.
 ///
-BoundingBox& add(const BoundingBox &u){
+Box& add(const Box &u){
 if ( !u.empty() ){
 add(u._bottom_left);
 add(u._top_right);
 }
 return *this;
 }
-///Intersection of two bounding boxes
+///Intersection of two boxes
-///Intersection of two bounding boxes.
+///Intersection of two boxes.
 ///
-BoundingBox operator&(const BoundingBox& u) const {
+Box operator&(const Box& u) const {
-BoundingBox b;
+Box b;
 if (_empty || u._empty) {
 b._empty = true;
 } else {
 b._bottom_left.x = std::max(_bottom_left.x, u._bottom_left.x);
 b._bottom_left.y = std::max(_bottom_left.y, u._bottom_left.y);
 b._bottom_left.y > b._top_right.y;
 }
 return b;
 }
-};//class Boundingbox
+};//class Box
-///Read a bounding box from a stream
+///Read a box from a stream
-///Read a bounding box from a stream.
+///Read a box from a stream.
-///\relates BoundingBox
+///\relates Box
 template<typename T>
-inline std::istream& operator>>(std::istream &is, BoundingBox<T>& b) {
+inline std::istream& operator>>(std::istream &is, Box<T>& b) {
 char c;
 Point<T> p;
 if (is >> c) {
 if (c != '(') is.putback(c);
 } else {
 is.clear();
 }
 return is;
 }
-///Write a bounding box to a stream
+///Write a box to a stream
-///Write a bounding box to a stream.
+///Write a box to a stream.
-///\relates BoundingBox
+///\relates Box
 template<typename T>
-inline std::ostream& operator<<(std::ostream &os, const BoundingBox<T>& b)
+inline std::ostream& operator<<(std::ostream &os, const Box<T>& b)
 {
 os << "(" << b.bottomLeft() << "," << b.topRight() << ")";
 return os;
 }

changeset 312	dd4f08b7e203
parent 250	d0aae16df1bb
child 317	64f8f7cc6168