lemon/concepts/maps.h
author Peter Kovacs <kpeter@inf.elte.hu>
Tue, 05 Feb 2008 17:36:46 +0100
changeset 72 7050661bdea4
parent 39 0a01d811071f
parent 48 93ae269876de
child 74 9394072da54f
permissions -rw-r--r--
Fix doxygen warnings.
alpar@25
     1
/* -*- C++ -*-
alpar@25
     2
 *
alpar@25
     3
 * This file is a part of LEMON, a generic C++ optimization library
alpar@25
     4
 *
alpar@39
     5
 * Copyright (C) 2003-2008
alpar@25
     6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
alpar@25
     7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
alpar@25
     8
 *
alpar@25
     9
 * Permission to use, modify and distribute this software is granted
alpar@25
    10
 * provided that this copyright notice appears in all copies. For
alpar@25
    11
 * precise terms see the accompanying LICENSE file.
alpar@25
    12
 *
alpar@25
    13
 * This software is provided "AS IS" with no warranty of any kind,
alpar@25
    14
 * express or implied, and with no claim as to its suitability for any
alpar@25
    15
 * purpose.
alpar@25
    16
 *
alpar@25
    17
 */
alpar@25
    18
alpar@25
    19
#ifndef LEMON_CONCEPT_MAPS_H
alpar@25
    20
#define LEMON_CONCEPT_MAPS_H
alpar@25
    21
alpar@25
    22
#include <lemon/bits/utility.h>
alpar@25
    23
#include <lemon/concept_check.h>
alpar@25
    24
alpar@25
    25
///\ingroup concept
alpar@25
    26
///\file
alpar@25
    27
///\brief Map concepts checking classes for testing and documenting.
alpar@25
    28
alpar@25
    29
