LEMON/LEMON-official Changeset - r42:3a98515e9bc3

Repositories » LEMON » LEMON-official

Summary
Changelog
Files
Switch To
- loading...
Options
- Lightweight changelog
- Search
Pull Requests

Changeset - r42:3a98515e9bc3

« 41:b11737

44:7bbd94 »

r42:3a98515e9bc3

Mon, 07 Jan 2008 19:27:17

[Not Reviewed]

0 comments (0 inline)

alpar (Alpar Juttner)
alpar@cs.elte.hu

Fix several doxygen warnings

0 3 0

default

3 files changed with 30 insertions and 30 deletions:

lemon/dim2.h

lemon/maps.h

lemon/tolerance.h

↑ Collapse diff ↑

lemon/dim2.h

Show inline comments

@@ -24,686 +24,686 @@
 		///\ingroup misc
 		///\file
 		///\brief A simple two dimensional vector and a bounding box implementation
 		///
 		/// The class \ref lemon::dim2::Point "dim2::Point" implements
 		///a two dimensional vector with the usual
 		/// operations.
 		///
 		/// The class \ref lemon::dim2::BoundingBox "dim2::BoundingBox"
 		/// can be used to determine
 		/// the rectangular bounding box of a set of
 		/// \ref lemon::dim2::Point "dim2::Point"'s.
 		namespace lemon {
 		  ///Tools for handling two dimensional coordinates
 		  ///This namespace is a storage of several
 		  ///tools for handling two dimensional coordinates
 		  namespace dim2 {
 		  /// \addtogroup misc
 		  /// @{
 		  /// A simple two dimensional vector (plainvector) implementation
 		  /// A simple two dimensional vector (plainvector) implementation
 		  ///with the usual vector
 		  /// operators.
 		  ///
 		  template<typename T>
 		    class Point {
 		    public:
 		      typedef T Value;
 		      ///First coordinate
 		      T x;
 		      ///Second coordinate
 		      T y;
 		      ///Default constructor
 		      Point() {}
 		      ///Construct an instance from coordinates
 		      Point(T a, T b) : x(a), y(b) { }
 		      ///The dimension of the vector.
 		      ///The dimension of the vector.
 		      ///This function always returns 2.
 		      int size() const { return 2; }
 		      ///Subscripting operator
 		      ///\c p[0] is \c p.x and \c p[1] is \c p.y
 		      ///
 		      T& operator[](int idx) { return idx == 0 ? x : y; }
 		      ///Const subscripting operator
 		      ///\c p[0] is \c p.x and \c p[1] is \c p.y
 		      ///
 		      const T& operator[](int idx) const { return idx == 0 ? x : y; }
 		      ///Conversion constructor
 		      template<class TT> Point(const Point<TT> &p) : x(p.x), y(p.y) {}
 		      ///Give back the square of the norm of the vector
 		      T normSquare() const {
 		        return x*x+y*y;
+		      }
 		      ///Increment the left hand side by u
 		      Point<T>& operator +=(const Point<T>& u) {
 		        x += u.x;
 		        y += u.y;
 		        return *this;
+		      }
 		      ///Decrement the left hand side by u
 		      Point<T>& operator -=(const Point<T>& u) {
 		        x -= u.x;
 		        y -= u.y;
 		        return *this;
+		      }
 		      ///Multiply the left hand side with a scalar
 		      Point<T>& operator *=(const T &u) {
 		        x *= u;
 		        y *= u;
 		        return *this;
+		      }
 		      ///Divide the left hand side by a scalar
 		      Point<T>& operator /=(const T &u) {
 		        x /= u;
 		        y /= u;
 		        return *this;
+		      }
 		      ///Return the scalar product of two vectors
 		      T operator *(const Point<T>& u) const {
 		        return x*u.x+y*u.y;
+		      }
 		      ///Return the sum of two vectors
 		      Point<T> operator+(const Point<T> &u) const {
 		        Point<T> b=*this;
 		        return b+=u;
+		      }
 		      ///Return the negative of the vector
 		      Point<T> operator-() const {
 		        Point<T> b=*this;
 		        b.x=-b.x; b.y=-b.y;
 		        return b;
+		      }
 		      ///Return the difference of two vectors
 		      Point<T> operator-(const Point<T> &u) const {
 		        Point<T> b=*this;
 		        return b-=u;
+		      }
 		      ///Return a vector multiplied by a scalar
 		      Point<T> operator*(const T &u) const {
 		        Point<T> b=*this;
 		        return b*=u;
+		      }
 		      ///Return a vector divided by a scalar
 		      Point<T> operator/(const T &u) const {
 		        Point<T> b=*this;
 		        return b/=u;
+		      }
 		      ///Test equality
 		      bool operator==(const Point<T> &u) const {
 		        return (x==u.x) && (y==u.y);
+		      }
 		      ///Test inequality
 		      bool operator!=(Point u) const {
 		        return  (x!=u.x) || (y!=u.y);
+		      }
 		    };
 		  ///Return a Point
 		  ///Return a Point.
 		  ///\relates Point
 		  template <typename T>
 		  inline Point<T> makePoint(const T& x, const T& y) {
 		    return Point<T>(x, y);
+		  }
 		  ///Return a vector multiplied by a scalar
 		  ///Return a vector multiplied by a scalar.
 		  ///\relates Point
 		  template<typename T> Point<T> operator*(const T &u,const Point<T> &x) {
 		    return x*u;
+		  }
 		  ///Read a plainvector from a stream
 		  ///Read a plainvector from a stream.
 		  ///\relates Point
 		  ///
 		  template<typename T>
 		  inline std::istream& operator>>(std::istream &is, Point<T> &z) {
 		    char c;
 		    if (is >> c) {
 		      if (c != '(') is.putback(c);
 		    } else {
 		      is.clear();
+		    }
 		    if (!(is >> z.x)) return is;
 		    if (is >> c) {
 		      if (c != ',') is.putback(c);
 		    } else {
 		      is.clear();
+		    }
 		    if (!(is >> z.y)) return is;
 		    if (is >> c) {
 		      if (c != ')') is.putback(c);
 		    } else {
 		      is.clear();
+		    }
 		    return is;
+		  }
 		  ///Write a plainvector to a stream
 		  ///Write a plainvector to a stream.
 		  ///\relates Point
 		  ///
 		  template<typename T>
 		  inline std::ostream& operator<<(std::ostream &os, const Point<T>& z)
+		  {
 		    os << "(" << z.x << ", " << z.y << ")";
 		    return os;
+		  }
 		  ///Rotate by 90 degrees
 		  ///Returns the parameter rotated by 90 degrees in positive direction.
 		  ///\relates Point
 		  ///
 		  template<typename T>
 		  inline Point<T> rot90(const Point<T> &z)
+		  {
 		    return Point<T>(-z.y,z.x);
+		  }
 		  ///Rotate by 180 degrees
 		  ///Returns the parameter rotated by 180 degrees.
 		  ///\relates Point
 		  ///
 		  template<typename T>
 		  inline Point<T> rot180(const Point<T> &z)
+		  {
 		    return Point<T>(-z.x,-z.y);
+		  }
 		  ///Rotate by 270 degrees
 		  ///Returns the parameter rotated by 90 degrees in negative direction.
 		  ///\relates Point
 		  ///
 		  template<typename T>
 		  inline Point<T> rot270(const Point<T> &z)
+		  {
 		    return Point<T>(z.y,-z.x);
+		  }
 		  /// A class to calculate or store the bounding box of plainvectors.
 		  /// A class to calculate or store the bounding box of plainvectors.
 		  ///
 		    template<typename T>
 		    class BoundingBox {
 		      Point<T> bottom_left, top_right;
 		      bool _empty;
 		    public:
 		      ///Default constructor: creates an empty bounding box
 		      BoundingBox() { _empty = true; }
 		      ///Construct an instance from one point
 		      BoundingBox(Point<T> a) { bottom_left=top_right=a; _empty = false; }
 		      ///Construct an instance from two points
 		      ///Construct an instance from two points.
 		      ///\param a The bottom left corner.
 		      ///\param b The top right corner.
 		      ///\warning The coordinates of the bottom left corner must be no more
 		      ///than those of the top right one.
 		      BoundingBox(Point<T> a,Point<T> b)
+		      {
 			bottom_left=a;
 			top_right=b;
 			_empty = false;
+		      }
 		      ///Construct an instance from four numbers
 		      ///Construct an instance from four numbers.
 		      ///\param l The left side of the box.
 		      ///\param b The bottom of the box.
 		      ///\param r The right side of the box.
 		      ///\param t The top of the box.
 		      ///\warning The left side must be no more than the right side and
 		      ///bottom must be no more than the top.
 		      BoundingBox(T l,T b,T r,T t)
+		      {
 			bottom_left=Point<T>(l,b);
 			top_right=Point<T>(r,t);
 			_empty = false;
+		      }
 		      ///Return \c true if the bounding box is empty.
 		      ///Return \c true if the bounding box is empty (i.e. return \c false
 		      ///if at least one point was added to the box or the coordinates of
 		      ///the box were set).
 		      ///The coordinates of an empty bounding box are not defined.
 		      bool empty() const {
 		        return _empty;
+		      }
 		      ///Make the BoundingBox empty
 		      void clear() {
 		        _empty=1;
+		      }
 		      ///Give back the bottom left corner
 		      ///Give back the bottom left corner.
 		      ///If the bounding box is empty, then the return value is not defined.
 		      Point<T> bottomLeft() const {
 		        return bottom_left;
+		      }
 		      ///Set the bottom left corner
 		      ///Set the bottom left corner.
 		      ///It should only be used for non-empty box.
 		      void bottomLeft(Point<T> p) {
 			bottom_left = p;
+		      }
 		      ///Give back the top right corner
 		      ///Give back the top right corner.
 		      ///If the bounding box is empty, then the return value is not defined.
 		      Point<T> topRight() const {
 		        return top_right;
+		      }
 		      ///Set the top right corner
 		      ///Set the top right corner.
 		      ///It should only be used for non-empty box.
 		      void topRight(Point<T> p) {
 			top_right = p;
+		      }
 		      ///Give back the bottom right corner
 		      ///Give back the bottom right corner.
 		      ///If the bounding box is empty, then the return value is not defined.
 		      Point<T> bottomRight() const {
 		        return Point<T>(top_right.x,bottom_left.y);
+		      }
 		      ///Set the bottom right corner
 		      ///Set the bottom right corner.
 		      ///It should only be used for non-empty box.
 		      void bottomRight(Point<T> p) {
 			top_right.x = p.x;
 			bottom_left.y = p.y;
+		      }
 		      ///Give back the top left corner
 		      ///Give back the top left corner.
 		      ///If the bounding box is empty, then the return value is not defined.
 		      Point<T> topLeft() const {
 		        return Point<T>(bottom_left.x,top_right.y);
+		      }
 		      ///Set the top left corner
 		      ///Set the top left corner.
 		      ///It should only be used for non-empty box.
 		      void topLeft(Point<T> p) {
 			top_right.y = p.y;
 			bottom_left.x = p.x;
+		      }
 		      ///Give back the bottom of the box
 		      ///Give back the bottom of the box.
 		      ///If the bounding box is empty, then the return value is not defined.
 		      T bottom() const {
 		        return bottom_left.y;
+		      }
 		      ///Set the bottom of the box
 		      ///Set the bottom of the box.
 		      ///It should only be used for non-empty box.
 		      void bottom(T t) {
 			bottom_left.y = t;
+		      }
 		      ///Give back the top of the box
 		      ///Give back the top of the box.
 		      ///If the bounding box is empty, then the return value is not defined.
 		      T top() const {
 		        return top_right.y;
+		      }
 		      ///Set the top of the box
 		      ///Set the top of the box.
 		      ///It should only be used for non-empty box.
 		      void top(T t) {
 			top_right.y = t;
+		      }
 		      ///Give back the left side of the box
 		      ///Give back the left side of the box.
 		      ///If the bounding box is empty, then the return value is not defined.
 		      T left() const {
 		        return bottom_left.x;
+		      }
 		      ///Set the left side of the box
 		      ///Set the left side of the box.
 		      ///It should only be used for non-empty box.
 		      void left(T t) {
 			bottom_left.x = t;
+		      }
 		      /// Give back the right side of the box
 		      /// Give back the right side of the box.
 		      ///If the bounding box is empty, then the return value is not defined.
 		      T right() const {
 		        return top_right.x;
+		      }
 		      ///Set the right side of the box
 		      ///Set the right side of the box.
 		      ///It should only be used for non-empty box.
 		      void right(T t) {
 			top_right.x = t;
+		      }
 		      ///Give back the height of the box
 		      ///Give back the height of the box.
 		      ///If the bounding box is empty, then the return value is not defined.
 		      T height() const {
 		        return top_right.y-bottom_left.y;
+		      }
 		      ///Give back the width of the box
 		      ///Give back the width of the box.
 		      ///If the bounding box is empty, then the return value is not defined.
 		      T width() const {
 		        return top_right.x-bottom_left.x;
+		      }
 		      ///Checks whether a point is inside a bounding box
 		      bool inside(const Point<T>& u) const {
 		        if (_empty)
 		          return false;
 		        else{
 		          return ((u.x-bottom_left.x)*(top_right.x-u.x) >= 0 &&
 		              (u.y-bottom_left.y)*(top_right.y-u.y) >= 0 );
+		        }
+		      }
 		      ///Increments a bounding box with a point
 		      ///Increments a bounding box with a point.
 		      ///
 		      BoundingBox& add(const Point<T>& u){
 		        if (_empty){
 		          bottom_left=top_right=u;
 		          _empty = false;
+		        }
 		        else{
 		          if (bottom_left.x > u.x) bottom_left.x = u.x;
 		          if (bottom_left.y > u.y) bottom_left.y = u.y;
 		          if (top_right.x < u.x) top_right.x = u.x;
 		          if (top_right.y < u.y) top_right.y = u.y;
+		        }
 		        return *this;
+		      }
 		      ///Increments a bounding box to contain another bounding box
 		      ///Increments a bounding box to contain another bounding box.
 		      ///
 		      BoundingBox& add(const BoundingBox &u){
 		        if ( !u.empty() ){
 		          this->add(u.bottomLeft());
 			  this->add(u.topRight());
+		        }
 		        return *this;
+		      }
 		      ///Intersection of two bounding boxes
 		      ///Intersection of two bounding boxes.
 		      ///
 		      BoundingBox operator&(const BoundingBox& u) const {
 		        BoundingBox b;
 		        if (this->_empty || u._empty) {
 			  b._empty = true;
 			} else {
 			  b.bottom_left.x = std::max(this->bottom_left.x,u.bottom_left.x);
 			  b.bottom_left.y = std::max(this->bottom_left.y,u.bottom_left.y);
 			  b.top_right.x = std::min(this->top_right.x,u.top_right.x);
 			  b.top_right.y = std::min(this->top_right.y,u.top_right.y);
 			  b._empty = b.bottom_left.x > b.top_right.x ||
 			             b.bottom_left.y > b.top_right.y;
+			}
 		        return b;
+		      }
 		    };//class Boundingbox
-		  ///Map of x-coordinates of a \ref Point "Point"-map
 		  ///Map of x-coordinates of a Point map
 		  ///\ingroup maps
 		  ///Map of x-coordinates of a \ref Point "Point"-map.
+		  ///Map of x-coordinates of a \ref dim2::Point "Point"-map.
 		  ///
 		  template<class M>
 		  class XMap
+		  {
 		    M& _map;
 		  public:
 		    typedef typename M::Value::Value Value;
 		    typedef typename M::Key Key;
 		    ///\e
 		    XMap(M& map) : _map(map) {}
 		    Value operator[](Key k) const {return _map[k].x;}
 		    void set(Key k,Value v) {_map.set(k,typename M::Value(v,_map[k].y));}
 		  };
 		  ///Returns an \ref XMap class
 		  ///This function just returns an \ref XMap class.
 		  ///
 		  ///\ingroup maps
 		  ///\relates XMap
 		  template<class M>
 		  inline XMap<M> xMap(M &m)
+		  {
 		    return XMap<M>(m);
+		  }
 		  template<class M>
 		  inline XMap<M> xMap(const M &m)
+		  {
 		    return XMap<M>(m);
+		  }
-		  ///Constant (read only) version of \ref XMap
 		  ///Constant (read only) version of XMap
 		  ///\ingroup maps
 		  ///Constant (read only) version of \ref XMap
 		  ///
 		  template<class M>
 		  class ConstXMap
+		  {
 		    const M& _map;
 		  public:
 		    typedef typename M::Value::Value Value;
 		    typedef typename M::Key Key;
 		    ///\e
 		    ConstXMap(const M &map) : _map(map) {}
 		    Value operator[](Key k) const {return _map[k].x;}
 		  };
 		  ///Returns a \ref ConstXMap class
 		  ///This function just returns a \ref ConstXMap class.
 		  ///
 		  ///\ingroup maps
 		  ///\relates ConstXMap
 		  template<class M>
 		  inline ConstXMap<M> xMap(const M &m)
+		  {
 		    return ConstXMap<M>(m);
+		  }
-		  ///Map of y-coordinates of a \ref Point "Point"-map
 		  ///Map of y-coordinates of a Point map
 		  ///\ingroup maps
 		  ///Map of y-coordinates of a \ref Point "Point"-map.
 		  ///
 		  template<class M>
 		  class YMap
+		  {
 		    M& _map;
 		  public:
 		    typedef typename M::Value::Value Value;
 		    typedef typename M::Key Key;
 		    ///\e
 		    YMap(M& map) : _map(map) {}
 		    Value operator[](Key k) const {return _map[k].y;}
 		    void set(Key k,Value v) {_map.set(k,typename M::Value(_map[k].x,v));}
 		  };
 		  ///Returns a \ref YMap class
 		  ///This function just returns a \ref YMap class.
 		  ///
 		  ///\ingroup maps
 		  ///\relates YMap
 		  template<class M>
 		  inline YMap<M> yMap(M &m)
+		  {
 		    return YMap<M>(m);
+		  }
 		  template<class M>
 		  inline YMap<M> yMap(const M &m)
+		  {
 		    return YMap<M>(m);
+		  }
-		  ///Constant (read only) version of \ref YMap
 		  ///Constant (read only) version of YMap
 		  ///\ingroup maps
 		  ///Constant (read only) version of \ref YMap
 		  ///
 		  template<class M>
 		  class ConstYMap
+		  {
 		    const M& _map;
 		  public:
 		    typedef typename M::Value::Value Value;
 		    typedef typename M::Key Key;
 		    ///\e
 		    ConstYMap(const M &map) : _map(map) {}
 		    Value operator[](Key k) const {return _map[k].y;}
 		  };
 		  ///Returns a \ref ConstYMap class
 		  ///This function just returns a \ref ConstYMap class.
 		  ///
 		  ///\ingroup maps
 		  ///\relates ConstYMap
 		  template<class M>
 		  inline ConstYMap<M> yMap(const M &m)
+		  {
 		    return ConstYMap<M>(m);
+		  }
 		    ///\brief Map of the \ref Point::normSquare() "normSquare()"
 		    ///of a \ref Point "Point"-map
 		    ///\brief Map of the normSquare()
 		    ///of a Point map
 		    ///
 		    ///Map of the \ref Point::normSquare() "normSquare()"
 		    ///of a \ref Point "Point"-map.
 		    ///\ingroup maps
 		    ///
 		  template<class M>
 		  class NormSquareMap
+		  {
 		    const M& _map;
 		  public:
 		    typedef typename M::Value::Value Value;
 		    typedef typename M::Key Key;
 		    ///\e
 		    NormSquareMap(const M &map) : _map(map) {}
 		    Value operator[](Key k) const {return _map[k].normSquare();}
 		  };
 		  ///Returns a \ref NormSquareMap class
 		  ///This function just returns a \ref NormSquareMap class.
 		  ///
 		  ///\ingroup maps
 		  ///\relates NormSquareMap
 		  template<class M>
 		  inline NormSquareMap<M> normSquareMap(const M &m)
+		  {
 		    return NormSquareMap<M>(m);
+		  }
 		  /// @}
 		  } //namespce dim2
 		} //namespace lemon
 		#endif //LEMON_DIM2_H

