COIN-OR::LEMON - Graph Library

Changeset 49:9a556af88710 in lemon for lemon


Ignore:
Timestamp:
01/08/08 02:53:42 (12 years ago)
Author:
Peter Kovacs <kpeter@…>
Branch:
default
Phase:
public
Message:

Doc improvements is some files.

Location:
lemon
Files:
5 edited

Legend:

Unmodified
Added
Removed
  • lemon/base.cc

    r39 r49  
    1818
    1919///\file
    20 ///\brief Some basic non inline function and static global data.
     20///\brief Some basic non-inline functions and static global data.
    2121
    2222#include<lemon/tolerance.h>
  • lemon/bits/invalid.h

    r39 r49  
    2727  /// \brief Dummy type to make it easier to create invalid iterators.
    2828  ///
     29  /// Dummy type to make it easier to create invalid iterators.
    2930  /// See \ref INVALID for the usage.
    3031  struct Invalid {
  • lemon/dim2.h

    r42 r49  
    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) {
     
    534532
    535533
    536   ///Map of x-coordinates of a Point map
    537 
    538   ///\ingroup maps
    539   ///Map of x-coordinates of a \ref dim2::Point "Point"-map.
     534  ///Map of x-coordinates of a \ref Point "Point"-map
     535
     536  ///\ingroup maps
     537  ///Map of x-coordinates of a \ref Point "Point"-map.
    540538  ///
    541539  template<class M>
     
    571569  }
    572570
    573   ///Constant (read only) version of XMap
     571  ///Constant (read only) version of \ref XMap
    574572
    575573  ///\ingroup maps
     
    601599  }
    602600
    603   ///Map of y-coordinates of a Point map
     601  ///Map of y-coordinates of a \ref Point "Point"-map
    604602   
    605603  ///\ingroup maps
     
    638636  }
    639637
    640   ///Constant (read only) version of YMap
     638  ///Constant (read only) version of \ref YMap
    641639
    642640  ///\ingroup maps
     
    669667
    670668
    671     ///\brief Map of the normSquare()
    672     ///of a 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
  • lemon/random.h

    r39 r49  
    511511  ///\endcode
    512512  ///
    513   /// The lemon provides a global instance of the random number
     513  /// LEMON provides a global instance of the random number
    514514  /// generator which name is \ref lemon::rnd "rnd". Usually it is a
    515515  /// good programming convenience to use this global generator to get
     
    527527  public:
    528528
    529     /// \brief Constructor
     529    /// \brief Default constructor
    530530    ///
    531531    /// Constructor with constant seeding.
    532532    Random() { core.initState(); }
    533533
    534     /// \brief Constructor
     534    /// \brief Constructor with seed
    535535    ///
    536536    /// Constructor with seed. The current number type will be converted
     
    541541    }
    542542
    543     /// \brief Constructor
     543    /// \brief Constructor with array seeding
    544544    ///
    545545    /// Constructor with array seeding. The given range should contain
     
    578578    ///
    579579    /// It returns a random real number from the range [0, 1). The
    580     /// default Number type is double.
     580    /// default Number type is \c double.
    581581    template <typename Number>
    582582    Number real() {
     
    654654    ///
    655655    /// It returns a random non-negative integer uniformly from the
    656     /// whole range of the current \c Number type.  The default result
    657     /// type of this function is unsigned int.
     656    /// whole range of the current \c Number type. The default result
     657    /// type of this function is <tt>unsigned int</tt>.
    658658    template <typename Number>
    659659    Number uinteger() {
     
    669669    /// It returns a random integer uniformly from the whole range of
    670670    /// the current \c Number type. The default result type of this
    671     /// function is int.
     671    /// function is \c int.
    672672    template <typename Number>
    673673    Number integer() {
     
    690690    }
    691691
    692     ///\name Nonuniform distributions
     692    ///\name Non-uniform distributions
    693693    ///
    694694   
  • lemon/tolerance.h

    r42 r49  
    3737  ///as a result of a probably inexact computation.
    3838  ///
    39   ///Tolerance is a class to provide a basic way to
     39  ///\ref Tolerance is a class to provide a basic way to
    4040  ///handle the comparison of numbers that are obtained
    4141  ///as a result of a probably inexact computation.
    4242  ///
    4343  ///This is an abstract class, it should be specialized for all numerical
    44   ///data types. These specialized classes like Tolerance<double>
     44  ///data types. These specialized classes like \ref Tolerance<double>
    4545  ///may offer additional tuning parameters.
    4646  ///
     
    4949  ///\sa Tolerance<long double>
    5050  ///\sa Tolerance<int>
    51 #if defined __GNUC__ && !defined __STRICT_ANSI__ 
    5251  ///\sa Tolerance<long long int>
    53 #endif
    5452  ///\sa Tolerance<unsigned int>
    55 #if defined __GNUC__ && !defined __STRICT_ANSI__ 
    5653  ///\sa Tolerance<unsigned long long int>
    57 #endif
    5854
    5955  template<class T>
     
    6460
    6561    ///\name Comparisons
    66     ///The concept is that these bool functions return with \c true only if
     62    ///The concept is that these bool functions return \c true only if
    6763    ///the related comparisons hold even if some numerical error appeared
    6864    ///during the computations.
     
    108104    ///Constructor setting the epsilon tolerance to the default value.
    109105    Tolerance() : _epsilon(def_epsilon) {}
    110     ///Constructor setting the epsilon tolerance.
     106    ///Constructor setting the epsilon tolerance to the given value.
    111107    Tolerance(float e) : _epsilon(e) {}
    112108
    113     ///Return the epsilon value.
     109    ///Returns the epsilon value.
    114110    Value epsilon() const {return _epsilon;}
    115     ///Set the epsilon value.
     111    ///Sets the epsilon value.
    116112    void epsilon(Value e) {_epsilon=e;}
    117113
    118     ///Return the default epsilon value.
     114    ///Returns the default epsilon value.
    119115    static Value defaultEpsilon() {return def_epsilon;}
    120     ///Set the default epsilon value.
     116    ///Sets the default epsilon value.
    121117    static void defaultEpsilon(Value e) {def_epsilon=e;}
    122118
    123119    ///\name Comparisons
    124     ///See class Tolerance for more details.
     120    ///See \ref Tolerance for more details.
    125121
    126122    ///@{
     
    159155    ///Constructor setting the epsilon tolerance to the default value.
    160156    Tolerance() : _epsilon(def_epsilon) {}
    161     ///Constructor setting the epsilon tolerance.
     157    ///Constructor setting the epsilon tolerance to the given value.
    162158    Tolerance(double e) : _epsilon(e) {}
    163159
    164     ///Return the epsilon value.
     160    ///Returns the epsilon value.
    165161    Value epsilon() const {return _epsilon;}
    166     ///Set the epsilon value.
     162    ///Sets the epsilon value.
    167163    void epsilon(Value e) {_epsilon=e;}
    168164
    169     ///Return the default epsilon value.
     165    ///Returns the default epsilon value.
    170166    static Value defaultEpsilon() {return def_epsilon;}
    171     ///Set the default epsilon value.
     167    ///Sets the default epsilon value.
    172168    static void defaultEpsilon(Value e) {def_epsilon=e;}
    173169
    174170    ///\name Comparisons
    175     ///See class Tolerance for more details.
     171    ///See \ref Tolerance for more details.
    176172
    177173    ///@{
     
    210206    ///Constructor setting the epsilon tolerance to the default value.
    211207    Tolerance() : _epsilon(def_epsilon) {}
    212     ///Constructor setting the epsilon tolerance.
     208    ///Constructor setting the epsilon tolerance to the given value.
    213209    Tolerance(long double e) : _epsilon(e) {}
    214210
    215     ///Return the epsilon value.
     211    ///Returns the epsilon value.
    216212    Value epsilon() const {return _epsilon;}
    217     ///Set the epsilon value.
     213    ///Sets the epsilon value.
    218214    void epsilon(Value e) {_epsilon=e;}
    219215
    220     ///Return the default epsilon value.
     216    ///Returns the default epsilon value.
    221217    static Value defaultEpsilon() {return def_epsilon;}
    222     ///Set the default epsilon value.
     218    ///Sets the default epsilon value.
    223219    static void defaultEpsilon(Value e) {def_epsilon=e;}
    224220
    225221    ///\name Comparisons
    226     ///See class Tolerance for more details.
     222    ///See \ref Tolerance for more details.
    227223
    228224    ///@{
     
    257253
    258254    ///\name Comparisons
    259     ///See Tolerance for more details.
     255    ///See \ref Tolerance for more details.
    260256
    261257    ///@{
     
    290286
    291287    ///\name Comparisons
    292     ///See Tolerance for more details.
     288    ///See \ref Tolerance for more details.
    293289
    294290    ///@{
     
    324320
    325321    ///\name Comparisons
    326     ///See Tolerance for more details.
     322    ///See \ref Tolerance for more details.
    327323
    328324    ///@{
     
    357353
    358354    ///\name Comparisons
    359     ///See Tolerance for more details.
     355    ///See \ref Tolerance for more details.
    360356
    361357    ///@{
Note: See TracChangeset for help on using the changeset viewer.