lemon/tolerance.h
changeset 233 28239207a8a3
parent 72 7050661bdea4
child 280 e7f8647ce760
equal deleted inserted replaced
5:ecaf6f756d5c 6:511cf4ab4795
     1 /* -*- C++ -*-
     1 /* -*- mode: C++; indent-tabs-mode: nil; -*-
     2  *
     2  *
     3  * This file is a part of LEMON, a generic C++ optimization library
     3  * This file is a part of LEMON, a generic C++ optimization library.
     4  *
     4  *
     5  * Copyright (C) 2003-2008
     5  * Copyright (C) 2003-2008
     6  * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
     6  * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
     7  * (Egervary Research Group on Combinatorial Optimization, EGRES).
     7  * (Egervary Research Group on Combinatorial Optimization, EGRES).
     8  *
     8  *
    29 
    29 
    30 namespace lemon {
    30 namespace lemon {
    31 
    31 
    32   /// \addtogroup misc
    32   /// \addtogroup misc
    33   /// @{
    33   /// @{
    34   
    34 
    35   ///\brief A class to provide a basic way to
    35   ///\brief A class to provide a basic way to
    36   ///handle the comparison of numbers that are obtained
    36   ///handle the comparison of numbers that are obtained
    37   ///as a result of a probably inexact computation.
    37   ///as a result of a probably inexact computation.
    38   ///
    38   ///
    39   ///\ref Tolerance is a class to provide a basic way to
    39   ///\ref Tolerance is a class to provide a basic way to
    40   ///handle the comparison of numbers that are obtained
    40   ///handle the comparison of numbers that are obtained
    41   ///as a result of a probably inexact computation.
    41   ///as a result of a probably inexact computation.
    42   ///
    42   ///
    43   ///This is an abstract class, it should be specialized for all 
    43   ///This is an abstract class, it should be specialized for all
    44   ///numerical data types. These specialized classes like 
    44   ///numerical data types. These specialized classes like
    45   ///Tolerance<double> may offer additional tuning parameters.
    45   ///Tolerance<double> may offer additional tuning parameters.
    46   ///
    46   ///
    47   ///\sa Tolerance<float>
    47   ///\sa Tolerance<float>
    48   ///\sa Tolerance<double>
    48   ///\sa Tolerance<double>
    49   ///\sa Tolerance<long double>
    49   ///\sa Tolerance<long double>
   303     ///@}
   303     ///@}
   304 
   304 
   305     ///Returns zero
   305     ///Returns zero
   306     static Value zero() {return 0;}
   306     static Value zero() {return 0;}
   307   };
   307   };
   308   
   308 
   309 
   309 
   310   ///Long integer specialization of Tolerance.
   310   ///Long integer specialization of Tolerance.
   311 
   311 
   312   ///Long integer specialization of Tolerance.
   312   ///Long integer specialization of Tolerance.
   313   ///\sa Tolerance
   313   ///\sa Tolerance