lemon/maps.h

Show inline comments

 		/* -*- C++ -*-
+		 *
 		 * This file is a part of LEMON, a generic C++ optimization library
+		 *
 		 * Copyright (C) 2003-2008
 		 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
 		 * (Egervary Research Group on Combinatorial Optimization, EGRES).
+		 *
 		 * Permission to use, modify and distribute this software is granted
 		 * provided that this copyright notice appears in all copies. For
 		 * precise terms see the accompanying LICENSE file.
+		 *
 		 * This software is provided "AS IS" with no warranty of any kind,
 		 * express or implied, and with no claim as to its suitability for any
 		 * purpose.
+		 *
 		 */
 		#ifndef LEMON_MAPS_H
 		#define LEMON_MAPS_H
 		#include <iterator>
 		#include <functional>
 		#include <vector>
 		#include <lemon/bits/utility.h>
 		// #include <lemon/bits/traits.h>
 		///\file
 		///\ingroup maps
 		///\brief Miscellaneous property maps
 		///
 		#include <map>
 		namespace lemon {
 		  /// \addtogroup maps
 		  /// @{
 		  /// Base class of maps.
 		  /// Base class of maps.
 		  /// It provides the necessary <tt>typedef</tt>s required by the map concept.
 		  template<typename K, typename T>
 		  class MapBase {
 		  public:
 		    /// The key type of the map.
 		    typedef K Key;
 		    /// The value type of the map. (The type of objects associated with the keys).
 		    typedef T Value;
 		  };
 		  /// Null map. (a.k.a. DoNothingMap)
 		  /// This map can be used if you have to provide a map only for
 		  /// its type definitions, or if you have to provide a writable map,
 		  /// but data written to it is not required (i.e. it will be sent to
 		  /// <tt>/dev/null</tt>).
 		  template<typename K, typename T>
 		  class NullMap : public MapBase<K, T> {
 		  public:
 		    typedef MapBase<K, T> Parent;
 		    typedef typename Parent::Key Key;
 		    typedef typename Parent::Value Value;
 		    /// Gives back a default constructed element.
 		    T operator[](const K&) const { return T(); }
 		    /// Absorbs the value.
 		    void set(const K&, const T&) {}
 		  };
 		  ///Returns a \c NullMap class
 		  ///This function just returns a \c NullMap class.
 		  ///\relates NullMap
 		  template <typename K, typename V>
 		  NullMap<K, V> nullMap() {
 		    return NullMap<K, V>();
+		  }
 		  /// Constant map.
 		  /// This is a readable map which assigns a specified value to each key.
 		  /// In other aspects it is equivalent to the \c NullMap.
 		  template<typename K, typename T>
 		  class ConstMap : public MapBase<K, T> {
 		  private:
 		    T v;
 		  public:
 		    typedef MapBase<K, T> Parent;
 		    typedef typename Parent::Key Key;
 		    typedef typename Parent::Value Value;
 		    /// Default constructor
 		    /// Default constructor.
 		    /// The value of the map will be uninitialized.
 		    /// (More exactly it will be default constructed.)
 		    ConstMap() {}
 		    /// Constructor with specified initial value
 		    /// Constructor with specified initial value.
 		    /// \param _v is the initial value of the map.
 		    ConstMap(const T &_v) : v(_v) {}
 		    ///\e
 		    T operator[](const K&) const { return v; }
 		    ///\e
 		    void setAll(const T &t) {
 		      v = t;
+		    }
 		    template<typename T1>
 		    struct rebind {
 		      typedef ConstMap<K, T1> other;
 		    };
 		    template<typename T1>
 		    ConstMap(const ConstMap<K, T1> &, const T &_v) : v(_v) {}
 		  };
 		  ///Returns a \c ConstMap class
 		  ///This function just returns a \c ConstMap class.
 		  ///\relates ConstMap
 		  template<typename K, typename V>
 		  inline ConstMap<K, V> constMap(const V &v) {
 		    return ConstMap<K, V>(v);
+		  }
 		  template<typename T, T v>
 		  struct Const { };
 		  /// Constant map with inlined constant value.
 		  /// This is a readable map which assigns a specified value to each key.
 		  /// In other aspects it is equivalent to the \c NullMap.
 		  template<typename K, typename V, V v>
 		  class ConstMap<K, Const<V, v> > : public MapBase<K, V> {
 		  public:
 		    typedef MapBase<K, V> Parent;
 		    typedef typename Parent::Key Key;
 		    typedef typename Parent::Value Value;
 		    ConstMap() { }
 		    ///\e
 		    V operator[](const K&) const { return v; }
 		    ///\e
 		    void set(const K&, const V&) { }
 		  };
 		  ///Returns a \c ConstMap class
 		  ///This function just returns a \c ConstMap class with inlined value.
 		  ///\relates ConstMap
 		  template<typename K, typename V, V v>
 		  inline ConstMap<K, Const<V, v> > constMap() {
 		    return ConstMap<K, Const<V, v> >();
+		  }
 		  ///Map based on std::map
 		  ///This is essentially a wrapper for \c std::map with addition that
 		  ///you can specify a default value different from \c Value().
 		  template <typename K, typename T, typename Compare = std::less<K> >
 		  class StdMap {
 		    template <typename K1, typename T1, typename C1>
 		    friend class StdMap;
 		  public:
 		    typedef True ReferenceMapTag;
-		    ///\e
+		    ///Key type
 		    typedef K Key;
-		    ///\e
+		    ///Value type
 		    typedef T Value;
-		    ///\e
+		    ///Reference Type
 		    typedef T& Reference;
-		    ///\e
+		    ///Const reference type
 		    typedef const T& ConstReference;
 		  private:
 		    typedef std::map<K, T, Compare> Map;
 		    Value _value;
 		    Map _map;
 		  public:
 		    /// Constructor with specified default value
 		    StdMap(const T& value = T()) : _value(value) {}
 		    /// \brief Constructs the map from an appropriate std::map, and explicitly
 		    /// specifies a default value.
 		    template <typename T1, typename Comp1>
 		    StdMap(const std::map<Key, T1, Comp1> &map, const T& value = T())
 		      : _map(map.begin(), map.end()), _value(value) {}
 		    /// \brief Constructs a map from an other StdMap.
 		    template<typename T1, typename Comp1>
 		    StdMap(const StdMap<Key, T1, Comp1> &c)
 		      : _map(c._map.begin(), c._map.end()), _value(c._value) {}
 		  private:
 		    StdMap& operator=(const StdMap&);
 		  public:
 		    ///\e
 		    Reference operator[](const Key &k) {
 		      typename Map::iterator it = _map.lower_bound(k);
 		      if (it != _map.end() && !_map.key_comp()(k, it->first))
 			return it->second;
 		      else
 			return _map.insert(it, std::make_pair(k, _value))->second;
+		    }
 		    /// \e
 		    ConstReference operator[](const Key &k) const {
 		      typename Map::const_iterator it = _map.find(k);
 		      if (it != _map.end())
 			return it->second;
 		      else
 			return _value;
+		    }
 		    /// \e
 		    void set(const Key &k, const T &t) {
 		      typename Map::iterator it = _map.lower_bound(k);
 		      if (it != _map.end() && !_map.key_comp()(k, it->first))
 			it->second = t;
 		      else
 			_map.insert(it, std::make_pair(k, t));
+		    }
 		    /// \e
 		    void setAll(const T &t) {
 		      _value = t;
 		      _map.clear();
+		    }
 		    template <typename T1, typename C1 = std::less<T1> >
 		    struct rebind {
 		      typedef StdMap<Key, T1, C1> other;
 		    };
 		  };
 		  /// \brief Map for storing values for keys from the range <tt>[0..size-1]</tt>
 		  ///
 		  /// The current map has the <tt>[0..size-1]</tt> keyset and the values
 		  /// are stored in a \c std::vector<T>  container. It can be used with
 		  /// some data structures, for example \c UnionFind, \c BinHeap, when
 		  /// the used items are small integer numbers.
 		  ///
 		  /// \todo Revise its name
 		  template <typename T>
 		  class IntegerMap {
 		    template <typename T1>
 		    friend class IntegerMap;
 		  public:
 		    typedef True ReferenceMapTag;
 		    ///\e
 		    typedef int Key;
 		    ///\e
 		    typedef T Value;
 		    ///\e
 		    typedef T& Reference;
 		    ///\e
 		    typedef const T& ConstReference;
 		  private:
 		    typedef std::vector<T> Vector;
 		    Vector _vector;
 		  public:
 		    /// Constructor with specified default value
 		    IntegerMap(int size = 0, const T& value = T()) : _vector(size, value) {}
 		    /// \brief Constructs the map from an appropriate std::vector.
 		    template <typename T1>
 		    IntegerMap(const std::vector<T1>& vector)
 		      : _vector(vector.begin(), vector.end()) {}
 		    /// \brief Constructs a map from an other IntegerMap.
 		    template <typename T1>
 		    IntegerMap(const IntegerMap<T1> &c)
 		      : _vector(c._vector.begin(), c._vector.end()) {}
 		    /// \brief Resize the container
 		    void resize(int size, const T& value = T()) {
 		      _vector.resize(size, value);
+		    }
 		  private:
 		    IntegerMap& operator=(const IntegerMap&);
 		  public:
 		    ///\e
 		    Reference operator[](Key k) {
 		      return _vector[k];
+		    }
 		    /// \e
 		    ConstReference operator[](Key k) const {
 		      return _vector[k];
+		    }
 		    /// \e
 		    void set(const Key &k, const T& t) {
 		      _vector[k] = t;
+		    }
 		  };
 		  /// @}
 		  /// \addtogroup map_adaptors
 		  /// @{
 		  /// \brief Identity map.
 		  ///
 		  /// This map gives back the given key as value without any
 		  /// modification.
 		  template <typename T>
 		  class IdentityMap : public MapBase<T, T> {
 		  public:
 		    typedef MapBase<T, T> Parent;
 		    typedef typename Parent::Key Key;
 		    typedef typename Parent::Value Value;
 		    /// \e
 		    const T& operator[](const T& t) const {
 		      return t;
+		    }
 		  };
 		  ///Returns an \c IdentityMap class
 		  ///This function just returns an \c IdentityMap class.
 		  ///\relates IdentityMap
 		  template<typename T>
 		  inline IdentityMap<T> identityMap() {
 		    return IdentityMap<T>();
+		  }
 		  ///\brief Convert the \c Value of a map to another type using
 		  ///the default conversion.
 		  ///
 		  ///This \c concepts::ReadMap "read only map"
 		  ///converts the \c Value of a map to type \c T.
 		  ///Its \c Key is inherited from \c M.
 		  template <typename M, typename T>
 		  class ConvertMap : public MapBase<typename M::Key, T> {
 		    const M& m;
 		  public:
 		    typedef MapBase<typename M::Key, T> Parent;
 		    typedef typename Parent::Key Key;
 		    typedef typename Parent::Value Value;
 		    ///Constructor
 		    ///Constructor.
 		    ///\param _m is the underlying map.
 		    ConvertMap(const M &_m) : m(_m) {};
 		    /// \brief The subscript operator.
 		    ///
 		    /// The subscript operator.
 		    Value operator[](const Key& k) const {return m[k];}
 		  };
 		  ///Returns a \c ConvertMap class
 		  ///This function just returns a \c ConvertMap class.
 		  ///\relates ConvertMap
 		  template<typename T, typename M>
 		  inline ConvertMap<M, T> convertMap(const M &m) {
 		    return ConvertMap<M, T>(m);
+		  }
 		  ///Simple wrapping of a map
 		  ///This \c concepts::ReadMap "read only map" returns the simple
 		  ///wrapping of the given map. Sometimes the reference maps cannot be
 		  ///combined with simple read maps. This map adaptor wraps the given
 		  ///map to simple read map.
 		  ///
 		  ///\sa SimpleWriteMap
 		  ///
 		  /// \todo Revise the misleading name
 		  template<typename M>
 		  class SimpleMap : public MapBase<typename M::Key, typename M::Value> {
 		    const M& m;
 		  public:
 		    typedef MapBase<typename M::Key, typename M::Value> Parent;
 		    typedef typename Parent::Key Key;
 		    typedef typename Parent::Value Value;
 		    ///Constructor
 		    SimpleMap(const M &_m) : m(_m) {};
 		    ///\e
 		    Value operator[](Key k) const {return m[k];}
 		  };
 		  ///Simple writable wrapping of the map
 		  ///This \c concepts::WriteMap "write map" returns the simple
 		  ///wrapping of the given map. Sometimes the reference maps cannot be
 		  ///combined with simple read-write maps. This map adaptor wraps the
 		  ///given map to simple read-write map.
 		  ///
 		  ///\sa SimpleMap
 		  ///
 		  /// \todo Revise the misleading name
 		  template<typename M>
 		  class SimpleWriteMap : public MapBase<typename M::Key, typename M::Value> {
 		    M& m;
 		  public:
 		    typedef MapBase<typename M::Key, typename M::Value> Parent;
 		    typedef typename Parent::Key Key;
 		    typedef typename Parent::Value Value;
 		    ///Constructor
 		    SimpleWriteMap(M &_m) : m(_m) {};
 		    ///\e
 		    Value operator[](Key k) const {return m[k];}
 		    ///\e
 		    void set(Key k, const Value& c) { m.set(k, c); }
 		  };
 		  ///Sum of two maps
 		  ///This \c concepts::ReadMap "read only map" returns the sum of the two
 		  ///given maps.
 		  ///Its \c Key and \c Value are inherited from \c M1.
 		  ///The \c Key and \c Value of M2 must be convertible to those of \c M1.
 		  template<typename M1, typename M2>
 		  class AddMap : public MapBase<typename M1::Key, typename M1::Value> {
 		    const M1& m1;
 		    const M2& m2;
 		  public:
 		    typedef MapBase<typename M1::Key, typename M1::Value> Parent;
 		    typedef typename Parent::Key Key;
 		    typedef typename Parent::Value Value;
 		    ///Constructor
 		    AddMap(const M1 &_m1,const M2 &_m2) : m1(_m1), m2(_m2) {};
 		    ///\e
 		    Value operator[](Key k) const {return m1[k]+m2[k];}
 		  };
 		  ///Returns an \c AddMap class
 		  ///This function just returns an \c AddMap class.
 		  ///\todo How to call these type of functions?
 		  ///
 		  ///\relates AddMap
 		  template<typename M1, typename M2>
 		  inline AddMap<M1, M2> addMap(const M1 &m1,const M2 &m2) {
 		    return AddMap<M1, M2>(m1,m2);
+		  }
 		  ///Shift a map with a constant.
 		  ///This \c concepts::ReadMap "read only map" returns the sum of the
 		  ///given map and a constant value.
 		  ///Its \c Key and \c Value are inherited from \c M.
 		  ///
 		  ///Actually,
 		  ///\code
 		  ///  ShiftMap<X> sh(x,v);
 		  ///\endcode
 		  ///is equivalent to
 		  ///\code
 		  ///  ConstMap<X::Key, X::Value> c_tmp(v);
 		  ///  AddMap<X, ConstMap<X::Key, X::Value> > sh(x,v);
 		  ///\endcode
 		  ///
 		  ///\sa ShiftWriteMap
 		  template<typename M, typename C = typename M::Value>
 		  class ShiftMap : public MapBase<typename M::Key, typename M::Value> {
 		    const M& m;
 		    C v;
 		  public:
 		    typedef MapBase<typename M::Key, typename M::Value> Parent;
 		    typedef typename Parent::Key Key;
 		    typedef typename Parent::Value Value;
 		    ///Constructor
 		    ///Constructor.
 		    ///\param _m is the undelying map.
 		    ///\param _v is the shift value.
 		    ShiftMap(const M &_m, const C &_v ) : m(_m), v(_v) {};
 		    ///\e
 		    Value operator[](Key k) const {return m[k] + v;}
 		  };
 		  ///Shift a map with a constant (ReadWrite version).
 		  ///This \c concepts::ReadWriteMap "read-write map" returns the sum of the
 		  ///given map and a constant value. It makes also possible to write the map.
 		  ///Its \c Key and \c Value are inherited from \c M.
 		  ///
 		  ///\sa ShiftMap
 		  template<typename M, typename C = typename M::Value>
 		  class ShiftWriteMap : public MapBase<typename M::Key, typename M::Value> {
 		    M& m;
 		    C v;
 		  public:
 		    typedef MapBase<typename M::Key, typename M::Value> Parent;
 		    typedef typename Parent::Key Key;
 		    typedef typename Parent::Value Value;
 		    ///Constructor
 		    ///Constructor.
 		    ///\param _m is the undelying map.
 		    ///\param _v is the shift value.
 		    ShiftWriteMap(M &_m, const C &_v ) : m(_m), v(_v) {};
 		    /// \e
 		    Value operator[](Key k) const {return m[k] + v;}
 		    /// \e
 		    void set(Key k, const Value& c) { m.set(k, c - v); }
 		  };
 		  ///Returns a \c ShiftMap class
 		  ///This function just returns a \c ShiftMap class.
 		  ///\relates ShiftMap
 		  template<typename M, typename C>
 		  inline ShiftMap<M, C> shiftMap(const M &m,const C &v) {
 		    return ShiftMap<M, C>(m,v);
+		  }
 		  ///Returns a \c ShiftWriteMap class
 		  ///This function just returns a \c ShiftWriteMap class.
 		  ///\relates ShiftWriteMap
 		  template<typename M, typename C>
 		  inline ShiftWriteMap<M, C> shiftMap(M &m,const C &v) {
 		    return ShiftWriteMap<M, C>(m,v);
+		  }
 		  ///Difference of two maps
 		  ///This \c concepts::ReadMap "read only map" returns the difference
 		  ///of the values of the two given maps.
 		  ///Its \c Key and \c Value are inherited from \c M1.
 		  ///The \c Key and \c Value of \c M2 must be convertible to those of \c M1.
 		  ///
 		  /// \todo Revise the misleading name
 		  template<typename M1, typename M2>
 		  class SubMap : public MapBase<typename M1::Key, typename M1::Value> {
 		    const M1& m1;
 		    const M2& m2;
 		  public:
 		    typedef MapBase<typename M1::Key, typename M1::Value> Parent;
 		    typedef typename Parent::Key Key;
 		    typedef typename Parent::Value Value;
 		    ///Constructor
 		    SubMap(const M1 &_m1,const M2 &_m2) : m1(_m1), m2(_m2) {};
 		    /// \e
 		    Value operator[](Key k) const {return m1[k]-m2[k];}
 		  };
 		  ///Returns a \c SubMap class
 		  ///This function just returns a \c SubMap class.
 		  ///
 		  ///\relates SubMap
 		  template<typename M1, typename M2>
 		  inline SubMap<M1, M2> subMap(const M1 &m1, const M2 &m2) {
 		    return SubMap<M1, M2>(m1, m2);
+		  }
 		  ///Product of two maps
 		  ///This \c concepts::ReadMap "read only map" returns the product of the
 		  ///values of the two given maps.
 		  ///Its \c Key and \c Value are inherited from \c M1.
 		  ///The \c Key and \c Value of \c M2 must be convertible to those of \c M1.
 		  template<typename M1, typename M2>
 		  class MulMap : public MapBase<typename M1::Key, typename M1::Value> {
 		    const M1& m1;
 		    const M2& m2;
 		  public:
 		    typedef MapBase<typename M1::Key, typename M1::Value> Parent;
 		    typedef typename Parent::Key Key;
 		    typedef typename Parent::Value Value;
 		    ///Constructor
 		    MulMap(const M1 &_m1,const M2 &_m2) : m1(_m1), m2(_m2) {};
 		    /// \e
 		    Value operator[](Key k) const {return m1[k]*m2[k];}
 		  };
 		  ///Returns a \c MulMap class
 		  ///This function just returns a \c MulMap class.
 		  ///\relates MulMap
 		  template<typename M1, typename M2>
 		  inline MulMap<M1, M2> mulMap(const M1 &m1,const M2 &m2) {
 		    return MulMap<M1, M2>(m1,m2);
+		  }
 		  ///Scales a map with a constant.
 		  ///This \c concepts::ReadMap "read only map" returns the value of the
 		  ///given map multiplied from the left side with a constant value.
 		  ///Its \c Key and \c Value are inherited from \c M.
 		  ///
 		  ///Actually,
 		  ///\code
 		  ///  ScaleMap<X> sc(x,v);
 		  ///\endcode
 		  ///is equivalent to
 		  ///\code
 		  ///  ConstMap<X::Key, X::Value> c_tmp(v);
 		  ///  MulMap<X, ConstMap<X::Key, X::Value> > sc(x,v);
 		  ///\endcode
 		  ///
 		  ///\sa ScaleWriteMap
 		  template<typename M, typename C = typename M::Value>
 		  class ScaleMap : public MapBase<typename M::Key, typename M::Value> {
 		    const M& m;
 		    C v;
 		  public:
 		    typedef MapBase<typename M::Key, typename M::Value> Parent;
 		    typedef typename Parent::Key Key;
 		    typedef typename Parent::Value Value;
 		    ///Constructor
 		    ///Constructor.
 		    ///\param _m is the undelying map.
 		    ///\param _v is the scaling value.
 		    ScaleMap(const M &_m, const C &_v ) : m(_m), v(_v) {};
 		    /// \e
 		    Value operator[](Key k) const {return v * m[k];}
 		  };
 		  ///Scales a map with a constant (ReadWrite version).
 		  ///This \c concepts::ReadWriteMap "read-write map" returns the value of the
 		  ///given map multiplied from the left side with a constant value. It can
 		  ///also be used as write map if the \c / operator is defined between
 		  ///\c Value and \c C and the given multiplier is not zero.
 		  ///Its \c Key and \c Value are inherited from \c M.
 		  ///
 		  ///\sa ScaleMap
 		  template<typename M, typename C = typename M::Value>
 		  class ScaleWriteMap : public MapBase<typename M::Key, typename M::Value> {
 		    M& m;
 		    C v;
 		  public:
 		    typedef MapBase<typename M::Key, typename M::Value> Parent;
 		    typedef typename Parent::Key Key;
 		    typedef typename Parent::Value Value;
 		    ///Constructor
 		    ///Constructor.
 		    ///\param _m is the undelying map.
 		    ///\param _v is the scaling value.
 		    ScaleWriteMap(M &_m, const C &_v ) : m(_m), v(_v) {};
 		    /// \e
 		    Value operator[](Key k) const {return v * m[k];}
 		    /// \e
 		    void set(Key k, const Value& c) { m.set(k, c / v);}
 		  };
 		  ///Returns a \c ScaleMap class
 		  ///This function just returns a \c ScaleMap class.
 		  ///\relates ScaleMap
 		  template<typename M, typename C>
 		  inline ScaleMap<M, C> scaleMap(const M &m,const C &v) {
 		    return ScaleMap<M, C>(m,v);

lemon/tolerance.h

Show inline comments

 		/* -*- C++ -*-
+		 *
 		 * This file is a part of LEMON, a generic C++ optimization library
+		 *
 		 * Copyright (C) 2003-2008
 		 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
 		 * (Egervary Research Group on Combinatorial Optimization, EGRES).
+		 *
 		 * Permission to use, modify and distribute this software is granted
 		 * provided that this copyright notice appears in all copies. For
 		 * precise terms see the accompanying LICENSE file.
+		 *
 		 * This software is provided "AS IS" with no warranty of any kind,
 		 * express or implied, and with no claim as to its suitability for any
 		 * purpose.
+		 *
 		 */
 		#ifndef LEMON_TOLERANCE_H
 		#define LEMON_TOLERANCE_H
 		///\ingroup misc
 		///\file
 		///\brief A basic tool to handle the anomalies of calculation with
 		///floating point numbers.
 		///
 		///\todo It should be in a module like "Basic tools"
 		namespace lemon {
 		  /// \addtogroup misc
 		  /// @{
 		  ///\brief A class to provide a basic way to
 		  ///handle the comparison of numbers that are obtained
 		  ///as a result of a probably inexact computation.
 		  ///
 		  ///Tolerance is a class to provide a basic way to
 		  ///handle the comparison of numbers that are obtained
 		  ///as a result of a probably inexact computation.
 		  ///
 		  ///This is an abstract class, it should be specialized for all numerical
-		  ///data types. These specialized classes like \ref Tolerance\<double\>
 		  ///data types. These specialized classes like Tolerance<double>
 		  ///may offer additional tuning parameters.
 		  ///
 		  ///\sa Tolerance<float>
 		  ///\sa Tolerance<double>
 		  ///\sa Tolerance<long double>
 		  ///\sa Tolerance<int>
 		#if defined __GNUC__ && !defined __STRICT_ANSI__
 		  ///\sa Tolerance<long long int>
 		#endif
 		  ///\sa Tolerance<unsigned int>
 		#if defined __GNUC__ && !defined __STRICT_ANSI__
 		  ///\sa Tolerance<unsigned long long int>
 		#endif
 		  template<class T>
 		  class Tolerance
+		  {
 		  public:
 		    typedef T Value;
 		    ///\name Comparisons
 		    ///The concept is that these bool functions return with \c true only if
 		    ///the related comparisons hold even if some numerical error appeared
 		    ///during the computations.
 		    ///@{
 		    ///Returns \c true if \c a is \e surely strictly less than \c b
 		    static bool less(Value a,Value b) {return false;}
 		    ///Returns \c true if \c a is \e surely different from \c b
 		    static bool different(Value a,Value b) {return false;}
 		    ///Returns \c true if \c a is \e surely positive
 		    static bool positive(Value a) {return false;}
 		    ///Returns \c true if \c a is \e surely negative
 		    static bool negative(Value a) {return false;}
 		    ///Returns \c true if \c a is \e surely non-zero
 		    static bool nonZero(Value a) {return false;}
 		    ///@}
 		    ///Returns the zero value.
 		    static Value zero() {return T();}
 		    //   static bool finite(Value a) {}
 		    //   static Value big() {}
 		    //   static Value negativeBig() {}
 		  };
-		  ///Float specialization of \ref Tolerance.
 		  ///Float specialization of Tolerance.
-		  ///Float specialization of \ref Tolerance.
 		  ///Float specialization of Tolerance.
 		  ///\sa Tolerance
 		  ///\relates Tolerance
 		  template<>
 		  class Tolerance<float>
+		  {
 		    static float def_epsilon;
 		    float _epsilon;
 		  public:
 		    ///\e
 		    typedef float Value;
 		    ///Constructor setting the epsilon tolerance to the default value.
 		    Tolerance() : _epsilon(def_epsilon) {}
 		    ///Constructor setting the epsilon tolerance.
 		    Tolerance(float e) : _epsilon(e) {}
 		    ///Return the epsilon value.
 		    Value epsilon() const {return _epsilon;}
 		    ///Set the epsilon value.
 		    void epsilon(Value e) {_epsilon=e;}
 		    ///Return the default epsilon value.
 		    static Value defaultEpsilon() {return def_epsilon;}
 		    ///Set the default epsilon value.
 		    static void defaultEpsilon(Value e) {def_epsilon=e;}
 		    ///\name Comparisons
 		    ///See class Tolerance for more details.
 		    ///@{
 		    ///Returns \c true if \c a is \e surely strictly less than \c b
 		    bool less(Value a,Value b) const {return a+_epsilon<b;}
 		    ///Returns \c true if \c a is \e surely different from \c b
 		    bool different(Value a,Value b) const { return less(a,b)||less(b,a); }
 		    ///Returns \c true if \c a is \e surely positive
 		    bool positive(Value a) const { return _epsilon<a; }
 		    ///Returns \c true if \c a is \e surely negative
 		    bool negative(Value a) const { return -_epsilon>a; }
 		    ///Returns \c true if \c a is \e surely non-zero
 		    bool nonZero(Value a) const { return positive(a)||negative(a); }
 		    ///@}
 		    ///Returns zero
 		    static Value zero() {return 0;}
 		  };
-		  ///Double specialization of \ref Tolerance.
 		  ///Double specialization of Tolerance.
-		  ///Double specialization of \ref Tolerance.
 		  ///Double specialization of Tolerance.
 		  ///\sa Tolerance
 		  ///\relates Tolerance
 		  template<>
 		  class Tolerance<double>
+		  {
 		    static double def_epsilon;
 		    double _epsilon;
 		  public:
 		    ///\e
 		    typedef double Value;
 		    ///Constructor setting the epsilon tolerance to the default value.
 		    Tolerance() : _epsilon(def_epsilon) {}
 		    ///Constructor setting the epsilon tolerance.
 		    Tolerance(double e) : _epsilon(e) {}
 		    ///Return the epsilon value.
 		    Value epsilon() const {return _epsilon;}
 		    ///Set the epsilon value.
 		    void epsilon(Value e) {_epsilon=e;}
 		    ///Return the default epsilon value.
 		    static Value defaultEpsilon() {return def_epsilon;}
 		    ///Set the default epsilon value.
 		    static void defaultEpsilon(Value e) {def_epsilon=e;}
 		    ///\name Comparisons
 		    ///See class Tolerance for more details.
 		    ///@{
 		    ///Returns \c true if \c a is \e surely strictly less than \c b
 		    bool less(Value a,Value b) const {return a+_epsilon<b;}
 		    ///Returns \c true if \c a is \e surely different from \c b
 		    bool different(Value a,Value b) const { return less(a,b)||less(b,a); }
 		    ///Returns \c true if \c a is \e surely positive
 		    bool positive(Value a) const { return _epsilon<a; }
 		    ///Returns \c true if \c a is \e surely negative
 		    bool negative(Value a) const { return -_epsilon>a; }
 		    ///Returns \c true if \c a is \e surely non-zero
 		    bool nonZero(Value a) const { return positive(a)||negative(a); }
 		    ///@}
 		    ///Returns zero
 		    static Value zero() {return 0;}
 		  };
-		  ///Long double specialization of \ref Tolerance.
 		  ///Long double specialization of Tolerance.
-		  ///Long double specialization of \ref Tolerance.
 		  ///Long double specialization of Tolerance.
 		  ///\sa Tolerance
 		  ///\relates Tolerance
 		  template<>
 		  class Tolerance<long double>
+		  {
 		    static long double def_epsilon;
 		    long double _epsilon;
 		  public:
 		    ///\e
 		    typedef long double Value;
 		    ///Constructor setting the epsilon tolerance to the default value.
 		    Tolerance() : _epsilon(def_epsilon) {}
 		    ///Constructor setting the epsilon tolerance.
 		    Tolerance(long double e) : _epsilon(e) {}
 		    ///Return the epsilon value.
 		    Value epsilon() const {return _epsilon;}
 		    ///Set the epsilon value.
 		    void epsilon(Value e) {_epsilon=e;}
 		    ///Return the default epsilon value.
 		    static Value defaultEpsilon() {return def_epsilon;}
 		    ///Set the default epsilon value.
 		    static void defaultEpsilon(Value e) {def_epsilon=e;}
 		    ///\name Comparisons
 		    ///See class Tolerance for more details.
 		    ///@{
 		    ///Returns \c true if \c a is \e surely strictly less than \c b
 		    bool less(Value a,Value b) const {return a+_epsilon<b;}
 		    ///Returns \c true if \c a is \e surely different from \c b
 		    bool different(Value a,Value b) const { return less(a,b)||less(b,a); }
 		    ///Returns \c true if \c a is \e surely positive
 		    bool positive(Value a) const { return _epsilon<a; }
 		    ///Returns \c true if \c a is \e surely negative
 		    bool negative(Value a) const { return -_epsilon>a; }
 		    ///Returns \c true if \c a is \e surely non-zero
 		    bool nonZero(Value a) const { return positive(a)||negative(a); }
 		    ///@}
 		    ///Returns zero
 		    static Value zero() {return 0;}
 		  };
-		  ///Integer specialization of \ref Tolerance.
 		  ///Integer specialization of Tolerance.
-		  ///Integer specialization of \ref Tolerance.
 		  ///Integer specialization of Tolerance.
 		  ///\sa Tolerance
 		  template<>
 		  class Tolerance<int>
+		  {
 		  public:
 		    ///\e
 		    typedef int Value;
 		    ///\name Comparisons
-		    ///See \ref Tolerance for more details.
 		    ///See Tolerance for more details.
 		    ///@{
 		    ///Returns \c true if \c a is \e surely strictly less than \c b
 		    static bool less(Value a,Value b) { return a<b;}
 		    ///Returns \c true if \c a is \e surely different from \c b
 		    static bool different(Value a,Value b) { return a!=b; }
 		    ///Returns \c true if \c a is \e surely positive
 		    static bool positive(Value a) { return 0<a; }
 		    ///Returns \c true if \c a is \e surely negative
 		    static bool negative(Value a) { return 0>a; }
 		    ///Returns \c true if \c a is \e surely non-zero
 		    static bool nonZero(Value a) { return a!=0; }
 		    ///@}
 		    ///Returns zero
 		    static Value zero() {return 0;}
 		  };
-		  ///Unsigned integer specialization of \ref Tolerance.
 		  ///Unsigned integer specialization of Tolerance.
 		  ///Unsigned integer specialization of \ref Tolerance.
 		  ///\sa Tolerance
 		  template<>
 		  class Tolerance<unsigned int>
+		  {
 		  public:
 		    ///\e
 		    typedef unsigned int Value;
 		    ///\name Comparisons
-		    ///See \ref Tolerance for more details.
 		    ///See Tolerance for more details.
 		    ///@{
 		    ///Returns \c true if \c a is \e surely strictly less than \c b
 		    static bool less(Value a,Value b) { return a<b;}
 		    ///Returns \c true if \c a is \e surely different from \c b
 		    static bool different(Value a,Value b) { return a!=b; }
 		    ///Returns \c true if \c a is \e surely positive
 		    static bool positive(Value a) { return 0<a; }
 		    ///Returns \c true if \c a is \e surely negative
 		    static bool negative(Value) { return false; }
 		    ///Returns \c true if \c a is \e surely non-zero
 		    static bool nonZero(Value a) { return a!=0; }
 		    ///@}
 		    ///Returns zero
 		    static Value zero() {return 0;}
 		  };
-		  ///Long integer specialization of \ref Tolerance.
 		  ///Long integer specialization of Tolerance.
-		  ///Long integer specialization of \ref Tolerance.
 		  ///Long integer specialization of Tolerance.
 		  ///\sa Tolerance
 		  template<>
 		  class Tolerance<long int>
+		  {
 		  public:
 		    ///\e
 		    typedef long int Value;
 		    ///\name Comparisons
-		    ///See \ref Tolerance for more details.
 		    ///See Tolerance for more details.
 		    ///@{
 		    ///Returns \c true if \c a is \e surely strictly less than \c b
 		    static bool less(Value a,Value b) { return a<b;}
 		    ///Returns \c true if \c a is \e surely different from \c b
 		    static bool different(Value a,Value b) { return a!=b; }
 		    ///Returns \c true if \c a is \e surely positive
 		    static bool positive(Value a) { return 0<a; }
 		    ///Returns \c true if \c a is \e surely negative
 		    static bool negative(Value a) { return 0>a; }
 		    ///Returns \c true if \c a is \e surely non-zero
 		    static bool nonZero(Value a) { return a!=0;}
 		    ///@}
 		    ///Returns zero
 		    static Value zero() {return 0;}
 		  };
-		  ///Unsigned long integer specialization of \ref Tolerance.
 		  ///Unsigned long integer specialization of Tolerance.
 		  ///Unsigned long integer specialization of \ref Tolerance.
 		  ///\sa Tolerance
 		  template<>
 		  class Tolerance<unsigned long int>
+		  {
 		  public:
 		    ///\e
 		    typedef unsigned long int Value;
 		    ///\name Comparisons
-		    ///See \ref Tolerance for more details.
 		    ///See Tolerance for more details.
 		    ///@{
 		    ///Returns \c true if \c a is \e surely strictly less than \c b
 		    static bool less(Value a,Value b) { return a<b;}
 		    ///Returns \c true if \c a is \e surely different from \c b
 		    static bool different(Value a,Value b) { return a!=b; }
 		    ///Returns \c true if \c a is \e surely positive
 		    static bool positive(Value a) { return 0<a; }
 		    ///Returns \c true if \c a is \e surely negative
 		    static bool negative(Value) { return false; }
 		    ///Returns \c true if \c a is \e surely non-zero
 		    static bool nonZero(Value a) { return a!=0;}
 		    ///@}
 		    ///Returns zero
 		    static Value zero() {return 0;}
 		  };
 		#if defined __GNUC__ && !defined __STRICT_ANSI__
-		  ///Long long integer specialization of \ref Tolerance.
 		  ///Long long integer specialization of Tolerance.
 		  ///Long long integer specialization of \ref Tolerance.
 		  ///\warning This class (more exactly, type <tt>long long</tt>)
 		  ///is not ansi compatible.
 		  ///\sa Tolerance
 		  template<>
 		  class Tolerance<long long int>
+		  {
 		  public:
 		    ///\e
 		    typedef long long int Value;
 		    ///\name Comparisons
 		    ///See \ref Tolerance for more details.
 		    ///@{
 		    ///Returns \c true if \c a is \e surely strictly less than \c b
 		    static bool less(Value a,Value b) { return a<b;}
 		    ///Returns \c true if \c a is \e surely different from \c b
 		    static bool different(Value a,Value b) { return a!=b; }
 		    ///Returns \c true if \c a is \e surely positive
 		    static bool positive(Value a) { return 0<a; }
 		    ///Returns \c true if \c a is \e surely negative
 		    static bool negative(Value a) { return 0>a; }
 		    ///Returns \c true if \c a is \e surely non-zero
 		    static bool nonZero(Value a) { return a!=0;}
 		    ///@}
 		    ///Returns zero
 		    static Value zero() {return 0;}
 		  };
-		  ///Unsigned long long integer specialization of \ref Tolerance.
 		  ///Unsigned long long integer specialization of Tolerance.
 		  ///Unsigned long long integer specialization of \ref Tolerance.
 		  ///\warning This class (more exactly, type <tt>unsigned long long</tt>)
 		  ///is not ansi compatible.
 		  ///\sa Tolerance
 		  template<>
 		  class Tolerance<unsigned long long int>
+		  {
 		  public:
 		    ///\e
 		    typedef unsigned long long int Value;
 		    ///\name Comparisons
 		    ///See \ref Tolerance for more details.
 		    ///@{
 		    ///Returns \c true if \c a is \e surely strictly less than \c b
 		    static bool less(Value a,Value b) { return a<b;}
 		    ///Returns \c true if \c a is \e surely different from \c b
 		    static bool different(Value a,Value b) { return a!=b; }
 		    ///Returns \c true if \c a is \e surely positive
 		    static bool positive(Value a) { return 0<a; }
 		    ///Returns \c true if \c a is \e surely negative
 		    static bool negative(Value) { return false; }
 		    ///Returns \c true if \c a is \e surely non-zero
 		    static bool nonZero(Value a) { return a!=0;}
 		    ///@}
 		    ///Returns zero
 		    static Value zero() {return 0;}
 		  };
 		#endif
 		  /// @}
 		} //namespace lemon
 		#endif //LEMON_TOLERANCE_H

0 comments (0 inline)

RhodeCode

Login to your account