COIN-OR::LEMON - Graph Library

Changeset 49:9a556af88710 in lemon-1.0 for lemon/tolerance.h


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.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • 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.