COIN-OR::LEMON - Graph Library

Ignore:
Files:
5 edited

Legend:

Unmodified
Added
Removed
  • lemon/bfs.h

    r252 r247  
    12631263  /// the member functions of the \c Visitor class on every BFS event.
    12641264  ///
    1265   /// This interface of the BFS algorithm should be used in special cases
    1266   /// when extra actions have to be performed in connection with certain
    1267   /// events of the BFS algorithm. Otherwise consider to use Bfs or bfs()
    1268   /// instead.
    1269   ///
    12701265  /// \tparam _Digraph The type of the digraph the algorithm runs on.
    12711266  /// The default value is
  • lemon/dfs.h

    r252 r247  
    12101210  /// the member functions of the \c Visitor class on every DFS event.
    12111211  ///
    1212   /// This interface of the DFS algorithm should be used in special cases
    1213   /// when extra actions have to be performed in connection with certain
    1214   /// events of the DFS algorithm. Otherwise consider to use Dfs or dfs()
    1215   /// instead.
    1216   ///
    12171212  /// \tparam _Digraph The type of the digraph the algorithm runs on.
    12181213  /// The default value is
  • lemon/dim2.h

    r253 r241  
    2929/// a two dimensional vector with the usual operations.
    3030///
    31 /// The class \ref lemon::dim2::Box "dim2::Box" can be used to determine
     31/// The class \ref lemon::dim2::BoundingBox "dim2::BoundingBox"
     32/// can be used to determine
    3233/// the rectangular bounding box of a set of
    3334/// \ref lemon::dim2::Point "dim2::Point"'s.
     
    4445  /// @{
    4546
    46   /// Two dimensional vector (plain vector)
     47  /// A simple two dimensional vector (plain vector) implementation
    4748
    4849  /// A simple two dimensional vector (plain vector) implementation
     
    221222  inline std::ostream& operator<<(std::ostream &os, const Point<T>& z)
    222223  {
    223     os << "(" << z.x << "," << z.y << ")";
     224    os << "(" << z.x << ", " << z.y << ")";
    224225    return os;
    225226  }
     
    260261
    261262
    262   /// Bounding box of plain vectors (\ref Point points).
    263 
    264   /// A class to calculate or store the bounding box of plain vectors
    265   /// (\ref Point points).
    266   template<typename T>
    267   class Box {
     263    /// A class to calculate or store the bounding box of plain vectors.
     264
     265    /// A class to calculate or store the bounding box of plain vectors.
     266    ///
     267    template<typename T>
     268    class BoundingBox {
    268269      Point<T> _bottom_left, _top_right;
    269270      bool _empty;
    270271    public:
    271272
    272       ///Default constructor: creates an empty box
    273       Box() { _empty = true; }
    274 
    275       ///Construct a box from one point
    276       Box(Point<T> a) {
     273      ///Default constructor: creates an empty bounding box
     274      BoundingBox() { _empty = true; }
     275
     276      ///Construct an instance from one point
     277      BoundingBox(Point<T> a) {
    277278        _bottom_left = _top_right = a;
    278279        _empty = false;
    279280      }
    280281
    281       ///Construct a box from two points
    282 
    283       ///Construct a box from two points.
     282      ///Construct an instance from two points
     283
     284      ///Construct an instance from two points.
    284285      ///\param a The bottom left corner.
    285286      ///\param b The top right corner.
    286287      ///\warning The coordinates of the bottom left corner must be no more
    287288      ///than those of the top right one.
    288       Box(Point<T> a,Point<T> b)
     289      BoundingBox(Point<T> a,Point<T> b)
    289290      {
    290291        _bottom_left = a;
     
    293294      }
    294295
    295       ///Construct a box from four numbers
    296 
    297       ///Construct a box from four numbers.
     296      ///Construct an instance from four numbers
     297
     298      ///Construct an instance from four numbers.
    298299      ///\param l The left side of the box.
    299300      ///\param b The bottom of the box.
     
    302303      ///\warning The left side must be no more than the right side and
    303304      ///bottom must be no more than the top.
    304       Box(T l,T b,T r,T t)
     305      BoundingBox(T l,T b,T r,T t)
    305306      {
    306307        _bottom_left=Point<T>(l,b);
     
    309310      }
    310311
    311       ///Return \c true if the box is empty.
    312 
    313       ///Return \c true if the box is empty (i.e. return \c false
     312      ///Return \c true if the bounding box is empty.
     313
     314      ///Return \c true if the bounding box is empty (i.e. return \c false
    314315      ///if at least one point was added to the box or the coordinates of
    315316      ///the box were set).
    316317      ///
    317       ///The coordinates of an empty box are not defined.
     318      ///The coordinates of an empty bounding box are not defined.
    318319      bool empty() const {
    319320        return _empty;
    320321      }
    321322
    322       ///Make the box empty
     323      ///Make the BoundingBox empty
    323324      void clear() {
    324325        _empty = true;
     
    328329
    329330      ///Give back the bottom left corner of the box.
    330       ///If the box is empty, then the return value is not defined.
     331      ///If the bounding box is empty, then the return value is not defined.
    331332      Point<T> bottomLeft() const {
    332333        return _bottom_left;
     
    344345
    345346      ///Give back the top right corner of the box.
    346       ///If the box is empty, then the return value is not defined.
     347      ///If the bounding box is empty, then the return value is not defined.
    347348      Point<T> topRight() const {
    348349        return _top_right;
     
    360361
    361362      ///Give back the bottom right corner of the box.
    362       ///If the box is empty, then the return value is not defined.
     363      ///If the bounding box is empty, then the return value is not defined.
    363364      Point<T> bottomRight() const {
    364365        return Point<T>(_top_right.x,_bottom_left.y);
     
    377378
    378379      ///Give back the top left corner of the box.
    379       ///If the box is empty, then the return value is not defined.
     380      ///If the bounding box is empty, then the return value is not defined.
    380381      Point<T> topLeft() const {
    381382        return Point<T>(_bottom_left.x,_top_right.y);
     
    394395
    395396      ///Give back the bottom of the box.
    396       ///If the box is empty, then the return value is not defined.
     397      ///If the bounding box is empty, then the return value is not defined.
    397398      T bottom() const {
    398399        return _bottom_left.y;
     
    410411
    411412      ///Give back the top of the box.
    412       ///If the box is empty, then the return value is not defined.
     413      ///If the bounding box is empty, then the return value is not defined.
    413414      T top() const {
    414415        return _top_right.y;
     
    426427
    427428      ///Give back the left side of the box.
    428       ///If the box is empty, then the return value is not defined.
     429      ///If the bounding box is empty, then the return value is not defined.
    429430      T left() const {
    430431        return _bottom_left.x;
     
    442443
    443444      /// Give back the right side of the box.
    444       ///If the box is empty, then the return value is not defined.
     445      ///If the bounding box is empty, then the return value is not defined.
    445446      T right() const {
    446447        return _top_right.x;
     
    458459
    459460      ///Give back the height of the box.
    460       ///If the box is empty, then the return value is not defined.
     461      ///If the bounding box is empty, then the return value is not defined.
    461462      T height() const {
    462463        return _top_right.y-_bottom_left.y;
     
    466467
    467468      ///Give back the width of the box.
    468       ///If the box is empty, then the return value is not defined.
     469      ///If the bounding box is empty, then the return value is not defined.
    469470      T width() const {
    470471        return _top_right.x-_bottom_left.x;
    471472      }
    472473
    473       ///Checks whether a point is inside the box
     474      ///Checks whether a point is inside a bounding box
    474475      bool inside(const Point<T>& u) const {
    475476        if (_empty)
     
    481482      }
    482483
    483       ///Increments the box with a point
    484 
    485       ///Increments the box with a point.
     484      ///Increments a bounding box with a point
     485
     486      ///Increments a bounding box with a point.
    486487      ///
    487       Box& add(const Point<T>& u){
     488      BoundingBox& add(const Point<T>& u){
    488489        if (_empty) {
    489490          _bottom_left = _top_right = u;
     
    499500      }
    500501
    501       ///Increments the box to contain another box
    502 
    503       ///Increments the box to contain another box.
     502      ///Increments a bounding box to contain another bounding box
     503
     504      ///Increments a bounding box to contain another bounding box.
    504505      ///
    505       Box& add(const Box &u){
     506      BoundingBox& add(const BoundingBox &u){
    506507        if ( !u.empty() ){
    507508          add(u._bottom_left);
     
    511512      }
    512513
    513       ///Intersection of two boxes
    514 
    515       ///Intersection of two boxes.
     514      ///Intersection of two bounding boxes
     515
     516      ///Intersection of two bounding boxes.
    516517      ///
    517       Box operator&(const Box& u) const {
    518         Box b;
     518      BoundingBox operator&(const BoundingBox& u) const {
     519        BoundingBox b;
    519520        if (_empty || u._empty) {
    520521          b._empty = true;
     
    530531      }
    531532
    532   };//class Box
    533 
    534 
    535   ///Read a box from a stream
    536 
    537   ///Read a box from a stream.
    538   ///\relates Box
    539   template<typename T>
    540   inline std::istream& operator>>(std::istream &is, Box<T>& b) {
    541     char c;
    542     Point<T> p;
    543     if (is >> c) {
    544       if (c != '(') is.putback(c);
    545     } else {
    546       is.clear();
    547     }
    548     if (!(is >> p)) return is;
    549     b.bottomLeft(p);
    550     if (is >> c) {
    551       if (c != ',') is.putback(c);
    552     } else {
    553       is.clear();
    554     }
    555     if (!(is >> p)) return is;
    556     b.topRight(p);
    557     if (is >> c) {
    558       if (c != ')') is.putback(c);
    559     } else {
    560       is.clear();
    561     }
    562     return is;
    563   }
    564 
    565   ///Write a box to a stream
    566 
    567   ///Write a box to a stream.
    568   ///\relates Box
    569   template<typename T>
    570   inline std::ostream& operator<<(std::ostream &os, const Box<T>& b)
    571   {
    572     os << "(" << b.bottomLeft() << "," << b.topRight() << ")";
    573     return os;
    574   }
     533    };//class Boundingbox
     534
    575535
    576536  ///Map of x-coordinates of a \ref Point "Point"-map
  • lemon/graph_to_eps.h

    r253 r220  
    726726    double diag_len = 1;
    727727    if(!(_absoluteNodeSizes&&_absoluteArcWidths)) {
    728       dim2::Box<double> bb;
     728      dim2::BoundingBox<double> bb;
    729729      for(NodeIt n(g);n!=INVALID;++n) bb.add(mycoords[n]);
    730730      if (bb.empty()) {
    731         bb = dim2::Box<double>(dim2::Point<double>(0,0));
     731        bb = dim2::BoundingBox<double>(dim2::Point<double>(0,0));
    732732      }
    733733      diag_len = std::sqrt((bb.bottomLeft()-bb.topRight()).normSquare());
     
    737737    }
    738738
    739     dim2::Box<double> bb;
     739    dim2::BoundingBox<double> bb;
    740740    for(NodeIt n(g);n!=INVALID;++n) {
    741741      double ns=_nodeSizes[n]*_nodeScale;
     
    759759    }
    760760    if (bb.empty()) {
    761       bb = dim2::Box<double>(dim2::Point<double>(0,0));
     761      bb = dim2::BoundingBox<double>(dim2::Point<double>(0,0));
    762762    }
    763763
  • test/dim_test.cc

    r253 r242  
    5151  check(p.x==1 && p.y==2, "Wrong dim2::Point division by a scalar.");
    5252
    53   typedef dim2::Box<int> Box;
    54   Box box1;
    55   check(box1.empty(), "Wrong empty() in dim2::Box.");
     53  typedef dim2::BoundingBox<int> BB;
     54  BB box1;
     55  check(box1.empty(), "Wrong empty() in dim2::BoundingBox.");
    5656
    5757  box1.add(a);
    58   check(!box1.empty(), "Wrong empty() in dim2::Box.");
     58  check(!box1.empty(), "Wrong empty() in dim2::BoundingBox.");
    5959  box1.add(b);
    6060
    6161  check(box1.left()==1 && box1.bottom()==2 &&
    6262        box1.right()==3 && box1.top()==4,
    63         "Wrong addition of points to dim2::Box.");
     63        "Wrong addition of points to dim2::BoundingBox.");
    6464
    65   check(box1.inside(Point(2,3)), "Wrong inside() in dim2::Box.");
    66   check(box1.inside(Point(1,3)), "Wrong inside() in dim2::Box.");
    67   check(!box1.inside(Point(0,3)), "Wrong inside() in dim2::Box.");
     65  check(box1.inside(Point(2,3)), "Wrong inside() in dim2::BoundingBox.");
     66  check(box1.inside(Point(1,3)), "Wrong inside() in dim2::BoundingBox.");
     67  check(!box1.inside(Point(0,3)), "Wrong inside() in dim2::BoundingBox.");
    6868
    69   Box box2(Point(2,2));
    70   check(!box2.empty(), "Wrong empty() in dim2::Box.");
    71 
     69  BB box2(Point(2,2));
     70  check(!box2.empty(), "Wrong empty() in dim2::BoundingBox.");
     71 
    7272  box2.bottomLeft(Point(2,0));
    7373  box2.topRight(Point(5,3));
    74   Box box3 = box1 & box2;
     74  BB box3 = box1 & box2;
    7575  check(!box3.empty() &&
    76         box3.left()==2 && box3.bottom()==2 &&
     76        box3.left()==2 && box3.bottom()==2 && 
    7777        box3.right()==3 && box3.top()==3,
    78         "Wrong intersection of two dim2::Box objects.");
    79 
     78        "Wrong intersection of two dim2::BoundingBox objects.");
     79 
    8080  box1.add(box2);
    8181  check(!box1.empty() &&
    8282        box1.left()==1 && box1.bottom()==0 &&
    8383        box1.right()==5 && box1.top()==4,
    84         "Wrong addition of two dim2::Box objects.");
     84        "Wrong addition of two dim2::BoundingBox objects.");
    8585
    8686  return 0;
Note: See TracChangeset for help on using the changeset viewer.