↑ Collapse diff ↑
Ignore white space 6 line context
1 1
/* -*- C++ -*-
2 2
 *
3 3
 * This file is a part of LEMON, a generic C++ optimization library
4 4
 *
5
 * Copyright (C) 2003-2007
5
 * Copyright (C) 2003-2008
6 6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
8 8
 *
9 9
 * Permission to use, modify and distribute this software is granted
10 10
 * provided that this copyright notice appears in all copies. For
11 11
 * precise terms see the accompanying LICENSE file.
12 12
 *
13 13
 * This software is provided "AS IS" with no warranty of any kind,
14 14
 * express or implied, and with no claim as to its suitability for any
15 15
 * purpose.
16 16
 *
17 17
 */
18 18

	
19 19
///\file
20 20
///\brief Some basic non inline function and static global data.
21 21

	
22 22
#include<lemon/tolerance.h>
23 23
#include<lemon/bits/invalid.h>
24 24
namespace lemon {
25 25

	
26 26
  float Tolerance<float>::def_epsilon = 1e-4;
27 27
  double Tolerance<double>::def_epsilon = 1e-10;
28 28
  long double Tolerance<long double>::def_epsilon = 1e-14;
29 29

	
30 30
#ifndef LEMON_ONLY_TEMPLATES
31 31
  const Invalid INVALID = Invalid();
32 32
#endif
33 33

	
34 34
} //namespace lemon
Ignore white space 6 line context
1 1
/* -*- C++ -*-
2 2
 *
3 3
 * This file is a part of LEMON, a generic C++ optimization library
4 4
 *
5
 * Copyright (C) 2003-2007
5
 * Copyright (C) 2003-2008
6 6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
8 8
 *
9 9
 * Permission to use, modify and distribute this software is granted
10 10
 * provided that this copyright notice appears in all copies. For
11 11
 * precise terms see the accompanying LICENSE file.
12 12
 *
13 13
 * This software is provided "AS IS" with no warranty of any kind,
14 14
 * express or implied, and with no claim as to its suitability for any
15 15
 * purpose.
16 16
 *
17 17
 */
18 18

	
19 19
#ifndef LEMON_BITS_INVALID_H
20 20
#define LEMON_BITS_INVALID_H
21 21

	
22 22
///\file
23 23
///\brief Definition of INVALID.
24 24

	
25 25
namespace lemon {
26 26

	
27 27
  /// \brief Dummy type to make it easier to create invalid iterators.
28 28
  ///
29 29
  /// See \ref INVALID for the usage.
30 30
  struct Invalid {
31 31
  public:
32 32
    bool operator==(Invalid) { return true;  }
33 33
    bool operator!=(Invalid) { return false; }
34 34
    bool operator< (Invalid) { return false; }
35 35
  };
36 36
  
37 37
  /// \brief Invalid iterators.
38 38
  ///
39 39
  /// \ref Invalid is a global type that converts to each iterator
40 40
  /// in such a way that the value of the target iterator will be invalid.
41 41

	
42 42
  //Some people didn't like this:
43 43
  //const Invalid &INVALID = *(Invalid *)0;
44 44

	
45 45
#ifdef LEMON_ONLY_TEMPLATES
46 46
  const Invalid INVALID = Invalid();
47 47
#else
48 48
  extern const Invalid INVALID;
49 49
#endif
50 50

	
51 51
} //namespace lemon
52 52

	
53 53
#endif
54 54
  
Ignore white space 6 line context
1 1
/* -*- C++ -*-
2 2
 *
3 3
 * This file is a part of LEMON, a generic C++ optimization library
4 4
 *
5
 * Copyright (C) 2003-2007
5
 * Copyright (C) 2003-2008
6 6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
8 8
 *
9 9
 * Permission to use, modify and distribute this software is granted
10 10
 * provided that this copyright notice appears in all copies. For
11 11
 * precise terms see the accompanying LICENSE file.
12 12
 *
13 13
 * This software is provided "AS IS" with no warranty of any kind,
14 14
 * express or implied, and with no claim as to its suitability for any
15 15
 * purpose.
16 16
 *
17 17
 */
18 18

	
19 19
// This file contains a modified version of the enable_if library from BOOST.
20 20
// See the appropriate copyright notice below.
21 21

	
22 22
// Boost enable_if library
23 23

	
24 24
// Copyright 2003 � The Trustees of Indiana University.
25 25

	
26 26
// Use, modification, and distribution is subject to the Boost Software
27 27
// License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
28 28
// http://www.boost.org/LICENSE_1_0.txt)
29 29

	
30 30
//    Authors: Jaakko J�rvi (jajarvi at osl.iu.edu)
31 31
//             Jeremiah Willcock (jewillco at osl.iu.edu)
32 32
//             Andrew Lumsdaine (lums at osl.iu.edu)
33 33

	
34 34

	
35 35
#ifndef LEMON_BITS_UTILITY_H
36 36
#define LEMON_BITS_UTILITY_H
37 37

	
38 38
///\file
39 39
///\brief Miscellaneous basic utilities
40 40
///
41 41
///\todo Please rethink the organisation of the basic files like this.
42 42
///E.g. this file might be merged with invalid.h.
43 43

	
44 44

	
45 45
namespace lemon
46 46
{
47 47

	
48 48
  /// Basic type for defining "tags". A "YES" condition for \c enable_if.
49 49

	
50 50
  /// Basic type for defining "tags". A "YES" condition for \c enable_if.
51 51
  ///
52 52
  ///\sa False
53 53
  ///
54 54
  /// \todo This should go to a separate "basic_types.h" (or something)
55 55
  /// file.
56 56
  struct True {
57 57
    ///\e
58 58
    static const bool value = true;
59 59
  };
60 60

	
61 61
  /// Basic type for defining "tags". A "NO" condition for \c enable_if.
62 62

	
63 63
  /// Basic type for defining "tags". A "NO" condition for \c enable_if.
64 64
  ///
65 65
  ///\sa True
66 66
  struct False {
67 67
    ///\e
68 68
    static const bool value = false;
69 69
  };
70 70

	
71 71

	
72 72
  struct InvalidType {
73 73
  };
74 74

	
75 75
  template <typename T>
76 76
  struct Wrap {
77 77
    const T &value;
78 78
    Wrap(const T &t) : value(t) {}
79 79
  };
80 80

	
81 81
  /**************** dummy class to avoid ambiguity ****************/
82 82

	
83 83
  template<int T> struct dummy { dummy(int) {} };
84 84

	
85 85
  /**************** enable_if from BOOST ****************/
86 86
  
87 87
  template <typename Type, typename T = void>
88 88
  struct exists {
89 89
    typedef T type;
90 90
  };
91 91

	
92 92
 
93 93
  template <bool B, class T = void>
94 94
  struct enable_if_c {
95 95
    typedef T type;
96 96
  };
97 97

	
98 98
  template <class T>
99 99
  struct enable_if_c<false, T> {};
100 100

	
101 101
  template <class Cond, class T = void> 
102 102
  struct enable_if : public enable_if_c<Cond::value, T> {};
103 103

	
104 104
  template <bool B, class T>
105 105
  struct lazy_enable_if_c {
106 106
    typedef typename T::type type;
107 107
  };
108 108

	
109 109
  template <class T>
110 110
  struct lazy_enable_if_c<false, T> {};
111 111

	
112 112
  template <class Cond, class T> 
113 113
  struct lazy_enable_if : public lazy_enable_if_c<Cond::value, T> {};
114 114

	
115 115

	
116 116
  template <bool B, class T = void>
117 117
  struct disable_if_c {
118 118
    typedef T type;
119 119
  };
120 120

	
121 121
  template <class T>
122 122
  struct disable_if_c<true, T> {};
123 123

	
124 124
  template <class Cond, class T = void> 
125 125
  struct disable_if : public disable_if_c<Cond::value, T> {};
126 126

	
127 127
  template <bool B, class T>
128 128
  struct lazy_disable_if_c {
129 129
    typedef typename T::type type;
130 130
  };
131 131

	
132 132
  template <class T>
133 133
  struct lazy_disable_if_c<true, T> {};
134 134

	
135 135
  template <class Cond, class T> 
136 136
  struct lazy_disable_if : public lazy_disable_if_c<Cond::value, T> {};
137 137

	
138 138
} // namespace lemon
139 139

	
140 140
#endif
Ignore white space 6 line context
1 1
/* -*- C++ -*-
2 2
 *
3 3
 * This file is a part of LEMON, a generic C++ optimization library
4 4
 *
5
 * Copyright (C) 2003-2007
5
 * Copyright (C) 2003-2008
6 6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
8 8
 *
9 9
 * Permission to use, modify and distribute this software is granted
10 10
 * provided that this copyright notice appears in all copies. For
11 11
 * precise terms see the accompanying LICENSE file.
12 12
 *
13 13
 * This software is provided "AS IS" with no warranty of any kind,
14 14
 * express or implied, and with no claim as to its suitability for any
15 15
 * purpose.
16 16
 *
17 17
 */
