COIN-OR::LEMON - Graph Library

Ignore:
File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/tolerance.h

    r16 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).
     
    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 \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__ 
    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.
     
    9288
    9389
    94   ///Float specialization of \ref Tolerance.
    95 
    96   ///Float specialization of \ref Tolerance.
     90  ///Float specialization of Tolerance.
     91
     92  ///Float specialization of Tolerance.
    9793  ///\sa Tolerance
    9894  ///\relates Tolerance
     
    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    ///@{
     
    143139  };
    144140
    145   ///Double specialization of \ref Tolerance.
    146 
    147   ///Double specialization of \ref Tolerance.
     141  ///Double specialization of Tolerance.
     142
     143  ///Double specialization of Tolerance.
    148144  ///\sa Tolerance
    149145  ///\relates Tolerance
     
    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    ///@{
     
    194190  };
    195191
    196   ///Long double specialization of \ref Tolerance.
    197 
    198   ///Long double specialization of \ref Tolerance.
     192  ///Long double specialization of Tolerance.
     193
     194  ///Long double specialization of Tolerance.
    199195  ///\sa Tolerance
    200196  ///\relates Tolerance
     
    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    ///@{
     
    245241  };
    246242
    247   ///Integer specialization of \ref Tolerance.
    248 
    249   ///Integer specialization of \ref Tolerance.
     243  ///Integer specialization of Tolerance.
     244
     245  ///Integer specialization of Tolerance.
    250246  ///\sa Tolerance
    251247  template<>
     
    278274  };
    279275
     276  ///Unsigned integer specialization of Tolerance.
     277
    280278  ///Unsigned integer specialization of \ref Tolerance.
    281 
    282   ///Unsigned integer specialization of \ref Tolerance.
    283279  ///\sa Tolerance
    284280  template<>
     
    312308 
    313309
    314   ///Long integer specialization of \ref Tolerance.
    315 
    316   ///Long integer specialization of \ref Tolerance.
     310  ///Long integer specialization of Tolerance.
     311
     312  ///Long integer specialization of Tolerance.
    317313  ///\sa Tolerance
    318314  template<>
     
    345341  };
    346342
     343  ///Unsigned long integer specialization of Tolerance.
     344
    347345  ///Unsigned long integer specialization of \ref Tolerance.
    348 
    349   ///Unsigned long integer specialization of \ref Tolerance.
    350346  ///\sa Tolerance
    351347  template<>
     
    380376#if defined __GNUC__ && !defined __STRICT_ANSI__
    381377
    382   ///Long long integer specialization of \ref Tolerance.
     378  ///Long long integer specialization of Tolerance.
    383379
    384380  ///Long long integer specialization of \ref Tolerance.
     
    415411  };
    416412
    417   ///Unsigned long long integer specialization of \ref Tolerance.
     413  ///Unsigned long long integer specialization of Tolerance.
    418414
    419415  ///Unsigned long long integer specialization of \ref Tolerance.
Note: See TracChangeset for help on using the changeset viewer.