COIN-OR::LEMON - Graph Library

Ignore:
File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/dim2.h

    r15 r49  
    33 * This file is a part of LEMON, a generic C++ optimization library
    44 *
    5  * Copyright (C) 2003-2007
     5 * Copyright (C) 2003-2008
    66 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
    77 * (Egervary Research Group on Combinatorial Optimization, EGRES).
     
    2828///
    2929/// The class \ref lemon::dim2::Point "dim2::Point" implements
    30 ///a two dimensional vector with the usual
    31 /// operations.
     30/// a two dimensional vector with the usual operations.
    3231///
    3332/// The class \ref lemon::dim2::BoundingBox "dim2::BoundingBox"
     
    5049
    5150  /// A simple two dimensional vector (plainvector) implementation
    52   ///with the usual vector
    53   /// operators.
    54   ///
     51  /// with the usual vector operations.
    5552  template<typename T>
    5653    class Point {
     
    7168      Point(T a, T b) : x(a), y(b) { }
    7269
    73       ///The dimension of the vector.
     70      ///Returns the dimension of the vector (i.e. returns 2).
    7471
    7572      ///The dimension of the vector.
     
    9794      }
    9895 
    99       ///Increment the left hand side by u
     96      ///Increment the left hand side by \c u
    10097      Point<T>& operator +=(const Point<T>& u) {
    10198        x += u.x;
     
    104101      }
    105102 
    106       ///Decrement the left hand side by u
     103      ///Decrement the left hand side by \c u
    107104      Point<T>& operator -=(const Point<T>& u) {
    108105        x -= u.x;
     
    316313      ///if at least one point was added to the box or the coordinates of
    317314      ///the box were set).
     315      ///
    318316      ///The coordinates of an empty bounding box are not defined.
    319317      bool empty() const {
     
    326324      }
    327325
    328       ///Give back the bottom left corner
    329 
    330       ///Give back the bottom left corner.
     326      ///Give back the bottom left corner of the box
     327
     328      ///Give back the bottom left corner of the box.
    331329      ///If the bounding box is empty, then the return value is not defined.
    332330      Point<T> bottomLeft() const {
     
    334332      }
    335333
    336       ///Set the bottom left corner
    337 
    338       ///Set the bottom left corner.
     334      ///Set the bottom left corner of the box
     335
     336      ///Set the bottom left corner of the box.
    339337      ///It should only be used for non-empty box.
    340338      void bottomLeft(Point<T> p) {
     
    342340      }
    343341
    344       ///Give back the top right corner
    345 
    346       ///Give back the top right corner.
     342      ///Give back the top right corner of the box
     343
     344      ///Give back the top right corner of the box.
    347345      ///If the bounding box is empty, then the return value is not defined.
    348346      Point<T> topRight() const {
     
    350348      }
    351349
    352       ///Set the top right corner
    353 
    354       ///Set the top right corner.
     350      ///Set the top right corner of the box
     351
     352      ///Set the top right corner of the box.
    355353      ///It should only be used for non-empty box.
    356354      void topRight(Point<T> p) {
     
    358356      }
    359357
    360       ///Give back the bottom right corner
    361 
    362       ///Give back the bottom right corner.
     358      ///Give back the bottom right corner of the box
     359
     360      ///Give back the bottom right corner of the box.
    363361      ///If the bounding box is empty, then the return value is not defined.
    364362      Point<T> bottomRight() const {
     
    366364      }
    367365
    368       ///Set the bottom right corner
    369 
    370       ///Set the bottom right corner.
     366      ///Set the bottom right corner of the box
     367
     368      ///Set the bottom right corner of the box.
    371369      ///It should only be used for non-empty box.
    372370      void bottomRight(Point<T> p) {
     
    375373      }
    376374 
    377       ///Give back the top left corner
    378 
    379       ///Give back the top left corner.
     375      ///Give back the top left corner of the box
     376
     377      ///Give back the top left corner of the box.
    380378      ///If the bounding box is empty, then the return value is not defined.
    381379      Point<T> topLeft() const {
     
    383381      }
    384382
    385       ///Set the top left corner
    386 
    387       ///Set the top left corner.
     383      ///Set the top left corner of the box
     384
     385      ///Set the top left corner of the box.
    388386      ///It should only be used for non-empty box.
    389387      void topLeft(Point<T> p) {
     
    669667
    670668
    671     ///\brief Map of the \ref Point::normSquare() "normSquare()"
    672     ///of a \ref Point "Point"-map
    673     ///
    674     ///Map of the \ref Point::normSquare() "normSquare()"
    675     ///of a \ref Point "Point"-map.
    676     ///\ingroup maps
    677     ///
     669  ///\brief Map of the \ref Point::normSquare() "normSquare()"
     670  ///of a \ref Point "Point"-map
     671  ///
     672  ///Map of the \ref Point::normSquare() "normSquare()"
     673  ///of a \ref Point "Point"-map.
     674  ///\ingroup maps
    678675  template<class M>
    679676  class NormSquareMap
Note: See TracChangeset for help on using the changeset viewer.