COIN-OR::LEMON - Graph Library

Ignore:
File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/tolerance.h

    r49 r16  
    33 * This file is a part of LEMON, a generic C++ optimization library
    44 *
    5  * Copyright (C) 2003-2008
     5 * Copyright (C) 2003-2007
    66 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
    77 * (Egervary Research Group on Combinatorial Optimization, EGRES).
     
    3737  ///as a result of a probably inexact computation.
    3838  ///
    39   ///\ref Tolerance is a class to provide a basic way to
     39  ///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 \ref 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__ 
    5152  ///\sa Tolerance<long long int>
     53#endif
    5254  ///\sa Tolerance<unsigned int>
     55#if defined __GNUC__ && !defined __STRICT_ANSI__ 
    5356  ///\sa Tolerance<unsigned long long int>
     57#endif
    5458
    5559  template<class T>
     
    6064
    6165    ///\name Comparisons
    62     ///The concept is that these bool functions return \c true only if
     66    ///The concept is that these bool functions return with \c true only if
    6367    ///the related comparisons hold even if some numerical error appeared
    6468    ///during the computations.
     
    8892
    8993
    90   ///Float specialization of Tolerance.
    91 
    92   ///Float specialization of Tolerance.
     94  ///Float specialization of \ref Tolerance.
     95
     96  ///Float specialization of \ref Tolerance.
    9397  ///\sa Tolerance
    9498  ///\relates Tolerance
     
    104108    ///Constructor setting the epsilon tolerance to the default value.
    105109    Tolerance() : _epsilon(def_epsilon) {}
    106     ///Constructor setting the epsilon tolerance to the given value.
     110    ///Constructor setting the epsilon tolerance.
    107111    Tolerance(float e) : _epsilon(e) {}
    108112
    109     ///Returns the epsilon value.
     113    ///Return the epsilon value.
    110114    Value epsilon() const {return _epsilon;}
    111     ///Sets the epsilon value.
     115    ///Set the epsilon value.
    112116    void epsilon(Value e) {_epsilon=e;}
    113117
    114     ///Returns the default epsilon value.
     118    ///Return the default epsilon value.
    115119    static Value defaultEpsilon() {return def_epsilon;}
    116     ///Sets the default epsilon value.
     120    ///Set the default epsilon value.
    117121    static void defaultEpsilon(Value e) {def_epsilon=e;}
    118122
    119123    ///\name Comparisons
    120     ///See \ref Tolerance for more details.
     124    ///See class Tolerance for more details.
    121125
    122126    ///@{
     
    139143  };
    140144
    141   ///Double specialization of Tolerance.
    142 
    143   ///Double specialization of Tolerance.
     145  ///Double specialization of \ref Tolerance.
     146
     147  ///Double specialization of \ref Tolerance.
    144148  ///\sa Tolerance
    145149  ///\relates Tolerance
     
    155159    ///Constructor setting the epsilon tolerance to the default value.
    156160    Tolerance() : _epsilon(def_epsilon) {}
    157     ///Constructor setting the epsilon tolerance to the given value.
     161    ///Constructor setting the epsilon tolerance.
    158162    Tolerance(double e) : _epsilon(e) {}
    159163
    160     ///Returns the epsilon value.
     164    ///Return the epsilon value.
    161165    Value epsilon() const {return _epsilon;}
    162     ///Sets the epsilon value.
     166    ///Set the epsilon value.
    163167    void epsilon(Value e) {_epsilon=e;}
    164168
    165     ///Returns the default epsilon value.
     169    ///Return the default epsilon value.
    166170    static Value defaultEpsilon() {return def_epsilon;}
    167     ///Sets the default epsilon value.
     171    ///Set the default epsilon value.
    168172    static void defaultEpsilon(Value e) {def_epsilon=e;}
    169173
    170174    ///\name Comparisons
    171     ///See \ref Tolerance for more details.
     175    ///See class Tolerance for more details.
    172176
    173177    ///@{
     
    190194  };
    191195
    192   ///Long double specialization of Tolerance.
    193 
    194   ///Long double specialization of Tolerance.
     196  ///Long double specialization of \ref Tolerance.
     197
     198  ///Long double specialization of \ref Tolerance.
    195199  ///\sa Tolerance
    196200  ///\relates Tolerance
     
    206210    ///Constructor setting the epsilon tolerance to the default value.
    207211    Tolerance() : _epsilon(def_epsilon) {}
    208     ///Constructor setting the epsilon tolerance to the given value.
     212    ///Constructor setting the epsilon tolerance.
    209213    Tolerance(long double e) : _epsilon(e) {}
    210214
    211     ///Returns the epsilon value.
     215    ///Return the epsilon value.
    212216    Value epsilon() const {return _epsilon;}
    213     ///Sets the epsilon value.
     217    ///Set the epsilon value.
    214218    void epsilon(Value e) {_epsilon=e;}
    215219
    216     ///Returns the default epsilon value.
     220    ///Return the default epsilon value.
    217221    static Value defaultEpsilon() {return def_epsilon;}
    218     ///Sets the default epsilon value.
     222    ///Set the default epsilon value.
    219223    static void defaultEpsilon(Value e) {def_epsilon=e;}
    220224
    221225    ///\name Comparisons
    222     ///See \ref Tolerance for more details.
     226    ///See class Tolerance for more details.
    223227
    224228    ///@{
     
    241245  };
    242246
    243   ///Integer specialization of Tolerance.
    244 
    245   ///Integer specialization of Tolerance.
     247  ///Integer specialization of \ref Tolerance.
     248
     249  ///Integer specialization of \ref Tolerance.
    246250  ///\sa Tolerance
    247251  template<>
     
    274278  };
    275279
    276   ///Unsigned integer specialization of Tolerance.
    277 
    278280  ///Unsigned integer specialization of \ref Tolerance.
     281
     282  ///Unsigned integer specialization of \ref Tolerance.
    279283  ///\sa Tolerance
    280284  template<>
     
    308312 
    309313
    310   ///Long integer specialization of Tolerance.
    311 
    312   ///Long integer specialization of Tolerance.
     314  ///Long integer specialization of \ref Tolerance.
     315
     316  ///Long integer specialization of \ref Tolerance.
    313317  ///\sa Tolerance
    314318  template<>
     
    341345  };
    342346
    343   ///Unsigned long integer specialization of Tolerance.
    344 
    345347  ///Unsigned long integer specialization of \ref Tolerance.
     348
     349  ///Unsigned long integer specialization of \ref Tolerance.
    346350  ///\sa Tolerance
    347351  template<>
     
    376380#if defined __GNUC__ && !defined __STRICT_ANSI__
    377381
    378   ///Long long integer specialization of Tolerance.
     382  ///Long long integer specialization of \ref Tolerance.
    379383
    380384  ///Long long integer specialization of \ref Tolerance.
     
    411415  };
    412416
    413   ///Unsigned long long integer specialization of Tolerance.
     417  ///Unsigned long long integer specialization of \ref Tolerance.
    414418
    415419  ///Unsigned long long integer specialization of \ref Tolerance.
Note: See TracChangeset for help on using the changeset viewer.