COIN-OR::LEMON - Graph Library

source: lemon/lemon/concepts/maps.h @ 28:e337bdf46777

Last change on this file since 28:e337bdf46777 was 28:e337bdf46777, checked in by Peter Kovacs <kpeter@…>, 11 years ago

Doc improvements.

File size: 5.0 KB
Line 
1/* -*- C++ -*-
2 *
3 * This file is a part of LEMON, a generic C++ optimization library
4 *
5 * Copyright (C) 2003-2007
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
19#ifndef LEMON_CONCEPT_MAPS_H
20#define LEMON_CONCEPT_MAPS_H
21
22#include <lemon/bits/utility.h>
23#include <lemon/concept_check.h>
24
25///\ingroup concept
26///\file
27///\brief Map concepts checking classes for testing and documenting.
28
29namespace lemon {
30
31  namespace concepts {
32 
33    /// \addtogroup concept
34    /// @{
35
36    /// Readable map concept
37
38    /// Readable map concept.
39    ///
40    template<typename K, typename T>
41    class ReadMap
42    {
43    public:
44      /// Map's key type.
45      typedef K Key;   
46      /// Map's value type. (The type of objects associated with the keys).
47      typedef T Value;
48
49      /// Returns the value associated with a key.
50
51      /// \bug Value shouldn't need to be default constructible.
52      ///
53      Value operator[](const Key &) const {return Value();}
54
55      template<typename _ReadMap>
56      struct Constraints {
57
58        void constraints() {
59          Value val = m[key];
60          val = m[key];
61          typename _ReadMap::Value own_val = m[own_key];
62          own_val = m[own_key];
63
64          ignore_unused_variable_warning(val);
65          ignore_unused_variable_warning(own_val);
66          ignore_unused_variable_warning(key);
67        }
68        Key& key;
69        typename _ReadMap::Key& own_key;
70        _ReadMap& m;
71      };
72     
73    };
74
75
76    /// Writable map concept
77   
78    /// Writable map concept.
79    ///
80    template<typename K, typename T>
81    class WriteMap
82    {
83    public:
84      /// Map's key type.
85      typedef K Key;   
86      /// Map's value type. (The type of objects associated with the keys).
87      typedef T Value;
88
89      /// Sets the value associated with a key.
90      void set(const Key &,const Value &) {}
91
92      ///Default constructor
93      WriteMap() {}
94
95      template <typename _WriteMap>
96      struct Constraints {
97        void constraints() {
98          // No constraints for constructor.
99          m.set(key, val);
100          m.set(own_key, own_val);
101          ignore_unused_variable_warning(key);
102          ignore_unused_variable_warning(val);
103          ignore_unused_variable_warning(own_key);
104          ignore_unused_variable_warning(own_val);
105        }
106
107        Value& val;
108        typename _WriteMap::Value own_val;
109        Key& key;
110        typename _WriteMap::Key& own_key;
111        _WriteMap& m;
112
113      };
114    };
115
116    /// Read/Writable map concept
117   
118    /// Read/writable map concept.
119    ///
120    template<typename K, typename T>
121    class ReadWriteMap : public ReadMap<K,T>,
122                            public WriteMap<K,T>
123    {
124    public:
125      /// Map's key type.
126      typedef K Key;   
127      /// Map's value type. (The type of objects associated with the keys).
128      typedef T Value;
129
130      /// Returns the value associated with a key.
131      Value operator[](const Key &) const {return Value();}
132      /// Sets the value associated with a key.
133      void set(const Key & ,const Value &) {}
134
135      template<typename _ReadWriteMap>
136      struct Constraints {
137        void constraints() {
138          checkConcept<ReadMap<K, T>, _ReadWriteMap >();
139          checkConcept<WriteMap<K, T>, _ReadWriteMap >();
140        }
141      };
142    };
143 
144 
145    /// Dereferable map concept
146   
147    /// Dereferable map concept.
148    ///
149    template<typename K, typename T, typename R, typename CR>
150    class ReferenceMap : public ReadWriteMap<K,T>
151    {
152    public:
153      /// Tag for reference maps.
154      typedef True ReferenceMapTag;
155      /// Map's key type.
156      typedef K Key;   
157      /// Map's value type. (The type of objects associated with the keys).
158      typedef T Value;
159      /// Map's reference type.
160      typedef R Reference;
161      /// Map's const reference type.
162      typedef CR ConstReference;
163
164    protected:
165      Value tmp;
166    public:
167
168      ///Returns a reference to the value associated to a key.
169      Reference operator[](const Key &) { return tmp; }
170      ///Returns a const reference to the value associated to a key.
171      ConstReference operator[](const Key &) const { return tmp; }
172      /// Sets the value associated with a key.
173      void set(const Key &k,const Value &t) { operator[](k)=t; }
174
175      /// \todo Rethink this concept.
176      template<typename _ReferenceMap>
177      struct ReferenceMapConcept {
178
179        void constraints() {
180          checkConcept<ReadWriteMap, _ReferenceMap >();
181          m[key] = val;
182          val  = m[key];
183          m[key] = ref;
184          ref = m[key];
185          m[own_key] = own_val;
186          own_val  = m[own_key];
187          m[own_key] = own_ref;
188          own_ref = m[own_key];           
189        }
190
191        typename _ReferenceMap::Key& own_key;
192        typename _ReferenceMap::Value& own_val;
193        typename _ReferenceMap::Reference& own_ref;
194        Key& key;
195        Value& val;
196        Reference& ref;
197        _ReferenceMap& m;
198      };
199    };
200
201    // @}
202
203  } //namespace concepts
204
205} //namespace lemon
206
207#endif // LEMON_CONCEPT_MAPS_H
Note: See TracBrowser for help on using the repository browser.