include/anna/core/util/LRUMap.hpp

   1 // ANNA - Anna is Not 'N' Anymore
   2 //
   3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
   4 //
   5 // https://bitbucket.org/testillano/anna
   6 //
   7 // Redistribution and use in source and binary forms, with or without
   8 // modification, are permitted provided that the following conditions
   9 // are met:
  10 //
  11 //     * Redistributions of source code must retain the above copyright
  12 // notice, this list of conditions and the following disclaimer.
  13 //     * Redistributions in binary form must reproduce the above
  14 // copyright notice, this list of conditions and the following disclaimer
  15 // in the documentation and/or other materials provided with the
  16 // distribution.
  17 //     * Neither the name of Google Inc. nor the names of its
  18 // contributors may be used to endorse or promote products derived from
  19 // this software without specific prior written permission.
  20 //
  21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32 //
  33 // Authors: eduardo.ramos.testillano@gmail.com
  34 //          cisco.tierra@gmail.com
  35
  36
  37 #ifndef anna_core_util_LRUMap_hpp
  38 #define anna_core_util_LRUMap_hpp
  39
  40 #include <map>
  41
  42 #include <anna/config/defines.hpp>
  43
  44 namespace anna {
  45
  46 /**
  47    Patrón que permite mantener una lista de N elementos de pares (Clave, Valor).
  48
  49    Es capaz de realizar una búsqueda indexada de la clave para obtener el valor,
  50    pero además es capaz de mantener estable el número de elementos contenidos
  51    en ésta clase.
  52
  53    Si se alcanza el número máximo de elementos indicados en el constructor, si se requiere
  54    incluir un nuevo objeto, primero liberará el objeto que lleve más tiempo si ser usado.
  55
  56    \param K clase que actuará como clave del mapa. Requiere el contructor de copia, y los operadores de comparación == y <.
  57    \param V clase que actuará como dato asociado a la clave. Requiere el constructor copia y el operador copia.
  58 */
  59 template <typename K, typename V> class LRUMap {
  60   typedef typename std::pair <V, anna::Millisecond> timed_value;
  61   typedef typename std::map <K, timed_value> container;
  62   typedef typename container::value_type value_type;
  63
  64 public:
  65   typedef typename container::iterator iterator;
  66   typedef typename container::const_iterator const_iterator;
  67
  68   /**
  69      Constructor.
  70      \param name Nombre logico de esta instancia.
  71      \param measure Unidad de medida. Solo se usa a efecto de salida de datos.
  72   */
  73   LRUMap(const char* name, const int maxSize) : a_name(name), a_maxSize(maxSize) { ;}
  74
  75   /**
  76    * Destructor.
  77    */
  78   ~LRUMap() { clear(); }
  79
  80   /**
  81      Devuelve el indicador de validez de esta media.
  82      \return \em true Si la media no tiene ningun valor o \em false en caso contrario.
  83   */
  84   bool isEmpty() const throw() { return a_container.size() == 0; }
  85
  86   /**
  87    * Devuelve el número de elementos contenidos en este contenedor.
  88    * \return  el número de elementos contenidos en este contenedor.
  89    */
  90   int size() const throw() { return a_container.size(); }
  91
  92   /**
  93    * Devuelve el puntero al valor asociado a la clave recibida como parámetro.
  94    * Puede ser NULL si la pareja (K,V) no está registrada en el contenedor.
  95    *
  96    * \param key Clave de la que obtener el valor asociado.
  97    *
  98    * \return El puntero al valor asociado a la clave recibida como parámetro.
  99    * */
 100   V* find(const K& key) throw() {
 101     iterator ii =  a_container.find(key);
 102
 103     if(ii == end())
 104       return NULL;
 105
 106     /*
 107      * Recupera el valor asociado a la clave K y actualiza el momento de acceso.
 108      */
 109     millisecond(ii) = functions::millisecond();
 110     return &value(ii);
 111   }
 112
 113   /**
 114    * Establece el valor de pareja (K,V). Si no existe se crea y si existe se sobre escribe el
 115    * valor asociado a V, y se actualiza su tiempo de acceso.
 116    *
 117    * \param key Clave de la pareja (K,V).
 118    * \param v Valor asociado a la clave.
 119    */
 120   void add(const K& key, const V& v) throw() {
 121     iterator ii = a_container.find(key);
 122
 123     // Sobreescribe el valor asociado a K y actualiza su tiempo de acceso.
 124     if(ii != end()) {
 125       value(ii) = v;
 126       millisecond(ii) = functions::millisecond();
 127       return;
 128     }
 129
 130     // Si no se ha alcanzado el máximo, sólo hay que insertar el nuevo (K,V)
 131     if(size() < a_maxSize) {
 132       timed_value tvalue(v, functions::millisecond());
 133       a_container.insert(value_type(key, tvalue));
 134       return;
 135     }
 136
 137     // Se ha alcanzado el máximo, hay que buscar el que haga más tiempo que no se
 138     // accede => el que tenga el menor 'Time' asociado.
 139     iterator minii = begin();
 140     Millisecond minTime = millisecond(minii);
 141
 142     for(iterator ii = begin(), maxii = end(); ii != maxii; ii ++) {
 143       if(millisecond(ii) < minTime)
 144         minTime = millisecond(minii = ii);
 145     }
 146
 147     /*
 148      * El map no permite sobre-escribir la clave => por eso tenemos que borrar el nodo
 149      * más antiguo y crear otro nuevo.
 150      */
 151     a_container.erase(minii);
 152     timed_value tvalue(v, functions::millisecond());
 153     a_container.insert(value_type(key, tvalue));
 154   }
 155
 156   /**
 157      Vacía este contenedor.
 158   */
 159   void clear() throw() { a_container.clear(); }
 160
 161   /**
 162    * Devuelve un iterator al primer elemento del contenedor, teniendo que la ordenación de los
 163    * pares (K,V) se hará en base a K.
 164    * \return El primer elemento del contenedor.
 165   */
 166   iterator begin() throw() { return a_container.begin(); }
 167
 168   /**
 169    * Devuelve un iterator al primer elemento del contenedor, teniendo que la ordenación de los
 170    * pares (K,V) se hará en base a K.
 171    * \return El primer elemento del contenedor.
 172   */
 173   const_iterator begin() const throw() { return a_container.begin(); }
 174
 175   /**
 176    * Devuelve un iterator al final del contenedor, teniendo que la ordenación de los  pares (K,V) se hará en
 177    * base a K.
 178    * \return El primer elemento del contenedor.
 179    */
 180   iterator end() throw() { return a_container.end(); }
 181
 182   /**
 183    * Devuelve un iterator al final del contenedor, teniendo que la ordenación de los  pares (K,V) se hará en
 184    * base a K.
 185    * \return El primer elemento del contenedor.
 186    */
 187   const_iterator end() const throw() { return a_container.end(); }
 188
 189   /**
 190    * Devuelve la clave asociada al iterador recibido como parámetro.
 191    * \param ii Iterador que debe estar comprendido entre  [#begin (), #end).
 192    * \return la clave asociada al iterador recibido como parámetro.
 193    * \warning Los acceso mediante iterador no actualiza el tiempo de acceso a la pareja (K,V).
 194    */
 195   static K key(iterator& ii) throw() { return ii->first;  }
 196
 197   /**
 198    * Devuelve el valor asociado al iterador recibido como parámetro.
 199    * \param ii Iterador que debe estar comprendido entre  [#begin (), #end).
 200    * \return el valor asociado al iterador recibido como parámetro.
 201    * \warning Los acceso mediante iterador no actualiza el tiempo de acceso a la pareja (K,V).
 202    */
 203   static V& value(iterator& ii) throw() {
 204     timed_value* v = &ii->second;
 205     return v->first;
 206   }
 207
 208   /**
 209    * Devuelve el tiempo de acceso asociado al iterador recibido como parámetro.
 210    * \param ii Iterador que debe estar comprendido entre  [#begin (), #end).
 211    * \return el tiempo de acceso asociado al iterador recibido como parámetro.
 212    */
 213   static Millisecond& millisecond(iterator& ii) throw() {
 214     timed_value* v = &ii->second;
 215     return v->second;
 216   }
 217
 218   /**
 219    * Devuelve la clave asociada al iterador recibido como parámetro.
 220    * \param ii Iterador que debe estar comprendido entre  [#begin (), #end).
 221    * \return la clave asociada al iterador recibido como parámetro.
 222    * \warning Los acceso mediante iterador no actualiza el tiempo de acceso a la pareja (K,V).
 223    */
 224   static K key(const_iterator& ii) throw() { return ii->first;  }
 225
 226   /**
 227    * Devuelve el valor asociado al iterador recibido como parámetro.
 228    * \param ii Iterador que debe estar comprendido entre  [#begin (), #end).
 229    * \return el valor asociado al iterador recibido como parámetro.
 230    * \warning Los acceso mediante iterador no actualiza el tiempo de acceso a la pareja (K,V).
 231    */
 232   static const V& value(const_iterator& ii) throw() {
 233     const timed_value* v = &ii->second;
 234     return v->first;
 235   }
 236
 237   /**
 238    * Devuelve el tiempo de acceso asociado al iterador recibido como parámetro.
 239    * \param ii Iterador que debe estar comprendido entre  [#begin (), #end).
 240    * \return el tiempo de acceso asociado al iterador recibido como parámetro.
 241    */
 242   static Millisecond millisecond(const_iterator& ii) throw() {
 243     const timed_value* v = &ii->second;
 244     return v->second;
 245   }
 246
 247   /**
 248      Devuelve una cadena con la informacion referente a esta clase.
 249      \return Una cadena con la informacion referente a esta clase.
 250   */
 251   std::string asString() const
 252   throw() {
 253     std::string msg("LRUMap { Name: ");
 254     msg += a_name;
 255     msg += functions::asText(" | N: ", a_maxSize);
 256     msg += functions::asText(" | n: ", size());
 257     return msg += " }";
 258   }
 259
 260 private:
 261   const char* a_name;
 262   const int a_maxSize;
 263   container a_container;
 264 };
 265
 266 }
 267
 268 #endif
 269
 270
 271