18 18

	
19 19
// This file contains a modified version of the concept checking
20 20
// utility from BOOST.
21 21
// See the appropriate copyright notice below.
22 22

	
23 23
// (C) Copyright Jeremy Siek 2000.
24 24
// Distributed under the Boost Software License, Version 1.0. (See
25 25
// accompanying file LICENSE_1_0.txt or copy at
26 26
// http://www.boost.org/LICENSE_1_0.txt)
27 27
//
28 28
// Revision History:
29 29
//   05 May   2001: Workarounds for HP aCC from Thomas Matelich. (Jeremy Siek)
30 30
//   02 April 2001: Removed limits header altogether. (Jeremy Siek)
31 31
//   01 April 2001: Modified to use new <boost/limits.hpp> header. (JMaddock)
32 32
//
33 33

	
34 34
// See http://www.boost.org/libs/concept_check for documentation.
35 35

	
36 36
#ifndef LEMON_CONCEPT_CHECKS_H
37 37
#define LEMON_CONCEPT_CHECKS_H
38 38

	
39 39
namespace lemon {
40 40

	
41 41
  /*
42 42
    "inline" is used for ignore_unused_variable_warning()
43 43
    and function_requires() to make sure there is no
44 44
    overtarget with g++.
45 45
  */
46 46

	
47 47
  template <class T> inline void ignore_unused_variable_warning(const T&) { }
48 48

	
49 49
  template <class Concept>
50 50
  inline void function_requires()
51 51
  {
52 52
#if !defined(NDEBUG)
53 53
    void (Concept::*x)() = & Concept::constraints;
54 54
    ignore_unused_variable_warning(x);
55 55
#endif
56 56
  }
57 57

	
58 58
  template <typename Concept, typename Type>
59 59
  inline void checkConcept() {
60 60
#if !defined(NDEBUG)
61 61
    typedef typename Concept::template Constraints<Type> ConceptCheck;
62 62
    void (ConceptCheck::*x)() = & ConceptCheck::constraints;
63 63
    ignore_unused_variable_warning(x);
64 64
#endif
65 65
  }
66 66

	
67 67
#define BOOST_CLASS_REQUIRE(type_var, ns, concept) \
68 68
  typedef void (ns::concept <type_var>::* func##type_var##concept)(); \
69 69
  template <func##type_var##concept Tp1_> \
70 70
  struct concept_checking_##type_var##concept { }; \
71 71
  typedef concept_checking_##type_var##concept< \
72 72
    BOOST_FPTR ns::concept<type_var>::constraints> \
73 73
    concept_checking_typedef_##type_var##concept
74 74

	
75 75
#define BOOST_CLASS_REQUIRE2(type_var1, type_var2, ns, concept) \
76 76
  typedef void (ns::concept <type_var1,type_var2>::* \
77 77
     func##type_var1##type_var2##concept)(); \
78 78
  template <func##type_var1##type_var2##concept Tp1_> \
79 79
  struct concept_checking_##type_var1##type_var2##concept { }; \
80 80
  typedef concept_checking_##type_var1##type_var2##concept< \
81 81
    BOOST_FPTR ns::concept<type_var1,type_var2>::constraints> \
82 82
    concept_checking_typedef_##type_var1##type_var2##concept
83 83

	
84 84
#define BOOST_CLASS_REQUIRE3(tv1, tv2, tv3, ns, concept) \
85 85
  typedef void (ns::concept <tv1,tv2,tv3>::* \
86 86
     func##tv1##tv2##tv3##concept)(); \
87 87
  template <func##tv1##tv2##tv3##concept Tp1_> \
88 88
  struct concept_checking_##tv1##tv2##tv3##concept { }; \
89 89
  typedef concept_checking_##tv1##tv2##tv3##concept< \
90 90
    BOOST_FPTR ns::concept<tv1,tv2,tv3>::constraints> \
91 91
    concept_checking_typedef_##tv1##tv2##tv3##concept
92 92

	
93 93
#define BOOST_CLASS_REQUIRE4(tv1, tv2, tv3, tv4, ns, concept) \
94 94
  typedef void (ns::concept <tv1,tv2,tv3,tv4>::* \
95 95
     func##tv1##tv2##tv3##tv4##concept)(); \
96 96
  template <func##tv1##tv2##tv3##tv4##concept Tp1_> \
97 97
  struct concept_checking_##tv1##tv2##tv3##tv4##concept { }; \
98 98
  typedef concept_checking_##tv1##tv2##tv3##tv4##concept< \
99 99
    BOOST_FPTR ns::concept<tv1,tv2,tv3,tv4>::constraints> \
100 100
    concept_checking_typedef_##tv1##tv2##tv3##tv4##concept
101 101

	
102 102

	
103 103
} // namespace lemon
104 104

	
105 105
#endif // LEMON_CONCEPT_CHECKS_H
Ignore white space 6 line context
1 1
/* -*- C++ -*-
2 2
 *
3 3
 * This file is a part of LEMON, a generic C++ optimization library
4 4
 *
5
 * Copyright (C) 2003-2007
5
 * Copyright (C) 2003-2008
6 6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
8 8
 *
9 9
 * Permission to use, modify and distribute this software is granted
10 10
 * provided that this copyright notice appears in all copies. For
11 11
 * precise terms see the accompanying LICENSE file.
12 12
 *
13 13
 * This software is provided "AS IS" with no warranty of any kind,
14 14
 * express or implied, and with no claim as to its suitability for any
15 15
 * purpose.
16 16
 *
17 17
 */
18 18

	
19 19
#ifndef LEMON_CONCEPT_MAPS_H
20 20
#define LEMON_CONCEPT_MAPS_H
21 21

	
22 22
#include <lemon/bits/utility.h>
23 23
#include <lemon/concept_check.h>
24 24

	
25 25
///\ingroup concept
26 26
///\file
27 27
///\brief Map concepts checking classes for testing and documenting.
28 28

	
29 29
namespace lemon {
30 30

	
31 31
  namespace concepts {
32 32
  
33 33
    /// \addtogroup concept
34 34
    /// @{
35 35

	
36 36
    /// Readable map concept
37 37

	
38 38
    /// Readable map concept.
39 39
    ///
40 40
    template<typename K, typename T>
41 41
    class ReadMap
42 42
    {
43 43
    public:
44 44
      /// The key type of the map.
45 45
      typedef K Key;    
46 46
      /// The value type of the map. (The type of objects associated with the keys).
47 47
      typedef T Value;
48 48

	
49 49
      /// Returns the value associated with a key.
50 50

	
51 51
      /// \bug Value shouldn't need to be default constructible.
52 52
      ///
53 53
      Value operator[](const Key &) const {return Value();}
54 54

	
55 55
      template<typename _ReadMap>
56 56
      struct Constraints {
57 57

	
58 58
	void constraints() {
59 59
	  Value val = m[key];
60 60
	  val = m[key];
61 61
	  typename _ReadMap::Value own_val = m[own_key]; 
62 62
	  own_val = m[own_key]; 
63 63

	
64 64
	  ignore_unused_variable_warning(val);
65 65
	  ignore_unused_variable_warning(own_val);
66 66
	  ignore_unused_variable_warning(key);
67 67
	}
68 68
	Key& key;
69 69
	typename _ReadMap::Key& own_key;
70 70
	_ReadMap& m;
71 71
      };
72 72
      
73 73
    };
74 74

	
75 75

	
76 76
    /// Writable map concept
77 77
    
78 78
    /// Writable map concept.
79 79
    ///
80 80
    template<typename K, typename T>
81 81
    class WriteMap
82 82
    {
83 83
    public:
84 84
      /// The key type of the map.
85 85
      typedef K Key;    
86 86
      /// The value type of the map. (The type of objects associated with the keys).
87 87
      typedef T Value;
88 88

	
89 89
      /// Sets the value associated with a key.
90 90
      void set(const Key &,const Value &) {}
91 91

	
92 92
      ///Default constructor
93 93
      WriteMap() {}
94 94

	
95 95
      template <typename _WriteMap>
96 96
      struct Constraints {
97 97
	void constraints() {
98 98
	  // No constraints for constructor.
99 99
	  m.set(key, val);
100 100
	  m.set(own_key, own_val);
101 101
	  ignore_unused_variable_warning(key);
102 102
	  ignore_unused_variable_warning(val);
103 103
	  ignore_unused_variable_warning(own_key);
104 104
	  ignore_unused_variable_warning(own_val);
105 105
	}
106 106

	
107 107
	Value& val;
108 108
	typename _WriteMap::Value own_val;
109 109
	Key& key;
110 110
	typename _WriteMap::Key& own_key;
111 111
	_WriteMap& m;
112 112

	
113 113
      };
114 114
    };
115 115

	
116 116
    /// Read/Writable map concept
117 117
    
118 118
    /// Read/writable map concept.
119 119
    ///
120 120
    template<typename K, typename T>
121 121
    class ReadWriteMap : public ReadMap<K,T>,
122 122
			 public WriteMap<K,T>
123 123
    {
124 124
    public:
125 125
      /// The key type of the map.
126 126
      typedef K Key;    
127 127
      /// The value type of the map. (The type of objects associated with the keys).
128 128
      typedef T Value;
129 129

	
130 130
      /// Returns the value associated with a key.
131 131
      Value operator[](const Key &) const {return Value();}
132 132
      /// Sets the value associated with a key.
133 133
      void set(const Key & ,const Value &) {}
134 134

	
135 135
      template<typename _ReadWriteMap>
136 136
      struct Constraints {
137 137
	void constraints() {
138 138
	  checkConcept<ReadMap<K, T>, _ReadWriteMap >();
139 139
	  checkConcept<WriteMap<K, T>, _ReadWriteMap >();
140 140
	}
141 141
      };
142 142
    };
143 143
  
144 144
  
145 145
    /// Dereferable map concept
146 146
    
147 147
    /// Dereferable map concept.
148 148
    ///
149 149
    template<typename K, typename T, typename R, typename CR>
150 150
    class ReferenceMap : public ReadWriteMap<K,T>
151 151
    {
152 152
    public:
153 153
      /// Tag for reference maps.
154 154
      typedef True ReferenceMapTag;
155 155
      /// The key type of the map.
156 156
      typedef K Key;    
157 157
      /// The value type of the map. (The type of objects associated with the keys).
158 158
      typedef T Value;
159 159
      /// The reference type of the map.
160 160
      typedef R Reference;
161 161
      /// The const reference type of the map.
162 162
      typedef CR ConstReference;
163 163

	
164 164
    protected:
165 165
      Value tmp;
166 166
    public:
167 167

	
168 168
      ///Returns a reference to the value associated to a key.
169 169
      Reference operator[](const Key &) { return tmp; }
170 170
      ///Returns a const reference to the value associated to a key.
171 171
      ConstReference operator[](const Key &) const { return tmp; }
172 172
      /// Sets the value associated with a key.
173 173
      void set(const Key &k,const Value &t) { operator[](k)=t; }
174 174

	
175 175
      /// \todo Rethink this concept. 
176 176
      template<typename _ReferenceMap>
177 177
      struct ReferenceMapConcept {
178 178

	
179 179
	void constraints() {
180 180
	  checkConcept<ReadWriteMap, _ReferenceMap >();
181 181
	  m[key] = val;
182 182
	  val  = m[key];
183 183
	  m[key] = ref;
184 184
	  ref = m[key];
185 185
	  m[own_key] = own_val;
186 186
	  own_val  = m[own_key];
187 187
	  m[own_key] = own_ref;
188 188
	  own_ref = m[own_key];	  	  
189 189
	}
190 190

	
191 191
	typename _ReferenceMap::Key& own_key;
192 192
	typename _ReferenceMap::Value& own_val;
193 193
	typename _ReferenceMap::Reference& own_ref;
194 194
	Key& key;
195 195
	Value& val;
196 196
	Reference& ref;
197 197
	_ReferenceMap& m;
198 198
      };
199 199
    };
200 200

	
201 201
    // @}
202 202

	
203 203
  } //namespace concepts
204 204

	
205 205
} //namespace lemon
206 206

	
207 207
#endif // LEMON_CONCEPT_MAPS_H
Ignore white space 6 line context
1 1
/* -*- C++ -*-
2 2
 *
3 3
 * This file is a part of LEMON, a generic C++ optimization library
4 4
 *
5
 * Copyright (C) 2003-2007
5
 * Copyright (C) 2003-2008
6 6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
8 8
 *
9 9
 * Permission to use, modify and distribute this software is granted
10 10
 * provided that this copyright notice appears in all copies. For
11 11
 * precise terms see the accompanying LICENSE file.
12 12
 *
13 13
 * This software is provided "AS IS" with no warranty of any kind,
14 14
 * express or implied, and with no claim as to its suitability for any
15 15
 * purpose.
16 16
 *
17 17
 */
18 18

	
19 19
#ifndef LEMON_DIM2_H
20 20
#define LEMON_DIM2_H
21 21

	
22 22
#include <iostream>
23 23
#include <lemon/bits/utility.h>
24 24

	
25 25
///\ingroup misc
26 26
///\file
27 27
///\brief A simple two dimensional vector and a bounding box implementation 
28 28
///
29 29
/// The class \ref lemon::dim2::Point "dim2::Point" implements
30 30
///a two dimensional vector with the usual
31 31
/// operations.
32 32
///
33 33
/// The class \ref lemon::dim2::BoundingBox "dim2::BoundingBox"
34 34
/// can be used to determine
35 35
/// the rectangular bounding box of a set of
36 36
/// \ref lemon::dim2::Point "dim2::Point"'s.
37 37

	
38 38
namespace lemon {
39 39

	
40 40
  ///Tools for handling two dimensional coordinates
41 41

	
42 42
  ///This namespace is a storage of several
43 43
  ///tools for handling two dimensional coordinates
44 44
  namespace dim2 {
45 45

	
46 46
  /// \addtogroup misc
47 47
  /// @{
48 48

	
49 49
  /// A simple two dimensional vector (plainvector) implementation
50 50

	
51 51
  /// A simple two dimensional vector (plainvector) implementation
52 52
  ///with the usual vector
53 53
  /// operators.
54 54
  ///
55 55
  template<typename T>
56 56
    class Point {
57 57

	
58 58
    public:
59 59

	
60 60
      typedef T Value;
61 61

	
62 62
      ///First coordinate
63 63
      T x;
64 64
      ///Second coordinate
65 65
      T y;     
66 66
      
67 67
      ///Default constructor
68 68
      Point() {}
69 69

	
70 70
      ///Construct an instance from coordinates
71 71
      Point(T a, T b) : x(a), y(b) { }
72 72

	
73 73
      ///The dimension of the vector.
74 74

	
75 75
      ///The dimension of the vector.
76 76
      ///This function always returns 2. 
77 77
      int size() const { return 2; }
78 78

	
79 79
      ///Subscripting operator
80 80

	
81 81
      ///\c p[0] is \c p.x and \c p[1] is \c p.y
82 82
      ///
83 83
      T& operator[](int idx) { return idx == 0 ? x : y; }
84 84

	
85 85
      ///Const subscripting operator
86 86

	
87 87
      ///\c p[0] is \c p.x and \c p[1] is \c p.y
88 88
      ///
89 89
      const T& operator[](int idx) const { return idx == 0 ? x : y; }
90 90

	
91 91
      ///Conversion constructor
92 92
      template<class TT> Point(const Point<TT> &p) : x(p.x), y(p.y) {}
93 93

	
94 94
      ///Give back the square of the norm of the vector
95 95
      T normSquare() const {
96 96
        return x*x+y*y;
97 97
      }
98 98
  
99 99
      ///Increment the left hand side by u
100 100
      Point<T>& operator +=(const Point<T>& u) {
101 101
        x += u.x;
102 102
        y += u.y;
103 103
        return *this;
104 104
      }
105 105
  
106 106
      ///Decrement the left hand side by u
107 107
      Point<T>& operator -=(const Point<T>& u) {
108 108
        x -= u.x;
109 109
        y -= u.y;
110 110
        return *this;
111 111
      }
112 112

	
113 113
      ///Multiply the left hand side with a scalar
114 114
      Point<T>& operator *=(const T &u) {
115 115
        x *= u;
116 116
        y *= u;
117 117
        return *this;
118 118
      }
119 119

	
120 120
      ///Divide the left hand side by a scalar
121 121
      Point<T>& operator /=(const T &u) {
122 122
        x /= u;
123 123
        y /= u;
124 124
        return *this;
125 125
      }
126 126
  
127 127
      ///Return the scalar product of two vectors
128 128
      T operator *(const Point<T>& u) const {
129 129
        return x*u.x+y*u.y;
130 130
      }
131 131
  
132 132
      ///Return the sum of two vectors
133 133
      Point<T> operator+(const Point<T> &u) const {
134 134
        Point<T> b=*this;
135 135
        return b+=u;
136 136
      }
137 137

	
138 138
      ///Return the negative of the vector
139 139
      Point<T> operator-() const {
140 140
        Point<T> b=*this;
141 141
        b.x=-b.x; b.y=-b.y;
142 142
        return b;
143 143
      }
144 144

	
145 145
      ///Return the difference of two vectors
146 146
      Point<T> operator-(const Point<T> &u) const {
147 147
        Point<T> b=*this;
148 148
        return b-=u;
149 149
      }
150 150

	
151 151
      ///Return a vector multiplied by a scalar
152 152
      Point<T> operator*(const T &u) const {
153 153
        Point<T> b=*this;
154 154
        return b*=u;
155 155
      }
156 156

	
157 157
      ///Return a vector divided by a scalar
158 158
      Point<T> operator/(const T &u) const {
159 159
        Point<T> b=*this;
160 160
        return b/=u;
161 161
      }
162 162

	
163 163
      ///Test equality
164 164
      bool operator==(const Point<T> &u) const {
165 165
        return (x==u.x) && (y==u.y);
166 166
      }
167 167

	
168 168
      ///Test inequality
169 169
      bool operator!=(Point u) const {
170 170
        return  (x!=u.x) || (y!=u.y);
171 171
      }
172 172

	
173 173
    };
174 174

	
175 175
  ///Return a Point 
176 176

	
177 177
  ///Return a Point.
178 178
  ///\relates Point
179 179
  template <typename T>
180 180
  inline Point<T> makePoint(const T& x, const T& y) {
181 181
    return Point<T>(x, y);
182 182
  }
183 183

	
184 184
  ///Return a vector multiplied by a scalar
185 185

	
186 186
  ///Return a vector multiplied by a scalar.
187 187
  ///\relates Point
188 188
  template<typename T> Point<T> operator*(const T &u,const Point<T> &x) {
189 189
    return x*u;
190 190
  }
191 191

	
192 192
  ///Read a plainvector from a stream
193 193

	
194 194
  ///Read a plainvector from a stream.
195 195
  ///\relates Point
196 196
  ///
197 197
  template<typename T>
198 198
  inline std::istream& operator>>(std::istream &is, Point<T> &z) {
199 199
    char c;
200 200
    if (is >> c) {
201 201
      if (c != '(') is.putback(c);
202 202
    } else {
203 203
      is.clear();
204 204
    }
205 205
    if (!(is >> z.x)) return is;
206 206
    if (is >> c) {
207 207
      if (c != ',') is.putback(c);
208 208
    } else {
209 209
      is.clear();
210 210
    }
211 211
    if (!(is >> z.y)) return is;
212 212
    if (is >> c) {
213 213
      if (c != ')') is.putback(c);
214 214
    } else {
215 215
      is.clear();
216 216
    }
217 217
    return is;
218 218
  }
219 219

	
220 220
  ///Write a plainvector to a stream
221 221

	
222 222
  ///Write a plainvector to a stream.
223 223
  ///\relates Point
224 224
  ///
225 225
  template<typename T>
226 226
  inline std::ostream& operator<<(std::ostream &os, const Point<T>& z)
227 227
  {
228 228
    os << "(" << z.x << ", " << z.y << ")";
229 229
    return os;
230 230
  }
231 231

	
232 232
  ///Rotate by 90 degrees
233 233

	
234 234
  ///Returns the parameter rotated by 90 degrees in positive direction.
235 235
  ///\relates Point
236 236
  ///
237 237
  template<typename T>
238 238
  inline Point<T> rot90(const Point<T> &z)
239 239
  {
240 240
    return Point<T>(-z.y,z.x);
241 241
  }
242 242

	
243 243
  ///Rotate by 180 degrees
244 244

	
245 245
  ///Returns the parameter rotated by 180 degrees.
246 246
  ///\relates Point
247 247
  ///
248 248
  template<typename T>
249 249
  inline Point<T> rot180(const Point<T> &z)
250 250
  {
251 251
    return Point<T>(-z.x,-z.y);
252 252
  }
253 253

	
254 254
  ///Rotate by 270 degrees
255 255

	
256 256
  ///Returns the parameter rotated by 90 degrees in negative direction.
257 257
  ///\relates Point
258 258
  ///
259 259
  template<typename T>
260 260
  inline Point<T> rot270(const Point<T> &z)
261 261
  {
262 262
    return Point<T>(z.y,-z.x);
263 263
  }
264 264

	
265 265
  
266 266

	
267 267
  /// A class to calculate or store the bounding box of plainvectors.
268 268

	
269 269
  /// A class to calculate or store the bounding box of plainvectors.
270 270
  ///
271 271
    template<typename T>
272 272
    class BoundingBox {
273 273
      Point<T> bottom_left, top_right;
274 274
      bool _empty;
275 275
    public:
276 276
      
277 277
      ///Default constructor: creates an empty bounding box
278 278
      BoundingBox() { _empty = true; }
279 279

	
280 280
      ///Construct an instance from one point
281 281
      BoundingBox(Point<T> a) { bottom_left=top_right=a; _empty = false; }
282 282
      
283 283
      ///Construct an instance from two points
284 284
      
285 285
      ///Construct an instance from two points.
286 286
      ///\param a The bottom left corner.
287 287
      ///\param b The top right corner.
288 288
      ///\warning The coordinates of the bottom left corner must be no more
289 289
      ///than those of the top right one.
290 290
      BoundingBox(Point<T> a,Point<T> b)
291 291
      {
292 292
	bottom_left=a;
293 293
	top_right=b;
294 294
	_empty = false;
295 295
      }
296 296
      
297 297
      ///Construct an instance from four numbers
298 298

	
299 299
      ///Construct an instance from four numbers.
300 300
      ///\param l The left side of the box.
301 301
      ///\param b The bottom of the box.
302 302
      ///\param r The right side of the box.
303 303
      ///\param t The top of the box.
304 304
      ///\warning The left side must be no more than the right side and
305 305
      ///bottom must be no more than the top. 
306 306
      BoundingBox(T l,T b,T r,T t)
307 307
      {
308 308
	bottom_left=Point<T>(l,b);
309 309
	top_right=Point<T>(r,t);
310 310
	_empty = false;
311 311
      }
312 312
      
313 313
      ///Return \c true if the bounding box is empty.
314 314
      
315 315
      ///Return \c true if the bounding box is empty (i.e. return \c false
316 316
      ///if at least one point was added to the box or the coordinates of
317 317
      ///the box were set).
318 318
      ///The coordinates of an empty bounding box are not defined. 
319 319
      bool empty() const {
320 320
        return _empty;
321 321
      }
322 322
      
323 323
      ///Make the BoundingBox empty
324 324
      void clear() {
325 325
        _empty=1;
326 326
      }
327 327

	
328 328
      ///Give back the bottom left corner
329 329

	
330 330
      ///Give back the bottom left corner.
331 331
      ///If the bounding box is empty, then the return value is not defined.
332 332
      Point<T> bottomLeft() const {
333 333
        return bottom_left;
334 334
      }
335 335

	
336 336
      ///Set the bottom left corner
337 337

	
338 338
      ///Set the bottom left corner.
339 339
      ///It should only be used for non-empty box.
340 340
      void bottomLeft(Point<T> p) {
341 341
	bottom_left = p;
342 342
      }
343 343

	
344 344
      ///Give back the top right corner
345 345

	
346 346
      ///Give back the top right corner.
347 347
      ///If the bounding box is empty, then the return value is not defined.
348 348
      Point<T> topRight() const {
349 349
        return top_right;
350 350
      }
351 351

	
352 352
      ///Set the top right corner
353 353

	
354 354
      ///Set the top right corner.
355 355
      ///It should only be used for non-empty box.
356 356
      void topRight(Point<T> p) {
357 357
	top_right = p;
358 358
      }
359 359

	
360 360
      ///Give back the bottom right corner
361 361

	
362 362
      ///Give back the bottom right corner.
363 363
      ///If the bounding box is empty, then the return value is not defined.
364 364
      Point<T> bottomRight() const {
365 365
        return Point<T>(top_right.x,bottom_left.y);
366 366
      }
367 367

	
368 368
      ///Set the bottom right corner
369 369

	
370 370
      ///Set the bottom right corner.
371 371
      ///It should only be used for non-empty box.
372 372
      void bottomRight(Point<T> p) {
373 373
	top_right.x = p.x;
374 374
	bottom_left.y = p.y;
375 375
      }
376 376
 
377 377
      ///Give back the top left corner
378 378

	
379 379
      ///Give back the top left corner.
380 380
      ///If the bounding box is empty, then the return value is not defined.
381 381
      Point<T> topLeft() const {
382 382
        return Point<T>(bottom_left.x,top_right.y);
383 383
      }
384 384

	
385 385
      ///Set the top left corner
386 386

	
387 387
      ///Set the top left corner.
388 388
      ///It should only be used for non-empty box.
389 389
      void topLeft(Point<T> p) {
390 390
	top_right.y = p.y;
391 391
	bottom_left.x = p.x;
392 392
      }
393 393

	
394 394
      ///Give back the bottom of the box
395 395

	
396 396
      ///Give back the bottom of the box.
397 397
      ///If the bounding box is empty, then the return value is not defined.
398 398
      T bottom() const {
399 399
        return bottom_left.y;
400 400
      }
401 401

	
402 402
      ///Set the bottom of the box
403 403

	
404 404
      ///Set the bottom of the box.
405 405
      ///It should only be used for non-empty box.
406 406
      void bottom(T t) {
407 407
	bottom_left.y = t;
408 408
      }
409 409

	
410 410
      ///Give back the top of the box
411 411

	
412 412
      ///Give back the top of the box.
413 413
      ///If the bounding box is empty, then the return value is not defined.
414 414
      T top() const {
415 415
        return top_right.y;
416 416
      }
417 417

	
418 418
      ///Set the top of the box
419 419

	
420 420
      ///Set the top of the box.
421 421
      ///It should only be used for non-empty box.
422 422
      void top(T t) {
423 423
	top_right.y = t;
424 424
      }
425 425

	
426 426
      ///Give back the left side of the box
427 427

	
428 428
      ///Give back the left side of the box.
429 429
      ///If the bounding box is empty, then the return value is not defined.
430 430
      T left() const {
431 431
        return bottom_left.x;
432 432
      }
433 433
 
434 434
      ///Set the left side of the box
435 435

	
436 436
      ///Set the left side of the box.
437 437
      ///It should only be used for non-empty box.
438 438
      void left(T t) {
439 439
	bottom_left.x = t;
440 440
      }
441 441

	
442 442
      /// Give back the right side of the box
443 443

	
444 444
      /// Give back the right side of the box.
445 445
      ///If the bounding box is empty, then the return value is not defined.
446 446
      T right() const {
447 447
        return top_right.x;
448 448
      }
449 449

	
450 450
      ///Set the right side of the box
451 451

	
452 452
      ///Set the right side of the box.
453 453
      ///It should only be used for non-empty box.
454 454
      void right(T t) {
455 455
	top_right.x = t;
456 456
      }
457 457

	
458 458
      ///Give back the height of the box
459 459

	
460 460
      ///Give back the height of the box.
461 461
      ///If the bounding box is empty, then the return value is not defined.
462 462
      T height() const {
463 463
        return top_right.y-bottom_left.y;
464 464
      }
465 465

	
466 466
      ///Give back the width of the box
467 467

	
468 468
      ///Give back the width of the box.
469 469
      ///If the bounding box is empty, then the return value is not defined.
470 470
      T width() const {
471 471
        return top_right.x-bottom_left.x;
472 472
      }
473 473

	
474 474
      ///Checks whether a point is inside a bounding box
475 475
      bool inside(const Point<T>& u) const {
476 476
        if (_empty)
477 477
          return false;
478 478
        else{
479 479
          return ((u.x-bottom_left.x)*(top_right.x-u.x) >= 0 &&
480 480
              (u.y-bottom_left.y)*(top_right.y-u.y) >= 0 );
481 481
        }
482 482
      }
483 483
  
484 484
      ///Increments a bounding box with a point
485 485

	
486 486
      ///Increments a bounding box with a point.
487 487
      ///
488 488
      BoundingBox& add(const Point<T>& u){
489 489
        if (_empty){
490 490
          bottom_left=top_right=u;
491 491
          _empty = false;
492 492
        }
493 493
        else{
494 494
          if (bottom_left.x > u.x) bottom_left.x = u.x;
495 495
          if (bottom_left.y > u.y) bottom_left.y = u.y;
496 496
          if (top_right.x < u.x) top_right.x = u.x;
497 497
          if (top_right.y < u.y) top_right.y = u.y;
498 498
        }
499 499
        return *this;
500 500
      }
501 501
    
502 502
      ///Increments a bounding box to contain another bounding box
503 503
      
504 504
      ///Increments a bounding box to contain another bounding box.
505 505
      ///
506 506
      BoundingBox& add(const BoundingBox &u){
507 507
        if ( !u.empty() ){
508 508
          this->add(u.bottomLeft());
509 509
	  this->add(u.topRight());
510 510
        }
511 511
        return *this;
512 512
      }
513 513
  
514 514
      ///Intersection of two bounding boxes
515 515

	
516 516
      ///Intersection of two bounding boxes.
517 517
      ///
518 518
      BoundingBox operator&(const BoundingBox& u) const {
519 519
        BoundingBox b;
520 520
        if (this->_empty || u._empty) {
521 521
	  b._empty = true;
522 522
	} else {
523 523
	  b.bottom_left.x = std::max(this->bottom_left.x,u.bottom_left.x);
524 524
	  b.bottom_left.y = std::max(this->bottom_left.y,u.bottom_left.y);
525 525
	  b.top_right.x = std::min(this->top_right.x,u.top_right.x);
526 526
	  b.top_right.y = std::min(this->top_right.y,u.top_right.y);
527 527
	  b._empty = b.bottom_left.x > b.top_right.x ||
528 528
	             b.bottom_left.y > b.top_right.y;
529 529
	} 
530 530
        return b;
531 531
      }
532 532

	
533 533
    };//class Boundingbox
534 534

	
535 535

	
536 536
  ///Map of x-coordinates of a \ref Point "Point"-map
537 537

	
538 538
  ///\ingroup maps
539 539
  ///Map of x-coordinates of a \ref Point "Point"-map.
540 540
  ///
541 541
  template<class M>
542 542
  class XMap 
543 543
  {
544 544
    M& _map;
545 545
  public:
546 546

	
547 547
    typedef typename M::Value::Value Value;
548 548
    typedef typename M::Key Key;
549 549
    ///\e
550 550
    XMap(M& map) : _map(map) {}
551 551
    Value operator[](Key k) const {return _map[k].x;}
552 552
    void set(Key k,Value v) {_map.set(k,typename M::Value(v,_map[k].y));}
553 553
  };
554 554
    
555 555
  ///Returns an \ref XMap class
556 556

	
557 557
  ///This function just returns an \ref XMap class.
558 558
  ///
559 559
  ///\ingroup maps
560 560
  ///\relates XMap
561 561
  template<class M> 
562 562
  inline XMap<M> xMap(M &m) 
563 563
  {
564 564
    return XMap<M>(m);
565 565
  }
566 566

	
567 567
  template<class M> 
568 568
  inline XMap<M> xMap(const M &m) 
569 569
  {
570 570
    return XMap<M>(m);
571 571
  }
572 572

	
573 573
  ///Constant (read only) version of \ref XMap
574 574

	
575 575
  ///\ingroup maps
576 576
  ///Constant (read only) version of \ref XMap
577 577
  ///
578 578
  template<class M>
579 579
  class ConstXMap 
580 580
  {
581 581
    const M& _map;
582 582
  public:
583 583

	
584 584
    typedef typename M::Value::Value Value;
585 585
    typedef typename M::Key Key;
586 586
    ///\e
587 587
    ConstXMap(const M &map) : _map(map) {}
588 588
    Value operator[](Key k) const {return _map[k].x;}
589 589
  };
590 590
    
591 591
  ///Returns a \ref ConstXMap class
592 592

	
593 593
  ///This function just returns a \ref ConstXMap class.
594 594
  ///
595 595
  ///\ingroup maps
596 596
  ///\relates ConstXMap
597 597
  template<class M> 
598 598
  inline ConstXMap<M> xMap(const M &m) 
599 599
  {
600 600
    return ConstXMap<M>(m);
601 601
  }
602 602

	
603 603
  ///Map of y-coordinates of a \ref Point "Point"-map
604 604
    
605 605
  ///\ingroup maps
606 606
  ///Map of y-coordinates of a \ref Point "Point"-map.
607 607
  ///
608 608
  template<class M>
609 609
  class YMap 
610 610
  {
611 611
    M& _map;
612 612
  public:
613 613

	
614 614
    typedef typename M::Value::Value Value;
615 615
    typedef typename M::Key Key;
616 616
    ///\e
617 617
    YMap(M& map) : _map(map) {}
618 618
    Value operator[](Key k) const {return _map[k].y;}
619 619
    void set(Key k,Value v) {_map.set(k,typename M::Value(_map[k].x,v));}
620 620
  };
621 621

	
622 622
  ///Returns a \ref YMap class
623 623

	
624 624
  ///This function just returns a \ref YMap class.
625 625
  ///
626 626
  ///\ingroup maps
627 627
  ///\relates YMap
628 628
  template<class M> 
629 629
  inline YMap<M> yMap(M &m) 
630 630
  {
631 631
    return YMap<M>(m);
632 632
  }
633 633

	
634 634
  template<class M> 
635 635
  inline YMap<M> yMap(const M &m) 
636 636
  {
637 637
    return YMap<M>(m);
638 638
  }
639 639

	
640 640
  ///Constant (read only) version of \ref YMap
641 641

	
642 642
  ///\ingroup maps
643 643
  ///Constant (read only) version of \ref YMap
644 644
  ///
645 645
  template<class M>
646 646
  class ConstYMap 
647 647
  {
648 648
    const M& _map;
649 649
  public:
650 650

	
651 651
    typedef typename M::Value::Value Value;
652 652
    typedef typename M::Key Key;
653 653
    ///\e
654 654
    ConstYMap(const M &map) : _map(map) {}
655 655
    Value operator[](Key k) const {return _map[k].y;}
656 656
  };
657 657
    
658 658
  ///Returns a \ref ConstYMap class
659 659

	
660 660
  ///This function just returns a \ref ConstYMap class.
661 661
  ///
662 662
  ///\ingroup maps
663 663
  ///\relates ConstYMap
664 664
  template<class M> 
665 665
  inline ConstYMap<M> yMap(const M &m) 
666 666
  {
667 667
    return ConstYMap<M>(m);
668 668
  }
669 669

	
670 670

	
671 671
    ///\brief Map of the \ref Point::normSquare() "normSquare()"
672 672
    ///of a \ref Point "Point"-map
673 673
    ///
674 674
    ///Map of the \ref Point::normSquare() "normSquare()"
675 675
    ///of a \ref Point "Point"-map.
676 676
    ///\ingroup maps
677 677
    ///
678 678
  template<class M>
679 679
  class NormSquareMap 
680 680
  {
681 681
    const M& _map;
682 682
  public:
683 683

	
684 684
    typedef typename M::Value::Value Value;
685 685
    typedef typename M::Key Key;
686 686
    ///\e
687 687
    NormSquareMap(const M &map) : _map(map) {}
688 688
    Value operator[](Key k) const {return _map[k].normSquare();}
689 689
  };
690 690
    
691 691
  ///Returns a \ref NormSquareMap class
692 692

	
693 693
  ///This function just returns a \ref NormSquareMap class.
694 694
  ///
695 695
  ///\ingroup maps
696 696
  ///\relates NormSquareMap
697 697
  template<class M> 
698 698
  inline NormSquareMap<M> normSquareMap(const M &m) 
699 699
  {
700 700
    return NormSquareMap<M>(m);
701 701
  }
702 702

	
703 703
  /// @}
704 704

	
705 705
  } //namespce dim2
706 706
  
707 707
} //namespace lemon
708 708

	
709 709
#endif //LEMON_DIM2_H
Ignore white space 6 line context
1
/* -*- C++ -*-
2
 *
3
 * This file is a part of LEMON, a generic C++ optimization library
4
 *
5
 * Copyright (C) 2003-2008
6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
8
 *
9
 * Permission to use, modify and distribute this software is granted
10
 * provided that this copyright notice appears in all copies. For
11
 * precise terms see the accompanying LICENSE file.
12
 *
13
 * This software is provided "AS IS" with no warranty of any kind,
14
 * express or implied, and with no claim as to its suitability for any
15
 * purpose.
16
 *
17
 */
18

	
Ignore white space 1536 line context
1 1
/* -*- C++ -*-
2 2
 *
3 3
 * This file is a part of LEMON, a generic C++ optimization library
4 4
 *
5
 * Copyright (C) 2003-2007
5
 * Copyright (C) 2003-2008
6 6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
8 8
 *
9 9
 * Permission to use, modify and distribute this software is granted
10 10
 * provided that this copyright notice appears in all copies. For
11 11
 * precise terms see the accompanying LICENSE file.
12 12
 *
13 13
 * This software is provided "AS IS" with no warranty of any kind,
14 14
 * express or implied, and with no claim as to its suitability for any
15 15
 * purpose.
16 16
 *
17 17
 */
18 18

	
19 19
#ifndef LEMON_MAPS_H
20 20
#define LEMON_MAPS_H
21 21

	
22 22
#include <iterator>
23 23
#include <functional>
24 24
#include <vector>
25 25

	
26 26
#include <lemon/bits/utility.h>
27 27
// #include <lemon/bits/traits.h>
28 28

	
29 29
///\file
30 30
///\ingroup maps
31 31
///\brief Miscellaneous property maps
32 32
///
33 33
#include <map>
34 34

	
35 35
namespace lemon {
36 36

	
37 37
  /// \addtogroup maps
38 38
  /// @{
39 39

	
40 40
  /// Base class of maps.
41 41

	
42 42
  /// Base class of maps.
43 43
  /// It provides the necessary <tt>typedef</tt>s required by the map concept.
44 44
  template<typename K, typename T>
45 45
  class MapBase {
46 46
  public:
47 47
    /// The key type of the map.
48 48
    typedef K Key;
49 49
    /// The value type of the map. (The type of objects associated with the keys).
50 50
    typedef T Value;
51 51
  };
52 52

	
53 53
  /// Null map. (a.k.a. DoNothingMap)
54 54

	
55 55
  /// This map can be used if you have to provide a map only for
56 56
  /// its type definitions, or if you have to provide a writable map, 
57 57
  /// but data written to it is not required (i.e. it will be sent to 
58 58
  /// <tt>/dev/null</tt>).
59 59
  template<typename K, typename T>
60 60
  class NullMap : public MapBase<K, T> {
61 61
  public:
62 62
    typedef MapBase<K, T> Parent;
63 63
    typedef typename Parent::Key Key;
64 64
    typedef typename Parent::Value Value;
65 65
    
66 66
    /// Gives back a default constructed element.
67 67
    T operator[](const K&) const { return T(); }
68 68
    /// Absorbs the value.
69 69
    void set(const K&, const T&) {}
70 70
  };
71 71

	
72 72
  ///Returns a \c NullMap class
73 73

	
74 74
  ///This function just returns a \c NullMap class.
75 75
  ///\relates NullMap
76 76
  template <typename K, typename V> 
77 77
  NullMap<K, V> nullMap() {
78 78
    return NullMap<K, V>();
79 79
  }
80 80

	
81 81

	
82 82
  /// Constant map.
83 83

	
84 84
  /// This is a readable map which assigns a specified value to each key.
85 85
  /// In other aspects it is equivalent to the \c NullMap.
86 86
  template<typename K, typename T>
87 87
  class ConstMap : public MapBase<K, T> {
88 88
  private:
89 89
    T v;
90 90
  public:
91 91

	
92 92
    typedef MapBase<K, T> Parent;
93 93
    typedef typename Parent::Key Key;
94 94
    typedef typename Parent::Value Value;
95 95

	
96 96
    /// Default constructor
97 97

	
98 98
    /// Default constructor.
99 99
    /// The value of the map will be uninitialized. 
100 100
    /// (More exactly it will be default constructed.)
101 101
    ConstMap() {}
102 102
    
103 103
    /// Constructor with specified initial value
104 104

	
105 105
    /// Constructor with specified initial value.
106 106
    /// \param _v is the initial value of the map.
107 107
    ConstMap(const T &_v) : v(_v) {}
108 108
    
109 109
    ///\e
110 110
    T operator[](const K&) const { return v; }
111 111

	
112 112
    ///\e
113 113
    void setAll(const T &t) {
114 114
      v = t;
115 115
    }    
116 116

	
117 117
    template<typename T1>
118 118
    struct rebind {
119 119
      typedef ConstMap<K, T1> other;
120 120
    };
121 121

	
122 122
    template<typename T1>
123 123
    ConstMap(const ConstMap<K, T1> &, const T &_v) : v(_v) {}
124 124
  };
125 125

	
126 126
  ///Returns a \c ConstMap class
127 127

	
128 128
  ///This function just returns a \c ConstMap class.
129 129
  ///\relates ConstMap
130 130
  template<typename K, typename V> 
131 131
  inline ConstMap<K, V> constMap(const V &v) {
132 132
    return ConstMap<K, V>(v);
133 133
  }
134 134

	
135 135

	
136 136
  template<typename T, T v>
137 137
  struct Const { };
138 138

	
139 139
  /// Constant map with inlined constant value.
140 140

	
141 141
  /// This is a readable map which assigns a specified value to each key.
142 142
  /// In other aspects it is equivalent to the \c NullMap.
143 143
  template<typename K, typename V, V v>
144 144
  class ConstMap<K, Const<V, v> > : public MapBase<K, V> {
145 145
  public:
146 146
    typedef MapBase<K, V> Parent;
147 147
    typedef typename Parent::Key Key;
148 148
    typedef typename Parent::Value Value;
149 149

	
150 150
    ConstMap() { }
151 151
    ///\e
152 152
    V operator[](const K&) const { return v; }
153 153
    ///\e
154 154
    void set(const K&, const V&) { }
155 155
  };
156 156

	
157 157
  ///Returns a \c ConstMap class
158 158

	
159 159
  ///This function just returns a \c ConstMap class with inlined value.
160 160
  ///\relates ConstMap
161 161
  template<typename K, typename V, V v> 
162 162
  inline ConstMap<K, Const<V, v> > constMap() {
163 163
    return ConstMap<K, Const<V, v> >();
164 164
  }
165 165

	
166 166
  ///Map based on std::map
167 167

	
168 168
  ///This is essentially a wrapper for \c std::map with addition that
169 169
  ///you can specify a default value different from \c Value().
170 170
  template <typename K, typename T, typename Compare = std::less<K> >
171 171
  class StdMap {
172 172
    template <typename K1, typename T1, typename C1>
173 173
    friend class StdMap;
174 174
  public:
175 175

	
176 176
    typedef True ReferenceMapTag;
177 177
    ///\e
178 178
    typedef K Key;
179 179
    ///\e
180 180
    typedef T Value;
181 181
    ///\e
182 182
    typedef T& Reference;
183 183
    ///\e
184 184
    typedef const T& ConstReference;
185 185

	
186 186
  private:
187 187
    
188 188
    typedef std::map<K, T, Compare> Map;
189 189
    Value _value;
190 190
    Map _map;
191 191

	
192 192
  public:
193 193

	
194 194
    /// Constructor with specified default value
195 195
    StdMap(const T& value = T()) : _value(value) {}
196 196
    /// \brief Constructs the map from an appropriate std::map, and explicitly
197 197
    /// specifies a default value.
198 198
    template <typename T1, typename Comp1>
199 199
    StdMap(const std::map<Key, T1, Comp1> &map, const T& value = T()) 
200 200
      : _map(map.begin(), map.end()), _value(value) {}
201 201
    
202 202
    /// \brief Constructs a map from an other StdMap.
203 203
    template<typename T1, typename Comp1>
204 204
    StdMap(const StdMap<Key, T1, Comp1> &c) 
205 205
      : _map(c._map.begin(), c._map.end()), _value(c._value) {}
206 206

	
207 207
  private:
208 208

	
209 209
    StdMap& operator=(const StdMap&);
210 210

	
211 211
  public:
212 212

	
213 213
    ///\e
214 214
    Reference operator[](const Key &k) {
215 215
      typename Map::iterator it = _map.lower_bound(k);
216 216
      if (it != _map.end() && !_map.key_comp()(k, it->first))
217 217
	return it->second;
218 218
      else
219 219
	return _map.insert(it, std::make_pair(k, _value))->second;
220 220
    }
221 221

	
222 222
    /// \e 
223 223
    ConstReference operator[](const Key &k) const {
224 224
      typename Map::const_iterator it = _map.find(k);
225 225
      if (it != _map.end())
226 226
	return it->second;
227 227
      else
228 228
	return _value;
229 229
    }
230 230

	
231 231
    /// \e 
232 232
    void set(const Key &k, const T &t) {
233 233
      typename Map::iterator it = _map.lower_bound(k);
234 234
      if (it != _map.end() && !_map.key_comp()(k, it->first))
235 235
	it->second = t;
236 236
      else
237 237
	_map.insert(it, std::make_pair(k, t));
238 238
    }
239 239

	
240 240
    /// \e
241 241
    void setAll(const T &t) {
242 242
      _value = t;
243 243
      _map.clear();
244 244
    }    
245 245

	
246 246
    template <typename T1, typename C1 = std::less<T1> >
247 247
    struct rebind {
248 248
      typedef StdMap<Key, T1, C1> other;
249 249
    };
250 250
  };
251 251

	
252 252
  /// \brief Map for storing values for keys from the range <tt>[0..size-1]</tt>
253 253
  ///
254 254
  /// The current map has the <tt>[0..size-1]</tt> keyset and the values
255 255
  /// are stored in a \c std::vector<T>  container. It can be used with
256 256
  /// some data structures, for example \c UnionFind, \c BinHeap, when 
257 257
  /// the used items are small integer numbers. 
258 258
  ///
259 259
  /// \todo Revise its name
260 260
  template <typename T>
261 261
  class IntegerMap {
262 262

	
263 263
    template <typename T1>
264 264
    friend class IntegerMap;
265 265

	
266 266
  public:
267 267

	
268 268
    typedef True ReferenceMapTag;
269 269
    ///\e
270 270
    typedef int Key;
271 271
    ///\e
272 272
    typedef T Value;
273 273
    ///\e
274 274
    typedef T& Reference;
275 275
    ///\e
276 276
    typedef const T& ConstReference;
277 277

	
278 278
  private:
279 279
    
280 280
    typedef std::vector<T> Vector;
281 281
    Vector _vector;
282 282

	
283 283
  public:
284 284

	
285 285
    /// Constructor with specified default value
286 286
    IntegerMap(int size = 0, const T& value = T()) : _vector(size, value) {}
287 287

	
288 288
    /// \brief Constructs the map from an appropriate std::vector.
289 289
    template <typename T1>
290 290
    IntegerMap(const std::vector<T1>& vector) 
291 291
      : _vector(vector.begin(), vector.end()) {}
292 292
    
293 293
    /// \brief Constructs a map from an other IntegerMap.
294 294
    template <typename T1>
295 295
    IntegerMap(const IntegerMap<T1> &c) 
296 296
      : _vector(c._vector.begin(), c._vector.end()) {}
297 297

	
298 298
    /// \brief Resize the container
299 299
    void resize(int size, const T& value = T()) {
300 300
      _vector.resize(size, value);
301 301
    }
302 302

	
303 303
  private:
304 304

	
305 305
    IntegerMap& operator=(const IntegerMap&);
306 306

	
307 307
  public:
308 308

	
309 309
    ///\e
310 310
    Reference operator[](Key k) {
311 311
      return _vector[k];
312 312
    }
313 313

	
314 314
    /// \e 
315 315
    ConstReference operator[](Key k) const {
316 316
      return _vector[k];
317 317
    }
318 318

	
319 319
    /// \e 
320 320
    void set(const Key &k, const T& t) {
321 321
      _vector[k] = t;
322 322
    }
323 323

	
324 324
  };
325 325

	
326 326
  /// @}
327 327

	
328 328
  /// \addtogroup map_adaptors
329 329
  /// @{
330 330

	
331 331
  /// \brief Identity map.
332 332
  ///
333 333
  /// This map gives back the given key as value without any
334 334
  /// modification. 
335 335
  template <typename T>
336 336
  class IdentityMap : public MapBase<T, T> {
337 337
  public:
338 338
    typedef MapBase<T, T> Parent;
339 339
    typedef typename Parent::Key Key;
340 340
    typedef typename Parent::Value Value;
341 341

	
342 342
    /// \e
343 343
    const T& operator[](const T& t) const {
344 344
      return t;
345 345
    }
346 346
  };
347 347

	
348 348
  ///Returns an \c IdentityMap class
349 349

	
350 350
  ///This function just returns an \c IdentityMap class.
351 351
  ///\relates IdentityMap
352 352
  template<typename T>
353 353
  inline IdentityMap<T> identityMap() {
354 354
    return IdentityMap<T>();
355 355
  }
356 356
  
357 357

	
358 358
  ///\brief Convert the \c Value of a map to another type using
359 359
  ///the default conversion.
360 360
  ///
361 361
  ///This \c concepts::ReadMap "read only map"
362 362
  ///converts the \c Value of a map to type \c T.
363 363
  ///Its \c Key is inherited from \c M.
364 364
  template <typename M, typename T> 
365 365
  class ConvertMap : public MapBase<typename M::Key, T> {
366 366
    const M& m;
367 367
  public:
368 368
    typedef MapBase<typename M::Key, T> Parent;
369 369
    typedef typename Parent::Key Key;
370 370
    typedef typename Parent::Value Value;
371 371

	
372 372
    ///Constructor
373 373

	
374 374
    ///Constructor.
375 375
    ///\param _m is the underlying map.
376 376
    ConvertMap(const M &_m) : m(_m) {};
377 377

	
378 378
    /// \brief The subscript operator.
379 379
    ///
380 380
    /// The subscript operator.
381 381
    Value operator[](const Key& k) const {return m[k];}
382 382
  };
383 383
  
384 384
  ///Returns a \c ConvertMap class
385 385

	
386 386
  ///This function just returns a \c ConvertMap class.
387 387
  ///\relates ConvertMap
388 388
  template<typename T, typename M>
389 389
  inline ConvertMap<M, T> convertMap(const M &m) {
390 390
    return ConvertMap<M, T>(m);
391 391
  }
392 392

	
393 393
  ///Simple wrapping of a map
394 394

	
395 395
  ///This \c concepts::ReadMap "read only map" returns the simple
396 396
  ///wrapping of the given map. Sometimes the reference maps cannot be
397 397
  ///combined with simple read maps. This map adaptor wraps the given
398 398
  ///map to simple read map.
399 399
  ///
400 400
  ///\sa SimpleWriteMap
401 401
  ///
402 402
  /// \todo Revise the misleading name 
403 403
  template<typename M> 
404 404
  class SimpleMap : public MapBase<typename M::Key, typename M::Value> {
405 405
    const M& m;
406 406

	
407 407
  public:
408 408
    typedef MapBase<typename M::Key, typename M::Value> Parent;
409 409
    typedef typename Parent::Key Key;
410 410
    typedef typename Parent::Value Value;
411 411

	
412 412
    ///Constructor
413 413
    SimpleMap(const M &_m) : m(_m) {};
414 414
    ///\e
415 415
    Value operator[](Key k) const {return m[k];}
416 416
  };
417 417

	
418 418
  ///Simple writable wrapping of the map
419 419

	
420 420
  ///This \c concepts::WriteMap "write map" returns the simple
421 421
  ///wrapping of the given map. Sometimes the reference maps cannot be
422 422
  ///combined with simple read-write maps. This map adaptor wraps the
423 423
  ///given map to simple read-write map.
424 424
  ///
425 425
  ///\sa SimpleMap
426 426
  ///
427 427
  /// \todo Revise the misleading name
428 428
  template<typename M> 
429 429
  class SimpleWriteMap : public MapBase<typename M::Key, typename M::Value> {
430 430
    M& m;
431 431

	
432 432
  public:
433 433
    typedef MapBase<typename M::Key, typename M::Value> Parent;
434 434
    typedef typename Parent::Key Key;
435 435
    typedef typename Parent::Value Value;
436 436

	
437 437
    ///Constructor
438 438
    SimpleWriteMap(M &_m) : m(_m) {};
439 439
    ///\e
440 440
    Value operator[](Key k) const {return m[k];}
441 441
    ///\e
442 442
    void set(Key k, const Value& c) { m.set(k, c); }
443 443
  };
444 444

	
445 445
  ///Sum of two maps
446 446

	
447 447
  ///This \c concepts::ReadMap "read only map" returns the sum of the two
448 448
  ///given maps.
449 449
  ///Its \c Key and \c Value are inherited from \c M1.
450 450
  ///The \c Key and \c Value of M2 must be convertible to those of \c M1.
451 451
  template<typename M1, typename M2> 
452 452
  class AddMap : public MapBase<typename M1::Key, typename M1::Value> {
453 453
    const M1& m1;
454 454
    const M2& m2;
455 455

	
456 456
  public:
457 457
    typedef MapBase<typename M1::Key, typename M1::Value> Parent;
458 458
    typedef typename Parent::Key Key;
459 459
    typedef typename Parent::Value Value;
460 460

	
461 461
    ///Constructor
462 462
    AddMap(const M1 &_m1,const M2 &_m2) : m1(_m1), m2(_m2) {};
463 463
    ///\e
464 464
    Value operator[](Key k) const {return m1[k]+m2[k];}
465 465
  };
466 466
  
467 467
  ///Returns an \c AddMap class
468 468

	
469 469
  ///This function just returns an \c AddMap class.
470 470
  ///\todo How to call these type of functions?
471 471
  ///
472 472
  ///\relates AddMap
473 473
  template<typename M1, typename M2> 
474 474
  inline AddMap<M1, M2> addMap(const M1 &m1,const M2 &m2) {
475 475
    return AddMap<M1, M2>(m1,m2);
476 476
  }
477 477

	
478 478
  ///Shift a map with a constant.
479 479

	
480 480
  ///This \c concepts::ReadMap "read only map" returns the sum of the
481 481
  ///given map and a constant value.
482 482
  ///Its \c Key and \c Value are inherited from \c M.
483 483
  ///
484 484
  ///Actually,
485 485
  ///\code
486 486
  ///  ShiftMap<X> sh(x,v);
487 487
  ///\endcode
488 488
  ///is equivalent to
489 489
  ///\code
490 490
  ///  ConstMap<X::Key, X::Value> c_tmp(v);
491 491
  ///  AddMap<X, ConstMap<X::Key, X::Value> > sh(x,v);
492 492
  ///\endcode
493 493
  ///
494 494
  ///\sa ShiftWriteMap
495 495
  template<typename M, typename C = typename M::Value> 
496 496
  class ShiftMap : public MapBase<typename M::Key, typename M::Value> {
497 497
    const M& m;
498 498
    C v;
499 499
  public:
500 500
    typedef MapBase<typename M::Key, typename M::Value> Parent;
501 501
    typedef typename Parent::Key Key;
502 502
    typedef typename Parent::Value Value;
503 503

	
504 504
    ///Constructor
505 505

	
506 506
    ///Constructor.
507 507
    ///\param _m is the undelying map.
508 508
    ///\param _v is the shift value.
509 509
    ShiftMap(const M &_m, const C &_v ) : m(_m), v(_v) {};
510 510
    ///\e
511 511
    Value operator[](Key k) const {return m[k] + v;}
512 512
  };
513 513

	
514 514
  ///Shift a map with a constant (ReadWrite version).
515 515

	
516 516
  ///This \c concepts::ReadWriteMap "read-write map" returns the sum of the
517 517
  ///given map and a constant value. It makes also possible to write the map.
518 518
  ///Its \c Key and \c Value are inherited from \c M.
519 519
  ///
520 520
  ///\sa ShiftMap
521 521
  template<typename M, typename C = typename M::Value> 
522 522
  class ShiftWriteMap : public MapBase<typename M::Key, typename M::Value> {
523 523
    M& m;
524 524
    C v;
525 525
  public:
526 526
    typedef MapBase<typename M::Key, typename M::Value> Parent;
527 527
    typedef typename Parent::Key Key;
528 528
    typedef typename Parent::Value Value;
529 529

	
530 530
    ///Constructor
531 531

	
532 532
    ///Constructor.
533 533
    ///\param _m is the undelying map.
534 534
    ///\param _v is the shift value.
535 535
    ShiftWriteMap(M &_m, const C &_v ) : m(_m), v(_v) {};
536 536
    /// \e
537 537
    Value operator[](Key k) const {return m[k] + v;}
538 538
    /// \e
539 539
    void set(Key k, const Value& c) { m.set(k, c - v); }
540 540
  };
541 541
  
542 542
  ///Returns a \c ShiftMap class
543 543

	
544 544
  ///This function just returns a \c ShiftMap class.
545 545
  ///\relates ShiftMap
546 546
  template<typename M, typename C> 
547 547
  inline ShiftMap<M, C> shiftMap(const M &m,const C &v) {
548 548
    return ShiftMap<M, C>(m,v);
549 549
  }
550 550

	
551 551
  ///Returns a \c ShiftWriteMap class
552 552

	
553 553
  ///This function just returns a \c ShiftWriteMap class.
554 554
  ///\relates ShiftWriteMap
555 555
  template<typename M, typename C> 
556 556
  inline ShiftWriteMap<M, C> shiftMap(M &m,const C &v) {
557 557
    return ShiftWriteMap<M, C>(m,v);
558 558
  }
559 559

	
560 560
  ///Difference of two maps
561 561

	
562 562
  ///This \c concepts::ReadMap "read only map" returns the difference
563 563
  ///of the values of the two given maps.
564 564
  ///Its \c Key and \c Value are inherited from \c M1.
565 565
  ///The \c Key and \c Value of \c M2 must be convertible to those of \c M1.
566 566
  ///
567 567
  /// \todo Revise the misleading name
568 568
  template<typename M1, typename M2> 
569 569
  class SubMap : public MapBase<typename M1::Key, typename M1::Value> {
570 570
    const M1& m1;
571 571
    const M2& m2;
572 572
  public:
573 573
    typedef MapBase<typename M1::Key, typename M1::Value> Parent;
574 574
    typedef typename Parent::Key Key;
575 575
    typedef typename Parent::Value Value;
576 576

	
577 577
    ///Constructor
578 578
    SubMap(const M1 &_m1,const M2 &_m2) : m1(_m1), m2(_m2) {};
579 579
    /// \e
580 580
    Value operator[](Key k) const {return m1[k]-m2[k];}
581 581
  };
582 582
  
583 583
  ///Returns a \c SubMap class
584 584

	
585 585
  ///This function just returns a \c SubMap class.
586 586
  ///
587 587
  ///\relates SubMap
588 588
  template<typename M1, typename M2> 
589 589
  inline SubMap<M1, M2> subMap(const M1 &m1, const M2 &m2) {
590 590
    return SubMap<M1, M2>(m1, m2);
591 591
  }
592 592

	
593 593
  ///Product of two maps
594 594

	
595 595
  ///This \c concepts::ReadMap "read only map" returns the product of the
596 596
  ///values of the two given maps.
597 597
  ///Its \c Key and \c Value are inherited from \c M1.
598 598
  ///The \c Key and \c Value of \c M2 must be convertible to those of \c M1.
599 599
  template<typename M1, typename M2> 
600 600
  class MulMap : public MapBase<typename M1::Key, typename M1::Value> {
601 601
    const M1& m1;
602 602
    const M2& m2;
603 603
  public:
604 604
    typedef MapBase<typename M1::Key, typename M1::Value> Parent;
605 605
    typedef typename Parent::Key Key;
606 606
    typedef typename Parent::Value Value;
607 607

	
608 608
    ///Constructor
609 609
    MulMap(const M1 &_m1,const M2 &_m2) : m1(_m1), m2(_m2) {};
610 610
    /// \e
611 611
    Value operator[](Key k) const {return m1[k]*m2[k];}
612 612
  };
613 613
  
614 614
  ///Returns a \c MulMap class
615 615

	
616 616
  ///This function just returns a \c MulMap class.
617 617
  ///\relates MulMap
618 618
  template<typename M1, typename M2> 
619 619
  inline MulMap<M1, M2> mulMap(const M1 &m1,const M2 &m2) {
620 620
    return MulMap<M1, M2>(m1,m2);
621 621
  }
622 622
 
623 623
  ///Scales a map with a constant.
624 624

	
625 625
  ///This \c concepts::ReadMap "read only map" returns the value of the
626 626
  ///given map multiplied from the left side with a constant value.
627 627
  ///Its \c Key and \c Value are inherited from \c M.
628 628
  ///
629 629
  ///Actually,
630 630
  ///\code
631 631
  ///  ScaleMap<X> sc(x,v);
632 632
  ///\endcode
633 633
  ///is equivalent to
634 634
  ///\code
635 635
  ///  ConstMap<X::Key, X::Value> c_tmp(v);
636 636
  ///  MulMap<X, ConstMap<X::Key, X::Value> > sc(x,v);
637 637
  ///\endcode
638 638
  ///
639 639
  ///\sa ScaleWriteMap
640 640
  template<typename M, typename C = typename M::Value> 
641 641
  class ScaleMap : public MapBase<typename M::Key, typename M::Value> {
642 642
    const M& m;
643 643
    C v;
644 644
  public:
645 645
    typedef MapBase<typename M::Key, typename M::Value> Parent;
646 646
    typedef typename Parent::Key Key;
647 647
    typedef typename Parent::Value Value;
648 648

	
649 649
    ///Constructor
650 650

	
651 651
    ///Constructor.
652 652
    ///\param _m is the undelying map.
653 653
    ///\param _v is the scaling value.
654 654
    ScaleMap(const M &_m, const C &_v ) : m(_m), v(_v) {};
655 655
    /// \e
656 656
    Value operator[](Key k) const {return v * m[k];}
657 657
  };
658 658

	
659 659
  ///Scales a map with a constant (ReadWrite version).
660 660

	
661 661
  ///This \c concepts::ReadWriteMap "read-write map" returns the value of the
662 662
  ///given map multiplied from the left side with a constant value. It can
663 663
  ///also be used as write map if the \c / operator is defined between
664 664
  ///\c Value and \c C and the given multiplier is not zero.
665 665
  ///Its \c Key and \c Value are inherited from \c M.
666 666
  ///
667 667
  ///\sa ScaleMap
668 668
  template<typename M, typename C = typename M::Value> 
669 669
  class ScaleWriteMap : public MapBase<typename M::Key, typename M::Value> {
670 670
    M& m;
671 671
    C v;
672 672
  public:
673 673
    typedef MapBase<typename M::Key, typename M::Value> Parent;
674 674
    typedef typename Parent::Key Key;
675 675
    typedef typename Parent::Value Value;
676 676

	
677 677
    ///Constructor
678 678

	
679 679
    ///Constructor.
680 680
    ///\param _m is the undelying map.
681 681
    ///\param _v is the scaling value.
682 682
    ScaleWriteMap(M &_m, const C &_v ) : m(_m), v(_v) {};
683 683
    /// \e
684 684
    Value operator[](Key k) const {return v * m[k];}
685 685
    /// \e
686 686
    void set(Key k, const Value& c) { m.set(k, c / v);}
687 687
  };
688 688
  
689 689
  ///Returns a \c ScaleMap class
690 690

	
691 691
  ///This function just returns a \c ScaleMap class.
692 692
  ///\relates ScaleMap
693 693
  template<typename M, typename C> 
694 694
  inline ScaleMap<M, C> scaleMap(const M &m,const C &v) {
695 695
    return ScaleMap<M, C>(m,v);
696 696
  }
697 697

	
698 698
  ///Returns a \c ScaleWriteMap class
699 699

	
700 700
  ///This function just returns a \c ScaleWriteMap class.
701 701
  ///\relates ScaleWriteMap
702 702
  template<typename M, typename C> 
703 703
  inline ScaleWriteMap<M, C> scaleMap(M &m,const C &v) {
704 704
    return ScaleWriteMap<M, C>(m,v);
705 705
  }
706 706

	
707 707
  ///Quotient of two maps
708 708

	
709 709
  ///This \c concepts::ReadMap "read only map" returns the quotient of the
710 710
  ///values of the two given maps.
711 711
  ///Its \c Key and \c Value are inherited from \c M1.
712 712
  ///The \c Key and \c Value of \c M2 must be convertible to those of \c M1.
713 713
  template<typename M1, typename M2> 
714 714
  class DivMap : public MapBase<typename M1::Key, typename M1::Value> {
715 715
    const M1& m1;
716 716
    const M2& m2;
717 717
  public:
718 718
    typedef MapBase<typename M1::Key, typename M1::Value> Parent;
719 719
    typedef typename Parent::Key Key;
720 720
    typedef typename Parent::Value Value;
721 721

	
722 722
    ///Constructor
723 723
    DivMap(const M1 &_m1,const M2 &_m2) : m1(_m1), m2(_m2) {};
724 724
    /// \e
725 725
    Value operator[](Key k) const {return m1[k]/m2[k];}
726 726
  };
727 727
  
728 728
  ///Returns a \c DivMap class
729 729

	
730 730
  ///This function just returns a \c DivMap class.
731 731
  ///\relates DivMap
732 732
  template<typename M1, typename M2> 
733 733
  inline DivMap<M1, M2> divMap(const M1 &m1,const M2 &m2) {
734 734
    return DivMap<M1, M2>(m1,m2);
735 735
  }
736 736
  
737 737
  ///Composition of two maps
738 738

	
739 739
  ///This \c concepts::ReadMap "read only map" returns the composition of
740 740
  ///two given maps.
741 741
  ///That is to say, if \c m1 is of type \c M1 and \c m2 is of \c M2,
742 742
  ///then for
743 743
  ///\code
744 744
  ///  ComposeMap<M1, M2> cm(m1,m2);
745 745
  ///\endcode
746 746
  /// <tt>cm[x]</tt> will be equal to <tt>m1[m2[x]]</tt>.
747 747
  ///
748 748
  ///Its \c Key is inherited from \c M2 and its \c Value is from \c M1.
749 749
  ///\c M2::Value must be convertible to \c M1::Key.
750 750
  ///
751 751
  ///\sa CombineMap
752 752
  ///
753 753
  ///\todo Check the requirements.
754 754
  template <typename M1, typename M2> 
755 755
  class ComposeMap : public MapBase<typename M2::Key, typename M1::Value> {
756 756
    const M1& m1;
757 757
    const M2& m2;
758 758
  public:
759 759
    typedef MapBase<typename M2::Key, typename M1::Value> Parent;
760 760
    typedef typename Parent::Key Key;
761 761
    typedef typename Parent::Value Value;
762 762

	
763 763
    ///Constructor
764 764
    ComposeMap(const M1 &_m1,const M2 &_m2) : m1(_m1), m2(_m2) {};
765 765
    
766 766
    /// \e
767 767

	
768 768

	
769 769
    /// \todo Use the  MapTraits once it is ported.
770 770
    ///
771 771

	
772 772
    //typename MapTraits<M1>::ConstReturnValue
773 773
    typename M1::Value
Ignore white space 6 line context
1 1
/* -*- C++ -*-
2 2
 *
3 3
 * This file is a part of LEMON, a generic C++ optimization library
4 4
 *
5
 * Copyright (C) 2003-2007
5
 * Copyright (C) 2003-2008
6 6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
8 8
 *
9 9
 * Permission to use, modify and distribute this software is granted
10 10
 * provided that this copyright notice appears in all copies. For
11 11
 * precise terms see the accompanying LICENSE file.
12 12
 *
13 13
 * This software is provided "AS IS" with no warranty of any kind,
14 14
 * express or implied, and with no claim as to its suitability for any
15 15
 * purpose.
16 16
 *
17 17
 */
18 18

	
19 19
///\file
20 20
///\brief Instantiation of the Random class.
21 21

	
22 22
#include <lemon/random.h>
23 23

	
24 24
namespace lemon {
25 25
  /// \brief Global random number generator instance
26 26
  ///
27 27
  /// A global Mersenne Twister random number generator instance.
28 28
  Random rnd;
29 29
}
Ignore white space 6 line context
1 1
/* -*- C++ -*-
2 2
 *
3 3
 * This file is a part of LEMON, a generic C++ optimization library
4 4
 *
5
 * Copyright (C) 2003-2007
5
 * Copyright (C) 2003-2008
6 6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
8 8
 *
9 9
 * Permission to use, modify and distribute this software is granted
10 10
 * provided that this copyright notice appears in all copies. For
11 11
 * precise terms see the accompanying LICENSE file.
12 12
 *
13 13
 * This software is provided "AS IS" with no warranty of any kind,
14 14
 * express or implied, and with no claim as to its suitability for any
15 15
 * purpose.
16 16
 *
17 17
 */
18 18

	
19 19
/*
20 20
 * This file contains the reimplemented version of the Mersenne Twister
21 21
 * Generator of Matsumoto and Nishimura.
22 22
 *
23 23
 * See the appropriate copyright notice below.
24 24
 * 
25 25
 * Copyright (C) 1997 - 2002, Makoto Matsumoto and Takuji Nishimura,
26 26
 * All rights reserved.                          
27 27
 *
28 28
 * Redistribution and use in source and binary forms, with or without
29 29
 * modification, are permitted provided that the following conditions
30 30
 * are met:
31 31
 *
32 32
 * 1. Redistributions of source code must retain the above copyright
33 33
 *    notice, this list of conditions and the following disclaimer.
34 34
 *
35 35
 * 2. Redistributions in binary form must reproduce the above copyright
36 36
 *    notice, this list of conditions and the following disclaimer in the
37 37
 *    documentation and/or other materials provided with the distribution.
38 38
 *
39 39
 * 3. The names of its contributors may not be used to endorse or promote 
40 40
 *    products derived from this software without specific prior written 
41 41
 *    permission.
42 42
 *
43 43
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
44 44
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
45 45
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
46 46
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
47 47
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
48 48
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
49 49
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
50 50
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
51 51
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
52 52
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
53 53
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
54 54
 * OF THE POSSIBILITY OF SUCH DAMAGE.
55 55
 *
56 56
 *
57 57
 * Any feedback is very welcome.
58 58
 * http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/emt.html
59 59
 * email: m-mat @ math.sci.hiroshima-u.ac.jp (remove space)
60 60
 */
61 61

	
62 62
#ifndef LEMON_RANDOM_H
63 63
#define LEMON_RANDOM_H
64 64

	
65 65
#include <algorithm>
66 66
#include <iterator>
67 67
#include <vector>
68 68

	
69 69
#include <ctime>
70 70
#include <cmath>
71 71

	
72 72
#include <lemon/dim2.h>
73 73
///\ingroup misc
74 74
///\file
75 75
///\brief Mersenne Twister random number generator
76 76

	
77 77
namespace lemon {
78 78

	
79 79
  namespace _random_bits {
80 80
    
81 81
    template <typename _Word, int _bits = std::numeric_limits<_Word>::digits>
82 82
    struct RandomTraits {};
83 83

	
84 84
    template <typename _Word>
85 85
    struct RandomTraits<_Word, 32> {
86 86

	
87 87
      typedef _Word Word;
88 88
      static const int bits = 32;
89 89

	
90 90
      static const int length = 624;
91 91
      static const int shift = 397;
92 92
      
93 93
      static const Word mul = 0x6c078965u;
94 94
      static const Word arrayInit = 0x012BD6AAu;
95 95
      static const Word arrayMul1 = 0x0019660Du;
96 96
      static const Word arrayMul2 = 0x5D588B65u;
97 97

	
98 98
      static const Word mask = 0x9908B0DFu;
99 99
      static const Word loMask = (1u << 31) - 1;
100 100
      static const Word hiMask = ~loMask;
101 101

	
102 102

	
103 103
      static Word tempering(Word rnd) {
104 104
        rnd ^= (rnd >> 11);
105 105
        rnd ^= (rnd << 7) & 0x9D2C5680u;
106 106
        rnd ^= (rnd << 15) & 0xEFC60000u;
107 107
        rnd ^= (rnd >> 18);
108 108
        return rnd;
109 109
      }
110 110

	
111 111
    };
112 112

	
113 113
    template <typename _Word>
114 114
    struct RandomTraits<_Word, 64> {
115 115

	
116 116
      typedef _Word Word;
117 117
      static const int bits = 64;
118 118

	
119 119
      static const int length = 312;
120 120
      static const int shift = 156;
121 121

	
122 122
      static const Word mul = Word(0x5851F42Du) << 32 | Word(0x4C957F2Du);
123 123
      static const Word arrayInit = Word(0x00000000u) << 32 |Word(0x012BD6AAu);
124 124
      static const Word arrayMul1 = Word(0x369DEA0Fu) << 32 |Word(0x31A53F85u);
125 125
      static const Word arrayMul2 = Word(0x27BB2EE6u) << 32 |Word(0x87B0B0FDu);
126 126

	
127 127
      static const Word mask = Word(0xB5026F5Au) << 32 | Word(0xA96619E9u);
128 128
      static const Word loMask = (Word(1u) << 31) - 1;
129 129
      static const Word hiMask = ~loMask;
130 130

	
131 131
      static Word tempering(Word rnd) {
132 132
        rnd ^= (rnd >> 29) & (Word(0x55555555u) << 32 | Word(0x55555555u));
133 133
        rnd ^= (rnd << 17) & (Word(0x71D67FFFu) << 32 | Word(0xEDA60000u));
134 134
        rnd ^= (rnd << 37) & (Word(0xFFF7EEE0u) << 32 | Word(0x00000000u));
135 135
        rnd ^= (rnd >> 43);
136 136
        return rnd;
137 137
      }
138 138

	
139 139
    };
140 140

	
141 141
    template <typename _Word>
142 142
    class RandomCore {
143 143
    public:
144 144

	
145 145
      typedef _Word Word;
146 146

	
147 147
    private:
148 148

	
149 149
      static const int bits = RandomTraits<Word>::bits;
150 150

	
151 151
      static const int length = RandomTraits<Word>::length;
152 152
      static const int shift = RandomTraits<Word>::shift;
153 153

	
154 154
    public:
155 155

	
156 156
      void initState() {
157 157
        static const Word seedArray[4] = {
158 158
          0x12345u, 0x23456u, 0x34567u, 0x45678u
159 159
        };
160 160
    
161 161
        initState(seedArray, seedArray + 4);
162 162
      }
163 163

	
164 164
      void initState(Word seed) {
165 165

	
166 166
        static const Word mul = RandomTraits<Word>::mul;
167 167

	
168 168
        current = state; 
169 169

	
170 170
        Word *curr = state + length - 1;
171 171
        curr[0] = seed; --curr;
172 172
        for (int i = 1; i < length; ++i) {
173 173
          curr[0] = (mul * ( curr[1] ^ (curr[1] >> (bits - 2)) ) + i);
174 174
          --curr;
175 175
        }
176 176
      }
177 177

	
178 178
      template <typename Iterator>
179 179
      void initState(Iterator begin, Iterator end) {
180 180

	
181 181
        static const Word init = RandomTraits<Word>::arrayInit;
182 182
        static const Word mul1 = RandomTraits<Word>::arrayMul1;
183 183
        static const Word mul2 = RandomTraits<Word>::arrayMul2;
184 184

	
185 185

	
186 186
        Word *curr = state + length - 1; --curr;
187 187
        Iterator it = begin; int cnt = 0;
188 188
        int num;
189 189

	
190 190
        initState(init);
191 191

	
192 192
        num = length > end - begin ? length : end - begin;
193 193
        while (num--) {
194 194
          curr[0] = (curr[0] ^ ((curr[1] ^ (curr[1] >> (bits - 2))) * mul1)) 
195 195
            + *it + cnt;
196 196
          ++it; ++cnt;
197 197
          if (it == end) {
198 198
            it = begin; cnt = 0;
199 199
          }
200 200
          if (curr == state) {
201 201
            curr = state + length - 1; curr[0] = state[0];
202 202
          }
203 203
          --curr;
204 204
        }
205 205

	
206 206
        num = length - 1; cnt = length - (curr - state) - 1;
207 207
        while (num--) {
208 208
          curr[0] = (curr[0] ^ ((curr[1] ^ (curr[1] >> (bits - 2))) * mul2))
209 209
            - cnt;
210 210
          --curr; ++cnt;
211 211
          if (curr == state) {
212 212
            curr = state + length - 1; curr[0] = state[0]; --curr;
213 213
            cnt = 1;
214 214
          }
215 215
        }
216 216
        
217 217
        state[length - 1] = Word(1) << (bits - 1);
218 218
      }
219 219
      
220 220
      void copyState(const RandomCore& other) {
221 221
        std::copy(other.state, other.state + length, state);
222 222
        current = state + (other.current - other.state);
223 223
      }
224 224

	
225 225
      Word operator()() {
226 226
        if (current == state) fillState();
227 227
        --current;
228 228
        Word rnd = *current;
229 229
        return RandomTraits<Word>::tempering(rnd);
230 230
      }
231 231

	
232 232
    private:
233 233

	
234 234
  
235 235
      void fillState() {
236 236
        static const Word mask[2] = { 0x0ul, RandomTraits<Word>::mask };
237 237
        static const Word loMask = RandomTraits<Word>::loMask;
238 238
        static const Word hiMask = RandomTraits<Word>::hiMask;
239 239

	
240 240
        current = state + length; 
241 241

	
242 242
        register Word *curr = state + length - 1;
243 243
        register long num;
244 244
      
245 245
        num = length - shift;
246 246
        while (num--) {
247 247
          curr[0] = (((curr[0] & hiMask) | (curr[-1] & loMask)) >> 1) ^
248 248
            curr[- shift] ^ mask[curr[-1] & 1ul];
249 249
          --curr;
250 250
        }
251 251
        num = shift - 1;
252 252
        while (num--) {
253 253
          curr[0] = (((curr[0] & hiMask) | (curr[-1] & loMask)) >> 1) ^
254 254
            curr[length - shift] ^ mask[curr[-1] & 1ul];
255 255
          --curr;
256 256
        }
257 257
        curr[0] = (((curr[0] & hiMask) | (curr[length - 1] & loMask)) >> 1) ^
258 258
          curr[length - shift] ^ mask[curr[length - 1] & 1ul];
259 259

	
260 260
      }
261 261

	
262 262
  
263 263
      Word *current;
264 264
      Word state[length];
265 265
      
266 266
    };
267 267

	
268 268

	
269 269
    template <typename Result, 
270 270
              int shift = (std::numeric_limits<Result>::digits + 1) / 2>
271 271
    struct Masker {
272 272
      static Result mask(const Result& result) {
273 273
        return Masker<Result, (shift + 1) / 2>::
274 274
          mask(static_cast<Result>(result | (result >> shift)));
275 275
      }
276 276
    };
277 277
    
278 278
    template <typename Result>
279 279
    struct Masker<Result, 1> {
280 280
      static Result mask(const Result& result) {
281 281
        return static_cast<Result>(result | (result >> 1));
282 282
      }
283 283
    };
284 284

	
285 285
    template <typename Result, typename Word, 
286 286
              int rest = std::numeric_limits<Result>::digits, int shift = 0, 
287 287
              bool last = rest <= std::numeric_limits<Word>::digits>
288 288
    struct IntConversion {
289 289
      static const int bits = std::numeric_limits<Word>::digits;
290 290
    
291 291
      static Result convert(RandomCore<Word>& rnd) {
292 292
        return static_cast<Result>(rnd() >> (bits - rest)) << shift;
293 293
      }
294 294
      
295 295
    }; 
296 296

	
297 297
    template <typename Result, typename Word, int rest, int shift> 
298 298
    struct IntConversion<Result, Word, rest, shift, false> {
299 299
      static const int bits = std::numeric_limits<Word>::digits;
300 300

	
301 301
      static Result convert(RandomCore<Word>& rnd) {
302 302
        return (static_cast<Result>(rnd()) << shift) | 
303 303
          IntConversion<Result, Word, rest - bits, shift + bits>::convert(rnd);
304 304
      }
305 305
    };
306 306

	
307 307

	
308 308
    template <typename Result, typename Word,
309 309
              bool one_word = (std::numeric_limits<Word>::digits < 
310 310
			       std::numeric_limits<Result>::digits) >
311 311
    struct Mapping {
312 312
      static Result map(RandomCore<Word>& rnd, const Result& bound) {
313 313
        Word max = Word(bound - 1);
314 314
        Result mask = Masker<Result>::mask(bound - 1);
315 315
        Result num;
316 316
        do {
317 317
          num = IntConversion<Result, Word>::convert(rnd) & mask; 
318 318
        } while (num > max);
319 319
        return num;
320 320
      }
321 321
    };
322 322

	
323 323
    template <typename Result, typename Word>
324 324
    struct Mapping<Result, Word, false> {
325 325
      static Result map(RandomCore<Word>& rnd, const Result& bound) {
326 326
        Word max = Word(bound - 1);
327 327
        Word mask = Masker<Word, (std::numeric_limits<Result>::digits + 1) / 2>
328 328
          ::mask(max);
329 329
        Word num;
330 330
        do {
331 331
          num = rnd() & mask;
332 332
        } while (num > max);
333 333
        return num;
334 334
      }
335 335
    };
336 336

	
337 337
    template <typename Result, int exp, bool pos = (exp >= 0)>
338 338
    struct ShiftMultiplier {
339 339
      static const Result multiplier() {
340 340
        Result res = ShiftMultiplier<Result, exp / 2>::multiplier();
341 341
        res *= res;
342 342
        if ((exp & 1) == 1) res *= static_cast<Result>(2.0);
343 343
        return res; 
344 344
      }
345 345
    };
346 346

	
347 347
    template <typename Result, int exp>
348 348
    struct ShiftMultiplier<Result, exp, false> {
349 349
      static const Result multiplier() {
350 350
        Result res = ShiftMultiplier<Result, exp / 2>::multiplier();
351 351
        res *= res;
352 352
        if ((exp & 1) == 1) res *= static_cast<Result>(0.5);
353 353
        return res; 
354 354
      }
355 355
    };
356 356

	
357 357
    template <typename Result>
358 358
    struct ShiftMultiplier<Result, 0, true> {
359 359
      static const Result multiplier() {
360 360
        return static_cast<Result>(1.0); 
361 361
      }
362 362
    };
363 363

	
364 364
    template <typename Result>
365 365
    struct ShiftMultiplier<Result, -20, true> {
366 366
      static const Result multiplier() {
367 367
        return static_cast<Result>(1.0/1048576.0); 
368 368
      }
369 369
    };
370 370
    
371 371
    template <typename Result>
372 372
    struct ShiftMultiplier<Result, -32, true> {
373 373
      static const Result multiplier() {
374 374
        return static_cast<Result>(1.0/424967296.0); 
375 375
      }
376 376
    };
377 377

	
378 378
    template <typename Result>
379 379
    struct ShiftMultiplier<Result, -53, true> {
380 380
      static const Result multiplier() {
381 381
        return static_cast<Result>(1.0/9007199254740992.0); 
382 382
      }
383 383
    };
384 384

	
385 385
    template <typename Result>
386 386
    struct ShiftMultiplier<Result, -64, true> {
387 387
      static const Result multiplier() {
388 388
        return static_cast<Result>(1.0/18446744073709551616.0); 
389 389
      }
390 390
    };
391 391

	
392 392
    template <typename Result, int exp>
393 393
    struct Shifting {
394 394
      static Result shift(const Result& result) {
395 395
        return result * ShiftMultiplier<Result, exp>::multiplier();
396 396
      }
397 397
    };
398 398

	
399 399
    template <typename Result, typename Word,
400 400
              int rest = std::numeric_limits<Result>::digits, int shift = 0, 
401 401
              bool last = rest <= std::numeric_limits<Word>::digits>
402 402
    struct RealConversion{ 
403 403
      static const int bits = std::numeric_limits<Word>::digits;
404 404

	
405 405
      static Result convert(RandomCore<Word>& rnd) {
406 406
        return Shifting<Result, - shift - rest>::
407 407
          shift(static_cast<Result>(rnd() >> (bits - rest)));
408 408
      }
409 409
    };
410 410

	
411 411
    template <typename Result, typename Word, int rest, int shift>
412 412
    struct RealConversion<Result, Word, rest, shift, false> { 
413 413
      static const int bits = std::numeric_limits<Word>::digits;
414 414

	
415 415
      static Result convert(RandomCore<Word>& rnd) {
416 416
        return Shifting<Result, - shift - bits>::
417 417
          shift(static_cast<Result>(rnd())) +
418 418
          RealConversion<Result, Word, rest-bits, shift + bits>::
419 419
          convert(rnd);
420 420
      }
421 421
    };
422 422

	
423 423
    template <typename Result, typename Word>
424 424
    struct Initializer {
425 425

	
426 426
      template <typename Iterator>
427 427
      static void init(RandomCore<Word>& rnd, Iterator begin, Iterator end) {
428 428
        std::vector<Word> ws;
429 429
        for (Iterator it = begin; it != end; ++it) {
430 430
          ws.push_back(Word(*it));
431 431
        }
432 432
        rnd.initState(ws.begin(), ws.end());
433 433
      }
434 434

	
435 435
      static void init(RandomCore<Word>& rnd, Result seed) {
436 436
        rnd.initState(seed);
437 437
      }
438 438
    };
439 439

	
440 440
    template <typename Word>
441 441
    struct BoolConversion {
442 442
      static bool convert(RandomCore<Word>& rnd) {
443 443
        return (rnd() & 1) == 1;
444 444
      }
445 445
    };
446 446

	
447 447
    template <typename Word>
448 448
    struct BoolProducer {
449 449
      Word buffer;
450 450
      int num;
451 451
      
452 452
      BoolProducer() : num(0) {}
453 453

	
454 454
      bool convert(RandomCore<Word>& rnd) {
455 455
        if (num == 0) {
456 456
          buffer = rnd();
457 457
          num = RandomTraits<Word>::bits;
458 458
        }
459 459
        bool r = (buffer & 1);
460 460
        buffer >>= 1;
461 461
        --num;
462 462
        return r;
463 463
      }
464 464
    };
465 465

	
466 466
  }
467 467

	
468 468
  /// \ingroup misc
469 469
  ///
470 470
  /// \brief Mersenne Twister random number generator
471 471
  ///
472 472
  /// The Mersenne Twister is a twisted generalized feedback
473 473
  /// shift-register generator of Matsumoto and Nishimura. The period
474 474
  /// of this generator is \f$ 2^{19937} - 1 \f$ and it is
475 475
  /// equi-distributed in 623 dimensions for 32-bit numbers. The time
476 476
  /// performance of this generator is comparable to the commonly used
477 477
  /// generators.
478 478
  ///
479 479
  /// This implementation is specialized for both 32-bit and 64-bit
480 480
  /// architectures. The generators differ sligthly in the
481 481
  /// initialization and generation phase so they produce two
482 482
  /// completly different sequences.
483 483
  ///
484 484
  /// The generator gives back random numbers of serveral types. To
485 485
  /// get a random number from a range of a floating point type you
486 486
  /// can use one form of the \c operator() or the \c real() member
487 487
  /// function. If you want to get random number from the {0, 1, ...,
488 488
  /// n-1} integer range use the \c operator[] or the \c integer()
489 489
  /// method. And to get random number from the whole range of an
490 490
  /// integer type you can use the argumentless \c integer() or \c
491 491
  /// uinteger() functions. After all you can get random bool with
492 492
  /// equal chance of true and false or given probability of true
493 493
  /// result with the \c boolean() member functions.
494 494
  ///
495 495
  ///\code
496 496
  /// // The commented code is identical to the other
497 497
  /// double a = rnd();                     // [0.0, 1.0)
498 498
  /// // double a = rnd.real();             // [0.0, 1.0)
499 499
  /// double b = rnd(100.0);                // [0.0, 100.0)
500 500
  /// // double b = rnd.real(100.0);        // [0.0, 100.0)
501 501
  /// double c = rnd(1.0, 2.0);             // [1.0, 2.0)
502 502
  /// // double c = rnd.real(1.0, 2.0);     // [1.0, 2.0)
503 503
  /// int d = rnd[100000];                  // 0..99999
504 504
  /// // int d = rnd.integer(100000);       // 0..99999
505 505
  /// int e = rnd[6] + 1;                   // 1..6
506 506
  /// // int e = rnd.integer(1, 1 + 6);     // 1..6
507 507
  /// int b = rnd.uinteger<int>();          // 0 .. 2^31 - 1
508 508
  /// int c = rnd.integer<int>();           // - 2^31 .. 2^31 - 1
509 509
  /// bool g = rnd.boolean();               // P(g = true) = 0.5
510 510
  /// bool h = rnd.boolean(0.8);            // P(h = true) = 0.8
511 511
  ///\endcode
512 512
  ///
513 513
  /// The lemon provides a global instance of the random number
514 514
  /// generator which name is \ref lemon::rnd "rnd". Usually it is a
515 515
  /// good programming convenience to use this global generator to get
516 516
  /// random numbers.
517 517
  class Random {
518 518
  private:
519 519

	
520 520
    // Architecture word
521 521
    typedef unsigned long Word;
522 522
    
523 523
    _random_bits::RandomCore<Word> core;
524 524
    _random_bits::BoolProducer<Word> bool_producer;
525 525
    
526 526

	
527 527
  public:
528 528

	
529 529
    /// \brief Constructor
530 530
    ///
531 531
    /// Constructor with constant seeding.
532 532
    Random() { core.initState(); }
533 533

	
534 534
    /// \brief Constructor
535 535
    ///
536 536
    /// Constructor with seed. The current number type will be converted
537 537
    /// to the architecture word type.
538 538
    template <typename Number>
539 539
    Random(Number seed) { 
540 540
      _random_bits::Initializer<Number, Word>::init(core, seed);
541 541
    }
542 542

	
543 543
    /// \brief Constructor
544 544
    ///
545 545
    /// Constructor with array seeding. The given range should contain
546 546
    /// any number type and the numbers will be converted to the
547 547
    /// architecture word type.
548 548
    template <typename Iterator>
549 549
    Random(Iterator begin, Iterator end) { 
550 550
      typedef typename std::iterator_traits<Iterator>::value_type Number;
551 551
      _random_bits::Initializer<Number, Word>::init(core, begin, end);
552 552
    }
553 553

	
554 554
    /// \brief Copy constructor
555 555
    ///
556 556
    /// Copy constructor. The generated sequence will be identical to
557 557
    /// the other sequence. It can be used to save the current state
558 558
    /// of the generator and later use it to generate the same
559 559
    /// sequence.
560 560
    Random(const Random& other) {
561 561
      core.copyState(other.core);
562 562
    }
563 563

	
564 564
    /// \brief Assign operator
565 565
    ///
566 566
    /// Assign operator. The generated sequence will be identical to
567 567
    /// the other sequence. It can be used to save the current state
568 568
    /// of the generator and later use it to generate the same
569 569
    /// sequence.
570 570
    Random& operator=(const Random& other) {
571 571
      if (&other != this) {
572 572
        core.copyState(other.core);
573 573
      }
574 574
      return *this;
575 575
    }
576 576

	
577 577
    /// \brief Returns a random real number from the range [0, 1)
578 578
    ///
579 579
    /// It returns a random real number from the range [0, 1). The
580 580
    /// default Number type is double.
581 581
    template <typename Number>
582 582
    Number real() {
583 583
      return _random_bits::RealConversion<Number, Word>::convert(core);
584 584
    }
585 585

	
586 586
    double real() {
587 587
      return real<double>();
588 588
    }
589 589

	
590 590
    /// \brief Returns a random real number the range [0, b)
591 591
    ///
592 592
    /// It returns a random real number from the range [0, b).
593 593
    template <typename Number>
594 594
    Number real(Number b) { 
595 595
      return real<Number>() * b; 
596 596
    }
597 597

	
598 598
    /// \brief Returns a random real number from the range [a, b)
599 599
    ///
600 600
    /// It returns a random real number from the range [a, b).
601 601
    template <typename Number>
602 602
    Number real(Number a, Number b) { 
603 603
      return real<Number>() * (b - a) + a; 
604 604
    }
605 605

	
606 606
    /// \brief Returns a random real number from the range [0, 1)
607 607
    ///
608 608
    /// It returns a random double from the range [0, 1).
609 609
    double operator()() {
610 610
      return real<double>();
611 611
    }
612 612

	
613 613
    /// \brief Returns a random real number from the range [0, b)
614 614
    ///
615 615
    /// It returns a random real number from the range [0, b).
616 616
    template <typename Number>
617 617
    Number operator()(Number b) { 
618 618
      return real<Number>() * b; 
619 619
    }
620 620

	
621 621
    /// \brief Returns a random real number from the range [a, b)
622 622
    ///
623 623
    /// It returns a random real number from the range [a, b).
624 624
    template <typename Number>
625 625
    Number operator()(Number a, Number b) { 
626 626
      return real<Number>() * (b - a) + a; 
627 627
    }
628 628

	
629 629
    /// \brief Returns a random integer from a range
630 630
    ///
631 631
    /// It returns a random integer from the range {0, 1, ..., b - 1}.
632 632
    template <typename Number>
633 633
    Number integer(Number b) {
634 634
      return _random_bits::Mapping<Number, Word>::map(core, b);
635 635
    }
636 636

	
637 637
    /// \brief Returns a random integer from a range
638 638
    ///
639 639
    /// It returns a random integer from the range {a, a + 1, ..., b - 1}.
640 640
    template <typename Number>
641 641
    Number integer(Number a, Number b) {
642 642
      return _random_bits::Mapping<Number, Word>::map(core, b - a) + a;
643 643
    }
644 644

	
645 645
    /// \brief Returns a random integer from a range
646 646
    ///
647 647
    /// It returns a random integer from the range {0, 1, ..., b - 1}.
648 648
    template <typename Number>
649 649
    Number operator[](Number b) {
650 650
      return _random_bits::Mapping<Number, Word>::map(core, b);
651 651
    }
652 652

	
653 653
    /// \brief Returns a random non-negative integer
654 654
    ///
655 655
    /// It returns a random non-negative integer uniformly from the
656 656
    /// whole range of the current \c Number type.  The default result
657 657
    /// type of this function is unsigned int.
658 658
    template <typename Number>
659 659
    Number uinteger() {
660 660
      return _random_bits::IntConversion<Number, Word>::convert(core);
661 661
    }
662 662

	
663 663
    unsigned int uinteger() {
664 664
      return uinteger<unsigned int>();
665 665
    }
666 666

	
667 667
    /// \brief Returns a random integer
668 668
    ///
669 669
    /// It returns a random integer uniformly from the whole range of
670 670
    /// the current \c Number type. The default result type of this
671 671
    /// function is int.
672 672
    template <typename Number>
673 673
    Number integer() {
674 674
      static const int nb = std::numeric_limits<Number>::digits + 
675 675
        (std::numeric_limits<Number>::is_signed ? 1 : 0);
676 676
      return _random_bits::IntConversion<Number, Word, nb>::convert(core);
677 677
    }
678 678

	
679 679
    int integer() {
680 680
      return integer<int>();
681 681
    }
682 682
    
683 683
    /// \brief Returns a random bool
684 684
    ///
685 685
    /// It returns a random bool. The generator holds a buffer for
686 686
    /// random bits. Every time when it become empty the generator makes
687 687
    /// a new random word and fill the buffer up.
688 688
    bool boolean() {
689 689
      return bool_producer.convert(core);
690 690
    }
691 691

	
692 692
    ///\name Nonuniform distributions
693 693
    ///
694 694
    
695 695
    ///@{
696 696
    
697 697
    /// \brief Returns a random bool
698 698
    ///
699 699
    /// It returns a random bool with given probability of true result.
700 700
    bool boolean(double p) {
701 701
      return operator()() < p;
702 702
    }
703 703

	
704 704
    /// Standard Gauss distribution
705 705

	
706 706
    /// Standard Gauss distribution.
707 707
    /// \note The Cartesian form of the Box-Muller
708 708
    /// transformation is used to generate a random normal distribution.
709 709
    /// \todo Consider using the "ziggurat" method instead.
710 710
    double gauss() 
711 711
    {
712 712
      double V1,V2,S;
713 713
      do {
714 714
	V1=2*real<double>()-1;
715 715
	V2=2*real<double>()-1;
716 716
	S=V1*V1+V2*V2;
717 717
      } while(S>=1);
718 718
      return std::sqrt(-2*std::log(S)/S)*V1;
719 719
    }
720 720
    /// Gauss distribution with given mean and standard deviation
721 721

	
722 722
    /// Gauss distribution with given mean and standard deviation.
723 723
    /// \sa gauss()
724 724
    double gauss(double mean,double std_dev)
725 725
    {
726 726
      return gauss()*std_dev+mean;
727 727
    }
728 728

	
729 729
    /// Exponential distribution with given mean
730 730

	
731 731
    /// This function generates an exponential distribution random number
732 732
    /// with mean <tt>1/lambda</tt>.
733 733
    ///
734 734
    double exponential(double lambda=1.0)
735 735
    {
736 736
      return -std::log(1.0-real<double>())/lambda;
737 737
    }
738 738

	
739 739
    /// Gamma distribution with given integer shape
740 740

	
741 741
    /// This function generates a gamma distribution random number.
742 742
    /// 
743 743
    ///\param k shape parameter (<tt>k>0</tt> integer)
744 744
    double gamma(int k) 
745 745
    {
746 746
      double s = 0;
747 747
      for(int i=0;i<k;i++) s-=std::log(1.0-real<double>());
748 748
      return s;
749 749
    }
750 750
    
751 751
    /// Gamma distribution with given shape and scale parameter
752 752

	
753 753
    /// This function generates a gamma distribution random number.
754 754
    /// 
755 755
    ///\param k shape parameter (<tt>k>0</tt>)
756 756
    ///\param theta scale parameter
757 757
    ///
758 758
    double gamma(double k,double theta=1.0)
759 759
    {
760 760
      double xi,nu;
761 761
      const double delta = k-std::floor(k);
762 762
      const double v0=M_E/(M_E-delta);
763 763
      do {
764 764
	double V0=1.0-real<double>();
765 765
	double V1=1.0-real<double>();
766 766
	double V2=1.0-real<double>();
767 767
	if(V2<=v0) 
768 768
	  {
769 769
	    xi=std::pow(V1,1.0/delta);
770 770
	    nu=V0*std::pow(xi,delta-1.0);
771 771
	  }
772 772
	else 
773 773
	  {
Ignore white space 6 line context
1 1
/* -*- C++ -*-
2 2
 *
3 3
 * This file is a part of LEMON, a generic C++ optimization library
4 4
 *
5
 * Copyright (C) 2003-2007
5
 * Copyright (C) 2003-2008
6 6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
8 8
 *
9 9
 * Permission to use, modify and distribute this software is granted
10 10
 * provided that this copyright notice appears in all copies. For
11 11
 * precise terms see the accompanying LICENSE file.
12 12
 *
13 13
 * This software is provided "AS IS" with no warranty of any kind,
14 14
 * express or implied, and with no claim as to its suitability for any
15 15
 * purpose.
16 16
 *
17 17
 */
18 18

	
19 19
#ifndef LEMON_TOLERANCE_H
20 20
#define LEMON_TOLERANCE_H
21 21

	
22 22
///\ingroup misc
23 23
///\file
24 24
///\brief A basic tool to handle the anomalies of calculation with
25 25
///floating point numbers.
26 26
///
27 27
///\todo It should be in a module like "Basic tools"
28 28

	
29 29

	
30 30
namespace lemon {
31 31

	
32 32
  /// \addtogroup misc
33 33
  /// @{
34 34
  
35 35
  ///\brief A class to provide a basic way to
36 36
  ///handle the comparison of numbers that are obtained
37 37
  ///as a result of a probably inexact computation.
38 38
  ///
39 39
  ///Tolerance is a class to provide a basic way to
40 40
  ///handle the comparison of numbers that are obtained
41 41
  ///as a result of a probably inexact computation.
42 42
  ///
43 43
  ///This is an abstract class, it should be specialized for all numerical
44 44
  ///data types. These specialized classes like \ref Tolerance\<double\>
45 45
  ///may offer additional tuning parameters.
46 46
  ///
47 47
  ///\sa Tolerance<float>
48 48
  ///\sa Tolerance<double>
49 49
  ///\sa Tolerance<long double>
50 50
  ///\sa Tolerance<int>
51 51
#if defined __GNUC__ && !defined __STRICT_ANSI__  
52 52
  ///\sa Tolerance<long long int>
53 53
#endif
54 54
  ///\sa Tolerance<unsigned int>
55 55
#if defined __GNUC__ && !defined __STRICT_ANSI__  
56 56
  ///\sa Tolerance<unsigned long long int>
57 57
#endif
58 58

	
59 59
  template<class T>
60 60
  class Tolerance
61 61
  {
62 62
  public:
63 63
    typedef T Value;
64 64

	
65 65
    ///\name Comparisons
66 66
    ///The concept is that these bool functions return with \c true only if
67 67
    ///the related comparisons hold even if some numerical error appeared
68 68
    ///during the computations.
69 69

	
70 70
    ///@{
71 71

	
72 72
    ///Returns \c true if \c a is \e surely strictly less than \c b
73 73
    static bool less(Value a,Value b) {return false;}
74 74
    ///Returns \c true if \c a is \e surely different from \c b
75 75
    static bool different(Value a,Value b) {return false;}
76 76
    ///Returns \c true if \c a is \e surely positive
77 77
    static bool positive(Value a) {return false;}
78 78
    ///Returns \c true if \c a is \e surely negative
79 79
    static bool negative(Value a) {return false;}
80 80
    ///Returns \c true if \c a is \e surely non-zero
81 81
    static bool nonZero(Value a) {return false;}
82 82

	
83 83
    ///@}
84 84

	
85 85
    ///Returns the zero value.
86 86
    static Value zero() {return T();}
87 87

	
88 88
    //   static bool finite(Value a) {}
89 89
    //   static Value big() {}
90 90
    //   static Value negativeBig() {}
91 91
  };
92 92

	
93 93

	
94 94
  ///Float specialization of \ref Tolerance.
95 95

	
96 96
  ///Float specialization of \ref Tolerance.
97 97
  ///\sa Tolerance
98 98
  ///\relates Tolerance
99 99
  template<>
100 100
  class Tolerance<float>
101 101
  {
102 102
    static float def_epsilon;
103 103
    float _epsilon;
104 104
  public:
105 105
    ///\e
106 106
    typedef float Value;
107 107

	
108 108
    ///Constructor setting the epsilon tolerance to the default value.
109 109
    Tolerance() : _epsilon(def_epsilon) {}
110 110
    ///Constructor setting the epsilon tolerance.
111 111
    Tolerance(float e) : _epsilon(e) {}
112 112

	
113 113
    ///Return the epsilon value.
114 114
    Value epsilon() const {return _epsilon;}
115 115
    ///Set the epsilon value.
116 116
    void epsilon(Value e) {_epsilon=e;}
117 117

	
118 118
    ///Return the default epsilon value.
119 119
    static Value defaultEpsilon() {return def_epsilon;}
120 120
    ///Set the default epsilon value.
121 121
    static void defaultEpsilon(Value e) {def_epsilon=e;}
122 122

	
123 123
    ///\name Comparisons
124 124
    ///See class Tolerance for more details.
125 125

	
126 126
    ///@{
127 127

	
128 128
    ///Returns \c true if \c a is \e surely strictly less than \c b
129 129
    bool less(Value a,Value b) const {return a+_epsilon<b;}
130 130
    ///Returns \c true if \c a is \e surely different from \c b
131 131
    bool different(Value a,Value b) const { return less(a,b)||less(b,a); }
132 132
    ///Returns \c true if \c a is \e surely positive
133 133
    bool positive(Value a) const { return _epsilon<a; }
134 134
    ///Returns \c true if \c a is \e surely negative
135 135
    bool negative(Value a) const { return -_epsilon>a; }
136 136
    ///Returns \c true if \c a is \e surely non-zero
137 137
    bool nonZero(Value a) const { return positive(a)||negative(a); }
138 138

	
139 139
    ///@}
140 140

	
141 141
    ///Returns zero
142 142
    static Value zero() {return 0;}
143 143
  };
144 144

	
145 145
  ///Double specialization of \ref Tolerance.
146 146

	
147 147
  ///Double specialization of \ref Tolerance.
148 148
  ///\sa Tolerance
149 149
  ///\relates Tolerance
150 150
  template<>
151 151
  class Tolerance<double>
152 152
  {
153 153
    static double def_epsilon;
154 154
    double _epsilon;
155 155
  public:
156 156
    ///\e
157 157
    typedef double Value;
158 158

	
159 159
    ///Constructor setting the epsilon tolerance to the default value.
160 160
    Tolerance() : _epsilon(def_epsilon) {}
161 161
    ///Constructor setting the epsilon tolerance.
162 162
    Tolerance(double e) : _epsilon(e) {}
163 163

	
164 164
    ///Return the epsilon value.
165 165
    Value epsilon() const {return _epsilon;}
166 166
    ///Set the epsilon value.
167 167
    void epsilon(Value e) {_epsilon=e;}
168 168

	
169 169
    ///Return the default epsilon value.
170 170
    static Value defaultEpsilon() {return def_epsilon;}
171 171
    ///Set the default epsilon value.
172 172
    static void defaultEpsilon(Value e) {def_epsilon=e;}
173 173

	
174 174
    ///\name Comparisons
175 175
    ///See class Tolerance for more details.
176 176

	
177 177
    ///@{
178 178

	
179 179
    ///Returns \c true if \c a is \e surely strictly less than \c b
180 180
    bool less(Value a,Value b) const {return a+_epsilon<b;}
181 181
    ///Returns \c true if \c a is \e surely different from \c b
182 182
    bool different(Value a,Value b) const { return less(a,b)||less(b,a); }
183 183
    ///Returns \c true if \c a is \e surely positive
184 184
    bool positive(Value a) const { return _epsilon<a; }
185 185
    ///Returns \c true if \c a is \e surely negative
186 186
    bool negative(Value a) const { return -_epsilon>a; }
187 187
    ///Returns \c true if \c a is \e surely non-zero
188 188
    bool nonZero(Value a) const { return positive(a)||negative(a); }
189 189

	
190 190
    ///@}
191 191

	
192 192
    ///Returns zero
193 193
    static Value zero() {return 0;}
194 194
  };
195 195

	
196 196
  ///Long double specialization of \ref Tolerance.
197 197

	
198 198
  ///Long double specialization of \ref Tolerance.
199 199
  ///\sa Tolerance
200 200
  ///\relates Tolerance
201 201
  template<>
202 202
  class Tolerance<long double>
203 203
  {
204 204
    static long double def_epsilon;
205 205
    long double _epsilon;
206 206
  public:
207 207
    ///\e
208 208
    typedef long double Value;
209 209

	
210 210
    ///Constructor setting the epsilon tolerance to the default value.
211 211
    Tolerance() : _epsilon(def_epsilon) {}
212 212
    ///Constructor setting the epsilon tolerance.
213 213
    Tolerance(long double e) : _epsilon(e) {}
214 214

	
215 215
    ///Return the epsilon value.
216 216
    Value epsilon() const {return _epsilon;}
217 217
    ///Set the epsilon value.
218 218
    void epsilon(Value e) {_epsilon=e;}
219 219

	
220 220
    ///Return the default epsilon value.
221 221
    static Value defaultEpsilon() {return def_epsilon;}
222 222
    ///Set the default epsilon value.
223 223
    static void defaultEpsilon(Value e) {def_epsilon=e;}
224 224

	
225 225
    ///\name Comparisons
226 226
    ///See class Tolerance for more details.
227 227

	
228 228
    ///@{
229 229

	
230 230
    ///Returns \c true if \c a is \e surely strictly less than \c b
231 231
    bool less(Value a,Value b) const {return a+_epsilon<b;}
232 232
    ///Returns \c true if \c a is \e surely different from \c b
233 233
    bool different(Value a,Value b) const { return less(a,b)||less(b,a); }
234 234
    ///Returns \c true if \c a is \e surely positive
235 235
    bool positive(Value a) const { return _epsilon<a; }
236 236
    ///Returns \c true if \c a is \e surely negative
237 237
    bool negative(Value a) const { return -_epsilon>a; }
238 238
    ///Returns \c true if \c a is \e surely non-zero
239 239
    bool nonZero(Value a) const { return positive(a)||negative(a); }
240 240

	
241 241
    ///@}
242 242

	
243 243
    ///Returns zero
244 244
    static Value zero() {return 0;}
245 245
  };
246 246

	
247 247
  ///Integer specialization of \ref Tolerance.
248 248

	
249 249
  ///Integer specialization of \ref Tolerance.
250 250
  ///\sa Tolerance
251 251
  template<>
252 252
  class Tolerance<int>
253 253
  {
254 254
  public:
255 255
    ///\e
256 256
    typedef int Value;
257 257

	
258 258
    ///\name Comparisons
259 259
    ///See \ref Tolerance for more details.
260 260

	
261 261
    ///@{
262 262

	
263 263
    ///Returns \c true if \c a is \e surely strictly less than \c b
264 264
    static bool less(Value a,Value b) { return a<b;}
265 265
    ///Returns \c true if \c a is \e surely different from \c b
266 266
    static bool different(Value a,Value b) { return a!=b; }
267 267
    ///Returns \c true if \c a is \e surely positive
268 268
    static bool positive(Value a) { return 0<a; }
269 269
    ///Returns \c true if \c a is \e surely negative
270 270
    static bool negative(Value a) { return 0>a; }
271 271
    ///Returns \c true if \c a is \e surely non-zero
272 272
    static bool nonZero(Value a) { return a!=0; }
273 273

	
274 274
    ///@}
275 275

	
276 276
    ///Returns zero
277 277
    static Value zero() {return 0;}
278 278
  };
279 279

	
280 280
  ///Unsigned integer specialization of \ref Tolerance.
281 281

	
282 282
  ///Unsigned integer specialization of \ref Tolerance.
283 283
  ///\sa Tolerance
284 284
  template<>
285 285
  class Tolerance<unsigned int>
286 286
  {
287 287
  public:
288 288
    ///\e
289 289
    typedef unsigned int Value;
290 290

	
291 291
    ///\name Comparisons
292 292
    ///See \ref Tolerance for more details.
293 293

	
294 294
    ///@{
295 295

	
296 296
    ///Returns \c true if \c a is \e surely strictly less than \c b
297 297
    static bool less(Value a,Value b) { return a<b;}
298 298
    ///Returns \c true if \c a is \e surely different from \c b
299 299
    static bool different(Value a,Value b) { return a!=b; }
300 300
    ///Returns \c true if \c a is \e surely positive
301 301
    static bool positive(Value a) { return 0<a; }
302 302
    ///Returns \c true if \c a is \e surely negative
303 303
    static bool negative(Value) { return false; }
304 304
    ///Returns \c true if \c a is \e surely non-zero
305 305
    static bool nonZero(Value a) { return a!=0; }
306 306

	
307 307
    ///@}
308 308

	
309 309
    ///Returns zero
310 310
    static Value zero() {return 0;}
311 311
  };
312 312
  
313 313

	
314 314
  ///Long integer specialization of \ref Tolerance.
315 315

	
316 316
  ///Long integer specialization of \ref Tolerance.
317 317
  ///\sa Tolerance
318 318
  template<>
319 319
  class Tolerance<long int>
320 320
  {
321 321
  public:
322 322
    ///\e
323 323
    typedef long int Value;
324 324

	
325 325
    ///\name Comparisons
326 326
    ///See \ref Tolerance for more details.
327 327

	
328 328
    ///@{
329 329

	
330 330
    ///Returns \c true if \c a is \e surely strictly less than \c b
331 331
    static bool less(Value a,Value b) { return a<b;}
332 332
    ///Returns \c true if \c a is \e surely different from \c b
333 333
    static bool different(Value a,Value b) { return a!=b; }
334 334
    ///Returns \c true if \c a is \e surely positive
335 335
    static bool positive(Value a) { return 0<a; }
336 336
    ///Returns \c true if \c a is \e surely negative
337 337
    static bool negative(Value a) { return 0>a; }
338 338
    ///Returns \c true if \c a is \e surely non-zero
339 339
    static bool nonZero(Value a) { return a!=0;}
340 340

	
341 341
    ///@}
342 342

	
343 343
    ///Returns zero
344 344
    static Value zero() {return 0;}
345 345
  };
346 346

	
347 347
  ///Unsigned long integer specialization of \ref Tolerance.
348 348

	
349 349
  ///Unsigned long integer specialization of \ref Tolerance.
350 350
  ///\sa Tolerance
351 351
  template<>
352 352
  class Tolerance<unsigned long int>
353 353
  {
354 354
  public:
355 355
    ///\e
356 356
    typedef unsigned long int Value;
357 357

	
358 358
    ///\name Comparisons
359 359
    ///See \ref Tolerance for more details.
360 360

	
361 361
    ///@{
362 362

	
363 363
    ///Returns \c true if \c a is \e surely strictly less than \c b
364 364
    static bool less(Value a,Value b) { return a<b;}
365 365
    ///Returns \c true if \c a is \e surely different from \c b
366 366
    static bool different(Value a,Value b) { return a!=b; }
367 367
    ///Returns \c true if \c a is \e surely positive
368 368
    static bool positive(Value a) { return 0<a; }
369 369
    ///Returns \c true if \c a is \e surely negative
370 370
    static bool negative(Value) { return false; }
371 371
    ///Returns \c true if \c a is \e surely non-zero
372 372
    static bool nonZero(Value a) { return a!=0;}
373 373

	
374 374
    ///@}
375 375

	
376 376
    ///Returns zero
377 377
    static Value zero() {return 0;}
378 378
  };
379 379

	
380 380
#if defined __GNUC__ && !defined __STRICT_ANSI__
381 381

	
382 382
  ///Long long integer specialization of \ref Tolerance.
383 383

	
384 384
  ///Long long integer specialization of \ref Tolerance.
385 385
  ///\warning This class (more exactly, type <tt>long long</tt>)
386 386
  ///is not ansi compatible.
387 387
  ///\sa Tolerance
388 388
  template<>
389 389
  class Tolerance<long long int>
390 390
  {
391 391
  public:
392 392
    ///\e
393 393
    typedef long long int Value;
394 394

	
395 395
    ///\name Comparisons
396 396
    ///See \ref Tolerance for more details.
397 397

	
398 398
    ///@{
399 399

	
400 400
    ///Returns \c true if \c a is \e surely strictly less than \c b
401 401
    static bool less(Value a,Value b) { return a<b;}
402 402
    ///Returns \c true if \c a is \e surely different from \c b
403 403
    static bool different(Value a,Value b) { return a!=b; }
404 404
    ///Returns \c true if \c a is \e surely positive
405 405
    static bool positive(Value a) { return 0<a; }
406 406
    ///Returns \c true if \c a is \e surely negative
407 407
    static bool negative(Value a) { return 0>a; }
408 408
    ///Returns \c true if \c a is \e surely non-zero
409 409
    static bool nonZero(Value a) { return a!=0;}
410 410

	
411 411
    ///@}
412 412

	
413 413
    ///Returns zero
414 414
    static Value zero() {return 0;}
415 415
  };
416 416

	
417 417
  ///Unsigned long long integer specialization of \ref Tolerance.
418 418

	
419 419
  ///Unsigned long long integer specialization of \ref Tolerance.
420 420
  ///\warning This class (more exactly, type <tt>unsigned long long</tt>)
421 421
  ///is not ansi compatible.
422 422
  ///\sa Tolerance
423 423
  template<>
424 424
  class Tolerance<unsigned long long int>
425 425
  {
426 426
  public:
427 427
    ///\e
428 428
    typedef unsigned long long int Value;
429 429

	
430 430
    ///\name Comparisons
431 431
    ///See \ref Tolerance for more details.
432 432

	
433 433
    ///@{
434 434

	
435 435
    ///Returns \c true if \c a is \e surely strictly less than \c b
436 436
    static bool less(Value a,Value b) { return a<b;}
437 437
    ///Returns \c true if \c a is \e surely different from \c b
438 438
    static bool different(Value a,Value b) { return a!=b; }
439 439
    ///Returns \c true if \c a is \e surely positive
440 440
    static bool positive(Value a) { return 0<a; }
441 441
    ///Returns \c true if \c a is \e surely negative
442 442
    static bool negative(Value) { return false; }
443 443
    ///Returns \c true if \c a is \e surely non-zero
444 444
    static bool nonZero(Value a) { return a!=0;}
445 445

	
446 446
    ///@}
447 447

	
448 448
    ///Returns zero
449 449
    static Value zero() {return 0;}
450 450
  };
451 451

	
452 452
#endif
453 453

	
454 454
  /// @}
455 455

	
456 456
} //namespace lemon
457 457

	
458 458
#endif //LEMON_TOLERANCE_H
Ignore white space 6 line context
1 1
/* -*- C++ -*-
2 2
 *
3 3
 * This file is a part of LEMON, a generic C++ optimization library
4 4
 *
5
 * Copyright (C) 2003-2007
5
 * Copyright (C) 2003-2008
6 6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
8 8
 *
9 9
 * Permission to use, modify and distribute this software is granted
10 10
 * provided that this copyright notice appears in all copies. For
11 11
 * precise terms see the accompanying LICENSE file.
12 12
 *
13 13
 * This software is provided "AS IS" with no warranty of any kind,
14 14
 * express or implied, and with no claim as to its suitability for any
15 15
 * purpose.
16 16
 *
17 17
 */
18 18

	
19 19
#include <lemon/dim2.h>
20 20
#include <iostream>
21 21
#include "test_tools.h"
22 22

	
23 23
using namespace std;
24 24
using namespace lemon;
25 25

	
26 26
int main()
27 27
{
28 28
  cout << "Testing classes 'dim2::Point' and 'dim2::BoundingBox'." << endl;
29 29

	
30 30
  typedef dim2::Point<int> Point;
31 31

	
32 32
  Point p;
33 33
  check(p.size()==2, "Wrong vector initialization.");
34 34

	
35 35
  Point a(1,2);
36 36
  Point b(3,4);
37 37
  check(a[0]==1 && a[1]==2, "Wrong vector initialization.");
38 38

	
39 39
  p = a+b;
40 40
  check(p.x==4 && p.y==6, "Wrong vector addition.");
41 41

	
42 42
  p = a-b;
43 43
  check(p.x==-2 && p.y==-2, "Wrong vector subtraction.");
44 44

	
45 45
  check(a.normSquare()==5,"Wrong vector norm calculation.");
46 46
  check(a*b==11, "Wrong vector scalar product.");
47 47

	
48 48
  int l=2;
49 49
  p = a*l;
50 50
  check(p.x==2 && p.y==4, "Wrong vector multiplication by a scalar.");
51 51

	
52 52
  p = b/l;
53 53
  check(p.x==1 && p.y==2, "Wrong vector division by a scalar.");
54 54

	
55 55
  typedef dim2::BoundingBox<int> BB;
56 56
  BB box1;
57 57
  check(box1.empty(), "It should be empty.");
58 58

	
59 59
  box1.add(a);
60 60
  check(!box1.empty(), "It should not be empty.");
61 61
  box1.add(b);
62 62

	
63 63
  check(box1.bottomLeft().x==1 &&
64 64
        box1.bottomLeft().y==2 &&
65 65
        box1.topRight().x==3 &&
66 66
        box1.topRight().y==4,
67 67
        "Wrong addition of points to box.");
68 68

	
69 69
  p.x=2; p.y=3;
70 70
  check(box1.inside(p), "It should be inside.");
71 71

	
72 72
  p.x=1; p.y=3;
73 73
  check(box1.inside(p), "It should be inside.");
74 74

	
75 75
  p.x=0; p.y=3;
76 76
  check(!box1.inside(p), "It should not be inside.");
77 77

	
78 78
  BB box2(p);
79 79
  check(!box2.empty(),
80 80
        "It should not be empty. Constructed from 1 point.");
81 81

	
82 82
  box2.add(box1);
83 83
  check(box2.inside(p),
84 84
        "It should be inside. Incremented a box with another one.");
85 85

	
86 86
  return 0;
87 87
}
Ignore white space 6 line context
1 1
/* -*- C++ -*-
2 2
 *
3 3
 * This file is a part of LEMON, a generic C++ optimization library
4 4
 *
5
 * Copyright (C) 2003-2007
5
 * Copyright (C) 2003-2008
6 6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
8 8
 *
9 9
 * Permission to use, modify and distribute this software is granted
10 10
 * provided that this copyright notice appears in all copies. For
11 11
 * precise terms see the accompanying LICENSE file.
12 12
 *
13 13
 * This software is provided "AS IS" with no warranty of any kind,
14 14
 * express or implied, and with no claim as to its suitability for any
15 15
 * purpose.
16 16
 *
17 17
 */
18 18

	
19 19
#include <deque>
20 20
#include <set>
21 21

	
22 22
#include <lemon/concept_check.h>
23 23
#include <lemon/concepts/maps.h>
24 24
#include <lemon/maps.h>
25 25

	
26 26
#include "test_tools.h"
27 27

	
28 28
using namespace lemon;
29 29
using namespace lemon::concepts;
30 30

	
31 31
struct A {};
32 32
inline bool operator<(A, A) { return true; }
33 33
struct B {};
34 34

	
35 35
class F {
36 36
public:
37 37
  typedef A argument_type;
38 38
  typedef B result_type;
39 39

	
40 40
  B operator()(const A &) const {return B();}
41 41
};
42 42

	
43 43
int func(A) {return 3;}
44 44

	
45 45
int binc(int, B) {return 4;}
46 46

	
47 47
typedef ReadMap<A,double> DoubleMap;
48 48
typedef ReadWriteMap<A, double> WriteDoubleMap;
49 49

	
50 50
typedef ReadMap<A,bool> BoolMap;
51 51
typedef ReadWriteMap<A, bool> BoolWriteMap;
52 52

	
53 53
int main()
54 54
{ // checking graph components
55 55
  
56 56
  checkConcept<ReadMap<A,B>, ReadMap<A,B> >();
57 57
  checkConcept<WriteMap<A,B>, WriteMap<A,B> >();
58 58
  checkConcept<ReadWriteMap<A,B>, ReadWriteMap<A,B> >();
59 59
  checkConcept<ReferenceMap<A,B,B&,const B&>, ReferenceMap<A,B,B&,const B&> >();
60 60

	
61 61
  checkConcept<ReadMap<A,double>, AddMap<DoubleMap,DoubleMap> >();
62 62
  checkConcept<ReadMap<A,double>, SubMap<DoubleMap,DoubleMap> >();
63 63
  checkConcept<ReadMap<A,double>, MulMap<DoubleMap,DoubleMap> >();
64 64
  checkConcept<ReadMap<A,double>, DivMap<DoubleMap,DoubleMap> >();
65 65
  checkConcept<ReadMap<A,double>, NegMap<DoubleMap> >();
66 66
  checkConcept<ReadWriteMap<A,double>, NegWriteMap<WriteDoubleMap> >();
67 67
  checkConcept<ReadMap<A,double>, AbsMap<DoubleMap> >();
68 68
  checkConcept<ReadMap<A,double>, ShiftMap<DoubleMap> >();
69 69
  checkConcept<ReadWriteMap<A,double>, ShiftWriteMap<WriteDoubleMap> >();
70 70
  checkConcept<ReadMap<A,double>, ScaleMap<DoubleMap> >();
71 71
  checkConcept<ReadWriteMap<A,double>, ScaleWriteMap<WriteDoubleMap> >();
72 72
  checkConcept<ReadMap<A,double>, ForkMap<DoubleMap, DoubleMap> >();
73 73
  checkConcept<ReadWriteMap<A,double>, 
74 74
    ForkWriteMap<WriteDoubleMap, WriteDoubleMap> >();
75 75
  
76 76
  checkConcept<ReadMap<B,double>, ComposeMap<DoubleMap,ReadMap<B,A> > >();
77 77

	
78 78
  checkConcept<ReadMap<A,B>, FunctorMap<F, A, B> >();
79 79

	
80 80
  checkConcept<ReadMap<A, bool>, NotMap<BoolMap> >();
81 81
  checkConcept<ReadWriteMap<A, bool>, NotWriteMap<BoolWriteMap> >();
82 82

	
83 83
  checkConcept<WriteMap<A, bool>, StoreBoolMap<A*> >();
84 84
  checkConcept<WriteMap<A, bool>, BackInserterBoolMap<std::deque<A> > >();
85 85
  checkConcept<WriteMap<A, bool>, FrontInserterBoolMap<std::deque<A> > >();
86 86
  checkConcept<WriteMap<A, bool>, InserterBoolMap<std::set<A> > >();
87 87
  checkConcept<WriteMap<A, bool>, FillBoolMap<WriteMap<A, B> > >();
88 88
  checkConcept<WriteMap<A, bool>, SettingOrderBoolMap<WriteMap<A, int> > >();
89 89

	
90 90
  int a;
91 91
  
92 92
  a=mapFunctor(constMap<A,int>(2))(A());
93 93
  check(a==2,"Something is wrong with mapFunctor");
94 94

	
95 95
  B b;
96 96
  b=functorMap(F())[A()];
97 97

	
98 98
  a=functorMap(&func)[A()];
99 99
  check(a==3,"Something is wrong with functorMap");
100 100

	
101 101
  a=combineMap(constMap<B, int, 1>(), identityMap<B>(), &binc)[B()];
102 102
  check(a==4,"Something is wrong with combineMap");
103 103
  
104 104

	
105 105
  std::cout << __FILE__ ": All tests passed.\n";
106 106
  
107 107
  return 0;
108 108
}
Ignore white space 6 line context
1 1
/* -*- C++ -*-
2 2
 *
3 3
 * This file is a part of LEMON, a generic C++ optimization library
4 4
 *
5
 * Copyright (C) 2003-2007
5
 * Copyright (C) 2003-2008
6 6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
8 8
 *
9 9
 * Permission to use, modify and distribute this software is granted
10 10
 * provided that this copyright notice appears in all copies. For
11 11
 * precise terms see the accompanying LICENSE file.
12 12
 *
13 13
 * This software is provided "AS IS" with no warranty of any kind,
14 14
 * express or implied, and with no claim as to its suitability for any
15 15
 * purpose.
16 16
 *
17 17
 */
18 18

	
19 19
#include <lemon/random.h>
20 20
#include "test_tools.h"
21 21

	
22 22
///\file \brief Test cases for random.h
23 23
///
24 24
///\todo To be extended
25 25
///
26 26

	
27 27
int main()
28 28
{
29 29
  double a=lemon::rnd();
30 30
  check(a<1.0&&a>0.0,"This should be in [0,1)");
31 31
  a=lemon::rnd.gauss();
32 32
  a=lemon::rnd.gamma(3.45,0);
33 33
  a=lemon::rnd.gamma(4);
34 34
  //Does gamma work with integer k?
35 35
  a=lemon::rnd.gamma(4.0,0);
36 36
}
Ignore white space 6 line context
1 1
/* -*- C++ -*-
2 2
 *
3 3
 * This file is a part of LEMON, a generic C++ optimization library
4 4
 *
5
 * Copyright (C) 2003-2007
5
 * Copyright (C) 2003-2008
6 6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
8 8
 *
9 9
 * Permission to use, modify and distribute this software is granted
10 10
 * provided that this copyright notice appears in all copies. For
11 11
 * precise terms see the accompanying LICENSE file.
12 12
 *
13 13
 * This software is provided "AS IS" with no warranty of any kind,
14 14
 * express or implied, and with no claim as to its suitability for any
15 15
 * purpose.
16 16
 *
17 17
 */
18 18

	
19 19
#ifndef LEMON_TEST_TEST_TOOLS_H
20 20
#define LEMON_TEST_TEST_TOOLS_H
21 21

	
22 22
#include <iostream>
23 23

	
24 24
//! \ingroup misc
25 25
//! \file
26 26
//! \brief Some utilities to write test programs.
27 27

	
28 28

	
29 29
///If \c rc is fail, writes an error message end exit.
30 30

	
31 31
///If \c rc is fail, writes an error message end exit.
32 32
///The error message contains the file name and the line number of the
33 33
///source code in a standard from, which makes it possible to go there
34 34
///using good source browsers like e.g. \c emacs.
35 35
///
36 36
///For example
37 37
///\code check(0==1,"This is obviously false.");\endcode will
38 38
///print this (and then exits).
39 39
///\verbatim graph_test.cc:123: error: This is obviously false. \endverbatim
40 40
///
41 41
///\todo It should be in \c error.h
42 42
#define check(rc, msg) \
43 43
  if(!(rc)) { \
44 44
    std::cerr << __FILE__ ":" << __LINE__ << ": error: " << msg << std::endl; \
45 45
    abort(); \
46 46
  } else { } \
47 47

	
48 48
#endif
Ignore white space 6 line context
1 1
/* -*- C++ -*-
2 2
 *
3 3
 * This file is a part of LEMON, a generic C++ optimization library
4 4
 *
5
 * Copyright (C) 2003-2007
5
 * Copyright (C) 2003-2008
6 6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
8 8
 *
9 9
 * Permission to use, modify and distribute this software is granted
10 10
 * provided that this copyright notice appears in all copies. For
11 11
 * precise terms see the accompanying LICENSE file.
12 12
 *
13 13
 * This software is provided "AS IS" with no warranty of any kind,
14 14
 * express or implied, and with no claim as to its suitability for any
15 15
 * purpose.
16 16
 *
17 17
 */
18 18

	
19 19
#include "test_tools.h"
20 20

	
21 21
int main() 
22 22
{
23 23
  check(false, "Don't panic. Failing is the right behaviour here.");
24 24
  return 0;
25 25
}
Ignore white space 6 line context
1 1
/* -*- C++ -*-
2 2
 *
3 3
 * This file is a part of LEMON, a generic C++ optimization library
4 4
 *
5
 * Copyright (C) 2003-2007
5
 * Copyright (C) 2003-2008
6 6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
8 8
 *
9 9
 * Permission to use, modify and distribute this software is granted
10 10
 * provided that this copyright notice appears in all copies. For
11 11
 * precise terms see the accompanying LICENSE file.
12 12
 *
13 13
 * This software is provided "AS IS" with no warranty of any kind,
14 14
 * express or implied, and with no claim as to its suitability for any
15 15
 * purpose.
16 16
 *
17 17
 */
18 18

	
19 19
#include "test_tools.h"
20 20

	
21 21
int main() 
22 22
{
23 23
  check(true, "It should pass.");
24 24
  return 0;
25 25
}
0 comments (0 inline)