namespace lemon {
alpar@25
    30
alpar@25
    31
  namespace concepts {
alpar@25
    32
  
alpar@25
    33
    /// \addtogroup concept
alpar@25
    34
    /// @{
alpar@25
    35
alpar@25
    36
    /// Readable map concept
kpeter@28
    37
kpeter@28
    38
    /// Readable map concept.
kpeter@28
    39
    ///
alpar@25
    40
    template<typename K, typename T>
alpar@25
    41
    class ReadMap
alpar@25
    42
    {
alpar@25
    43
    public:
kpeter@35
    44
      /// The key type of the map.
alpar@25
    45
      typedef K Key;    
kpeter@35
    46
      /// The value type of the map. (The type of objects associated with the keys).
alpar@25
    47
      typedef T Value;
alpar@25
    48
alpar@25
    49
      /// Returns the value associated with a key.
alpar@25
    50
kpeter@48
    51
      /// Returns the value associated with a key.
kpeter@28
    52
      /// \bug Value shouldn't need to be default constructible.
alpar@25
    53
      ///
alpar@25
    54
      Value operator[](const Key &) const {return Value();}
alpar@25
    55
alpar@25
    56
      template<typename _ReadMap>
alpar@25
    57
      struct Constraints {
alpar@25
    58
alpar@25
    59
	void constraints() {
alpar@25
    60
	  Value val = m[key];
alpar@25
    61
	  val = m[key];
alpar@25
    62
	  typename _ReadMap::Value own_val = m[own_key]; 
alpar@25
    63
	  own_val = m[own_key]; 
alpar@25
    64
alpar@25
    65
	  ignore_unused_variable_warning(val);
alpar@25
    66
	  ignore_unused_variable_warning(own_val);
alpar@25
    67
	  ignore_unused_variable_warning(key);
alpar@25
    68
	}
alpar@25
    69
	Key& key;
alpar@25
    70
	typename _ReadMap::Key& own_key;
alpar@25
    71
	_ReadMap& m;
alpar@25
    72
      };
alpar@25
    73
      
alpar@25
    74
    };
alpar@25
    75
alpar@25
    76
alpar@25
    77
    /// Writable map concept
kpeter@28
    78
    
kpeter@28
    79
    /// Writable map concept.
kpeter@28
    80
    ///
alpar@25
    81
    template<typename K, typename T>
alpar@25
    82
    class WriteMap
alpar@25
    83
    {
alpar@25
    84
    public:
kpeter@35
    85
      /// The key type of the map.
alpar@25
    86
      typedef K Key;    
kpeter@35
    87
      /// The value type of the map. (The type of objects associated with the keys).
alpar@25
    88
      typedef T Value;
alpar@25
    89
alpar@25
    90
      /// Sets the value associated with a key.
alpar@25
    91
      void set(const Key &,const Value &) {}
alpar@25
    92
alpar@25
    93
      ///Default constructor
alpar@25
    94
      WriteMap() {}
alpar@25
    95
alpar@25
    96
      template <typename _WriteMap>
alpar@25
    97
      struct Constraints {
alpar@25
    98
	void constraints() {
alpar@25
    99
	  // No constraints for constructor.
alpar@25
   100
	  m.set(key, val);
alpar@25
   101
	  m.set(own_key, own_val);
alpar@25
   102
	  ignore_unused_variable_warning(key);
alpar@25
   103
	  ignore_unused_variable_warning(val);
alpar@25
   104
	  ignore_unused_variable_warning(own_key);
alpar@25
   105
	  ignore_unused_variable_warning(own_val);
alpar@25
   106
	}
alpar@25
   107
alpar@25
   108
	Value& val;
alpar@25
   109
	typename _WriteMap::Value own_val;
alpar@25
   110
	Key& key;
alpar@25
   111
	typename _WriteMap::Key& own_key;
alpar@25
   112
	_WriteMap& m;
alpar@25
   113
alpar@25
   114
      };
alpar@25
   115
    };
alpar@25
   116
kpeter@48
   117
    /// Read/writable map concept
kpeter@28
   118
    
kpeter@28
   119
    /// Read/writable map concept.
kpeter@28
   120
    ///
alpar@25
   121
    template<typename K, typename T>
alpar@25
   122
    class ReadWriteMap : public ReadMap<K,T>,
kpeter@35
   123
			 public WriteMap<K,T>
alpar@25
   124
    {
alpar@25
   125
    public:
kpeter@35
   126
      /// The key type of the map.
alpar@25
   127
      typedef K Key;    
kpeter@35
   128
      /// The value type of the map. (The type of objects associated with the keys).
alpar@25
   129
      typedef T Value;
alpar@25
   130
alpar@25
   131
      /// Returns the value associated with a key.
alpar@25
   132
      Value operator[](const Key &) const {return Value();}
alpar@25
   133
      /// Sets the value associated with a key.
alpar@25
   134
      void set(const Key & ,const Value &) {}
alpar@25
   135
alpar@25
   136
      template<typename _ReadWriteMap>
alpar@25
   137
      struct Constraints {
alpar@25
   138
	void constraints() {
alpar@25
   139
	  checkConcept<ReadMap<K, T>, _ReadWriteMap >();
alpar@25
   140
	  checkConcept<WriteMap<K, T>, _ReadWriteMap >();
alpar@25
   141
	}
alpar@25
   142
      };
alpar@25
   143
    };
alpar@25
   144
  
alpar@25
   145
  
kpeter@28
   146
    /// Dereferable map concept
kpeter@28
   147
    
kpeter@28
   148
    /// Dereferable map concept.
kpeter@28
   149
    ///
kpeter@48
   150
    /// \todo Rethink this concept.
alpar@25
   151
    template<typename K, typename T, typename R, typename CR>
alpar@25
   152
    class ReferenceMap : public ReadWriteMap<K,T>
alpar@25
   153
    {
alpar@25
   154
    public:
alpar@25
   155
      /// Tag for reference maps.
alpar@25
   156
      typedef True ReferenceMapTag;
kpeter@35
   157
      /// The key type of the map.
alpar@25
   158
      typedef K Key;    
kpeter@35
   159
      /// The value type of the map. (The type of objects associated with the keys).
alpar@25
   160
      typedef T Value;
kpeter@35
   161
      /// The reference type of the map.
alpar@25
   162
      typedef R Reference;
kpeter@35
   163
      /// The const reference type of the map.
alpar@25
   164
      typedef CR ConstReference;
alpar@25
   165
alpar@25
   166
    protected:
alpar@25
   167
      Value tmp;
alpar@25
   168
    public:
alpar@25
   169
kpeter@48
   170
      ///Returns a reference to the value associated with a key.
alpar@25
   171
      Reference operator[](const Key &) { return tmp; }
kpeter@48
   172
      ///Returns a const reference to the value associated with a key.
kpeter@28
   173
      ConstReference operator[](const Key &) const { return tmp; }
alpar@25
   174
      /// Sets the value associated with a key.
alpar@25
   175
      void set(const Key &k,const Value &t) { operator[](k)=t; }
alpar@25
   176
alpar@25
   177
      template<typename _ReferenceMap>
alpar@25
   178
      struct ReferenceMapConcept {
alpar@25
   179
alpar@25
   180
	void constraints() {
alpar@25
   181
	  checkConcept<ReadWriteMap, _ReferenceMap >();
alpar@25
   182
	  m[key] = val;
alpar@25
   183
	  val  = m[key];
alpar@25
   184
	  m[key] = ref;
alpar@25
   185
	  ref = m[key];
alpar@25
   186
	  m[own_key] = own_val;
alpar@25
   187
	  own_val  = m[own_key];
alpar@25
   188
	  m[own_key] = own_ref;
alpar@25
   189
	  own_ref = m[own_key];	  	  
alpar@25
   190
	}
alpar@25
   191
alpar@25
   192
	typename _ReferenceMap::Key& own_key;
alpar@25
   193
	typename _ReferenceMap::Value& own_val;
alpar@25
   194
	typename _ReferenceMap::Reference& own_ref;
alpar@25
   195
	Key& key;
alpar@25
   196
	Value& val;
alpar@25
   197
	Reference& ref;
alpar@25
   198
	_ReferenceMap& m;
alpar@25
   199
      };
alpar@25
   200
    };
alpar@25
   201
alpar@25
   202
    // @}
alpar@25
   203
alpar@25
   204
  } //namespace concepts
kpeter@28
   205
alpar@25
   206
} //namespace lemon
kpeter@28
   207
alpar@25
   208
#endif // LEMON_CONCEPT_MAPS_H