alpar@906: /* -*- C++ -*- alpar@906: * alpar@1956: * This file is a part of LEMON, a generic C++ optimization library alpar@1956: * alpar@1956: * Copyright (C) 2003-2006 alpar@1956: * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport alpar@1359: * (Egervary Research Group on Combinatorial Optimization, EGRES). alpar@906: * alpar@906: * Permission to use, modify and distribute this software is granted alpar@906: * provided that this copyright notice appears in all copies. For alpar@906: * precise terms see the accompanying LICENSE file. alpar@906: * alpar@906: * This software is provided "AS IS" with no warranty of any kind, alpar@906: * express or implied, and with no claim as to its suitability for any alpar@906: * purpose. alpar@906: * alpar@906: */ alpar@906: alpar@921: #ifndef LEMON_XY_H alpar@921: #define LEMON_XY_H athos@201: athos@201: #include deba@1993: #include athos@201: klao@491: ///\ingroup misc alpar@249: ///\file alpar@249: ///\brief A simple two dimensional vector and a bounding box implementation alpar@249: /// alpar@921: /// The class \ref lemon::xy "xy" implements alpar@249: ///a two dimensional vector with the usual alpar@249: /// operations. alpar@249: /// alpar@921: /// The class \ref lemon::BoundingBox "BoundingBox" can be used to determine ladanyi@1426: /// the rectangular bounding box of a set of \ref lemon::xy "xy"'s. alpar@458: /// alpar@458: ///\author Attila Bernath alpar@249: alpar@249: alpar@921: namespace lemon { alpar@431: alpar@431: /// \addtogroup misc alpar@431: /// @{ alpar@431: alpar@1257: /// A simple two dimensional vector (plainvector) implementation alpar@242: alpar@1257: /// A simple two dimensional vector (plainvector) implementation alpar@458: ///with the usual vector alpar@458: /// operators. alpar@458: /// alpar@458: ///\author Attila Bernath athos@207: template athos@207: class xy { athos@201: athos@207: public: athos@240: alpar@987: typedef T Value; alpar@964: alpar@1974: ///First co-ordinate alpar@1974: T x; alpar@1974: ///Second co-ordinate alpar@1974: T y; athos@207: alpar@1257: ///Default constructor alpar@1257: xy() {} athos@201: athos@240: ///Constructing the instance from coordinates athos@514: xy(T a, T b) : x(a), y(b) { } athos@201: athos@201: alpar@1049: ///Conversion constructor alpar@1049: template xy(const xy &p) : x(p.x), y(p.y) {} alpar@1049: athos@207: ///Gives back the square of the norm of the vector alpar@1257: T normSquare() const { ladanyi@1426: return x*x+y*y; alpar@1391: } athos@201: athos@207: ///Increments the left hand side by u alpar@1257: xy& operator +=(const xy& u) { ladanyi@1426: x += u.x; ladanyi@1426: y += u.y; ladanyi@1426: return *this; alpar@1391: } athos@201: athos@207: ///Decrements the left hand side by u alpar@1257: xy& operator -=(const xy& u) { ladanyi@1426: x -= u.x; ladanyi@1426: y -= u.y; ladanyi@1426: return *this; alpar@1391: } athos@201: athos@207: ///Multiplying the left hand side with a scalar alpar@1257: xy& operator *=(const T &u) { ladanyi@1426: x *= u; ladanyi@1426: y *= u; ladanyi@1426: return *this; alpar@1391: } athos@207: athos@207: ///Dividing the left hand side by a scalar alpar@1257: xy& operator /=(const T &u) { ladanyi@1426: x /= u; ladanyi@1426: y /= u; ladanyi@1426: return *this; alpar@1391: } athos@201: athos@207: ///Returns the scalar product of two vectors alpar@1257: T operator *(const xy& u) const { ladanyi@1426: return x*u.x+y*u.y; alpar@1391: } athos@201: athos@207: ///Returns the sum of two vectors athos@207: xy operator+(const xy &u) const { ladanyi@1426: xy b=*this; ladanyi@1426: return b+=u; alpar@1391: } athos@201: alpar@1049: ///Returns the neg of the vectors alpar@1049: xy operator-() const { ladanyi@1426: xy b=*this; ladanyi@1426: b.x=-b.x; b.y=-b.y; ladanyi@1426: return b; alpar@1391: } alpar@1049: athos@207: ///Returns the difference of two vectors athos@207: xy operator-(const xy &u) const { ladanyi@1426: xy b=*this; ladanyi@1426: return b-=u; alpar@1391: } athos@201: athos@207: ///Returns a vector multiplied by a scalar athos@207: xy operator*(const T &u) const { ladanyi@1426: xy b=*this; ladanyi@1426: return b*=u; alpar@1391: } athos@201: athos@207: ///Returns a vector divided by a scalar athos@207: xy operator/(const T &u) const { ladanyi@1426: xy b=*this; ladanyi@1426: return b/=u; alpar@1391: } athos@201: athos@207: ///Testing equality alpar@1257: bool operator==(const xy &u) const { ladanyi@1426: return (x==u.x) && (y==u.y); alpar@1391: } athos@201: athos@207: ///Testing inequality alpar@1257: bool operator!=(xy u) const { ladanyi@1426: return (x!=u.x) || (y!=u.y); alpar@1391: } athos@201: athos@207: }; athos@201: deba@1999: ///Returns an xy deba@1999: deba@1999: ///Returns an xy deba@1999: ///\relates xy deba@1999: template deba@1999: inline xy make_xy(const T& x, const T& y) { deba@1999: return xy(x, y); deba@1999: } deba@1999: alpar@1071: ///Returns a vector multiplied by a scalar alpar@1083: alpar@1083: ///Returns a vector multiplied by a scalar alpar@1083: ///\relates xy alpar@1071: template xy operator*(const T &u,const xy &x) { alpar@1071: return x*u; alpar@1391: } alpar@1071: alpar@814: ///Read a plainvector from a stream alpar@814: alpar@967: ///Read a plainvector from a stream alpar@814: ///\relates xy alpar@814: /// athos@207: template deba@1392: inline std::istream& operator>>(std::istream &is, xy &z) { deba@1392: char c; deba@1392: if (is >> c) { deba@1392: if (c != '(') is.putback(c); deba@1392: } else { deba@1392: is.clear(); deba@1392: } deba@1392: if (!(is >> z.x)) return is; deba@1392: if (is >> c) { deba@1392: if (c != ',') is.putback(c); deba@1392: } else { deba@1392: is.clear(); deba@1392: } deba@1392: if (!(is >> z.y)) return is; deba@1392: if (is >> c) { deba@1392: if (c != ')') is.putback(c); deba@1392: } else { deba@1392: is.clear(); deba@1392: } athos@207: return is; athos@207: } athos@201: alpar@814: ///Write a plainvector to a stream alpar@814: alpar@967: ///Write a plainvector to a stream alpar@814: ///\relates xy alpar@814: /// athos@207: template deba@1392: inline std::ostream& operator<<(std::ostream &os, const xy& z) athos@207: { athos@240: os << "(" << z.x << ", " << z.y << ")"; athos@207: return os; athos@207: } athos@207: alpar@1202: ///Rotate by 90 degrees alpar@1202: alpar@1202: ///Returns its parameter rotated by 90 degrees in positive direction. alpar@1202: ///\relates xy alpar@1202: /// alpar@1202: template alpar@1202: inline xy rot90(const xy &z) alpar@1202: { alpar@1202: return xy(-z.y,z.x); alpar@1202: } alpar@1202: alpar@1202: ///Rotate by 270 degrees alpar@1202: alpar@1202: ///Returns its parameter rotated by 90 degrees in negative direction. alpar@1202: ///\relates xy alpar@1202: /// alpar@1202: template alpar@1202: inline xy rot270(const xy &z) alpar@1202: { alpar@1202: return xy(z.y,-z.x); alpar@1202: } alpar@1202: alpar@1202: athos@244: alpar@458: /// A class to calculate or store the bounding box of plainvectors. alpar@458: alpar@458: /// A class to calculate or store the bounding box of plainvectors. alpar@458: /// alpar@458: ///\author Attila Bernath athos@244: template athos@244: class BoundingBox { athos@244: xy bottom_left, top_right; athos@244: bool _empty; athos@244: public: athos@244: ladanyi@1426: ///Default constructor: creates an empty bounding box athos@244: BoundingBox() { _empty = true; } athos@244: athos@244: ///Constructing the instance from one point athos@244: BoundingBox(xy a) { bottom_left=top_right=a; _empty = false; } athos@244: ladanyi@1426: ///Were any points added? athos@244: bool empty() const { ladanyi@1426: return _empty; athos@244: } athos@244: alpar@1391: ///Makes the BoundingBox empty alpar@1391: void clear() { ladanyi@1426: _empty=1; alpar@1391: } alpar@1391: alpar@1927: ///\brief Gives back the bottom left corner alpar@1927: ///(if the bounding box is empty, then the return value is not defined) athos@244: xy bottomLeft() const { ladanyi@1426: return bottom_left; alpar@1391: } athos@244: alpar@1927: ///\brief Sets the bottom left corner alpar@1927: ///(should only bee used for non-empty box) alpar@1927: void bottomLeft(xy p) { alpar@1927: bottom_left = p; alpar@1927: } alpar@1927: alpar@1927: ///\brief Gives back the top right corner alpar@1927: ///(if the bounding box is empty, then the return value is not defined) athos@244: xy topRight() const { ladanyi@1426: return top_right; alpar@1391: } athos@244: alpar@1927: ///\brief Sets the top right corner alpar@1927: ///(should only bee used for non-empty box) alpar@1927: void topRight(xy p) { alpar@1927: top_right = p; alpar@1927: } alpar@1927: alpar@1927: ///\brief Gives back the bottom right corner alpar@1927: ///(if the bounding box is empty, then the return value is not defined) alpar@1045: xy bottomRight() const { ladanyi@1426: return xy(top_right.x,bottom_left.y); alpar@1391: } alpar@1045: alpar@1927: ///\brief Sets the bottom right corner alpar@1927: ///(should only bee used for non-empty box) alpar@1927: void bottomRight(xy p) { alpar@1927: top_right.x = p.x; alpar@1927: bottom_left.y = p.y; alpar@1927: } alpar@1927: alpar@1927: ///\brief Gives back the top left corner alpar@1927: ///(if the bounding box is empty, then the return value is not defined) alpar@1045: xy topLeft() const { ladanyi@1426: return xy(bottom_left.x,top_right.y); alpar@1391: } alpar@1045: alpar@1927: ///\brief Sets the top left corner alpar@1927: ///(should only bee used for non-empty box) alpar@1927: void topLeft(xy p) { alpar@1927: top_right.y = p.y; alpar@1927: bottom_left.x = p.x; alpar@1927: } alpar@1927: alpar@1927: ///\brief Gives back the bottom of the box alpar@1927: ///(if the bounding box is empty, then the return value is not defined) alpar@1045: T bottom() const { ladanyi@1426: return bottom_left.y; alpar@1391: } alpar@1045: alpar@1927: ///\brief Sets the bottom of the box alpar@1927: ///(should only bee used for non-empty box) alpar@1927: void bottom(T t) { alpar@1927: bottom_left.y = t; alpar@1927: } alpar@1927: alpar@1927: ///\brief Gives back the top of the box alpar@1927: ///(if the bounding box is empty, then the return value is not defined) alpar@1045: T top() const { ladanyi@1426: return top_right.y; alpar@1391: } alpar@1045: alpar@1927: ///\brief Sets the top of the box alpar@1927: ///(should only bee used for non-empty box) alpar@1927: void top(T t) { alpar@1927: top_right.y = t; alpar@1927: } alpar@1927: alpar@1927: ///\brief Gives back the left side of the box alpar@1927: ///(if the bounding box is empty, then the return value is not defined) alpar@1045: T left() const { ladanyi@1426: return bottom_left.x; alpar@1391: } alpar@1045: alpar@1927: ///\brief Sets the left side of the box alpar@1927: ///(should only bee used for non-empty box) alpar@1927: void left(T t) { alpar@1927: bottom_left.x = t; alpar@1927: } alpar@1927: alpar@1927: ///\brief Gives back the right side of the box alpar@1927: ///(if the bounding box is empty, then the return value is not defined) alpar@1045: T right() const { ladanyi@1426: return top_right.x; alpar@1391: } alpar@1045: alpar@1927: ///\brief Sets the right side of the box alpar@1927: ///(should only bee used for non-empty box) alpar@1927: void right(T t) { alpar@1927: top_right.x = t; alpar@1927: } alpar@1927: alpar@1927: ///\brief Gives back the height of the box alpar@1927: ///(if the bounding box is empty, then the return value is not defined) alpar@1102: T height() const { ladanyi@1426: return top_right.y-bottom_left.y; alpar@1391: } alpar@1102: alpar@1927: ///\brief Gives back the width of the box alpar@1927: ///(if the bounding box is empty, then the return value is not defined) alpar@1102: T width() const { ladanyi@1426: return top_right.x-bottom_left.x; alpar@1391: } alpar@1102: athos@244: ///Checks whether a point is inside a bounding box athos@244: bool inside(const xy& u){ ladanyi@1426: if (_empty) ladanyi@1426: return false; ladanyi@1426: else{ ladanyi@1426: return ((u.x-bottom_left.x)*(top_right.x-u.x) >= 0 && ladanyi@1426: (u.y-bottom_left.y)*(top_right.y-u.y) >= 0 ); ladanyi@1426: } athos@244: } athos@244: athos@244: ///Increments a bounding box with a point alpar@1588: BoundingBox& add(const xy& u){ ladanyi@1426: if (_empty){ ladanyi@1426: bottom_left=top_right=u; ladanyi@1426: _empty = false; ladanyi@1426: } ladanyi@1426: else{ ladanyi@1426: if (bottom_left.x > u.x) bottom_left.x = u.x; ladanyi@1426: if (bottom_left.y > u.y) bottom_left.y = u.y; ladanyi@1426: if (top_right.x < u.x) top_right.x = u.x; ladanyi@1426: if (top_right.y < u.y) top_right.y = u.y; ladanyi@1426: } ladanyi@1426: return *this; alpar@1391: } athos@244: alpar@1588: // ///Sums a bounding box and a point alpar@1588: // BoundingBox operator +(const xy& u){ alpar@1588: // BoundingBox b = *this; alpar@1588: // return b += u; alpar@1588: // } athos@244: alpar@2006: ///Increments a bounding box with another bounding box alpar@1588: BoundingBox& add(const BoundingBox &u){ ladanyi@1426: if ( !u.empty() ){ alpar@1588: this->add(u.bottomLeft()); alpar@1588: this->add(u.topRight()); ladanyi@1426: } ladanyi@1426: return *this; alpar@1391: } athos@244: athos@244: ///Sums two bounding boxes athos@244: BoundingBox operator +(const BoundingBox& u){ ladanyi@1426: BoundingBox b = *this; alpar@1588: return b.add(u); alpar@1588: } alpar@1588: alpar@1588: alpar@1588: ///Intersection of two bounding boxes alpar@1588: BoundingBox operator &(const BoundingBox& u){ alpar@1588: BoundingBox b; alpar@1588: b.bottom_left.x=std::max(this->bottom_left.x,u.bottom_left.x); alpar@1588: b.bottom_left.y=std::max(this->bottom_left.y,u.bottom_left.y); alpar@1588: b.top_right.x=std::min(this->top_right.x,u.top_right.x); alpar@1588: b.top_right.y=std::min(this->top_right.y,u.top_right.y); alpar@1588: b._empty = this->_empty || u._empty || alpar@1588: b.bottom_left.x>top_right.x && b.bottom_left.y>top_right.y; alpar@1588: return b; alpar@1391: } athos@244: athos@244: };//class Boundingbox athos@244: athos@244: alpar@1317: ///Map of x-coordinates of an xy<>-map alpar@1317: alpar@1317: ///\ingroup maps alpar@1317: /// alpar@1317: template alpar@1317: class XMap alpar@1317: { deba@1706: M& _map; alpar@1317: public: deba@1420: alpar@1317: typedef typename M::Value::Value Value; alpar@1317: typedef typename M::Key Key; alpar@1317: ///\e deba@1706: XMap(M& map) : _map(map) {} alpar@1317: Value operator[](Key k) const {return _map[k].x;} alpar@1352: void set(Key k,Value v) {_map.set(k,typename M::Value(v,_map[k].y));} alpar@1317: }; alpar@1317: alpar@1317: ///Returns an \ref XMap class alpar@1317: alpar@1317: ///This function just returns an \ref XMap class. alpar@1317: /// alpar@1317: ///\ingroup maps alpar@1317: ///\relates XMap alpar@1317: template alpar@1317: inline XMap xMap(M &m) alpar@1317: { alpar@1317: return XMap(m); alpar@1317: } alpar@1317: deba@1420: template deba@1420: inline XMap xMap(const M &m) deba@1420: { deba@1420: return XMap(m); deba@1420: } deba@1420: alpar@1317: ///Constant (read only) version of \ref XMap alpar@1317: alpar@1317: ///\ingroup maps alpar@1317: /// alpar@1317: template alpar@1317: class ConstXMap alpar@1317: { deba@1706: const M& _map; alpar@1317: public: deba@1420: alpar@1317: typedef typename M::Value::Value Value; alpar@1317: typedef typename M::Key Key; alpar@1317: ///\e alpar@1317: ConstXMap(const M &map) : _map(map) {} alpar@1317: Value operator[](Key k) const {return _map[k].x;} alpar@1317: }; alpar@1317: alpar@1317: ///Returns a \ref ConstXMap class alpar@1317: alpar@1317: ///This function just returns an \ref ConstXMap class. alpar@1317: /// alpar@1317: ///\ingroup maps alpar@1317: ///\relates ConstXMap alpar@1317: template alpar@1317: inline ConstXMap xMap(const M &m) alpar@1317: { alpar@1317: return ConstXMap(m); alpar@1317: } alpar@1317: alpar@1317: ///Map of y-coordinates of an xy<>-map alpar@1317: alpar@1317: ///\ingroup maps alpar@1317: /// alpar@1317: template alpar@1317: class YMap alpar@1317: { deba@1706: M& _map; alpar@1317: public: deba@1420: alpar@1317: typedef typename M::Value::Value Value; alpar@1317: typedef typename M::Key Key; alpar@1317: ///\e deba@1706: YMap(M& map) : _map(map) {} alpar@1317: Value operator[](Key k) const {return _map[k].y;} alpar@1352: void set(Key k,Value v) {_map.set(k,typename M::Value(_map[k].x,v));} alpar@1317: }; alpar@1317: alpar@1317: ///Returns an \ref YMap class alpar@1317: alpar@1317: ///This function just returns an \ref YMap class. alpar@1317: /// alpar@1317: ///\ingroup maps alpar@1317: ///\relates YMap alpar@1317: template alpar@1317: inline YMap yMap(M &m) alpar@1317: { alpar@1317: return YMap(m); alpar@1317: } alpar@1317: deba@1420: template deba@1420: inline YMap yMap(const M &m) deba@1420: { deba@1420: return YMap(m); deba@1420: } deba@1420: alpar@1317: ///Constant (read only) version of \ref YMap alpar@1317: alpar@1317: ///\ingroup maps alpar@1317: /// alpar@1317: template alpar@1317: class ConstYMap alpar@1317: { deba@1706: const M& _map; alpar@1317: public: deba@1420: alpar@1317: typedef typename M::Value::Value Value; alpar@1317: typedef typename M::Key Key; alpar@1317: ///\e alpar@1317: ConstYMap(const M &map) : _map(map) {} alpar@1317: Value operator[](Key k) const {return _map[k].y;} alpar@1317: }; alpar@1317: alpar@1317: ///Returns a \ref ConstYMap class alpar@1317: alpar@1317: ///This function just returns an \ref ConstYMap class. alpar@1317: /// alpar@1317: ///\ingroup maps alpar@1317: ///\relates ConstYMap alpar@1317: template alpar@1317: inline ConstYMap yMap(const M &m) alpar@1317: { alpar@1317: return ConstYMap(m); alpar@1317: } alpar@1317: alpar@1317: alpar@1352: ///Map of the \ref xy::normSquare() "normSquare()" of an \ref xy "xy"-map alpar@1352: alpar@1352: ///Map of the \ref xy::normSquare() "normSquare()" of an \ref xy "xy"-map alpar@1352: ///\ingroup maps alpar@1352: /// alpar@1352: template alpar@1352: class NormSquareMap alpar@1352: { deba@1706: const M& _map; alpar@1352: public: deba@1420: alpar@1352: typedef typename M::Value::Value Value; alpar@1352: typedef typename M::Key Key; alpar@1352: ///\e alpar@1352: NormSquareMap(const M &map) : _map(map) {} alpar@1352: Value operator[](Key k) const {return _map[k].normSquare();} alpar@1352: }; alpar@1352: alpar@1352: ///Returns a \ref NormSquareMap class alpar@1352: alpar@1352: ///This function just returns an \ref NormSquareMap class. alpar@1352: /// alpar@1352: ///\ingroup maps alpar@1352: ///\relates NormSquareMap alpar@1352: template alpar@1352: inline NormSquareMap normSquareMap(const M &m) alpar@1352: { alpar@1352: return NormSquareMap(m); alpar@1352: } alpar@1352: alpar@431: /// @} athos@244: athos@244: alpar@921: } //namespace lemon athos@201: alpar@921: #endif //LEMON_XY_H