1 // ANNA - Anna is Not Nothingness Anymore
3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
5 // http://redmine.teslayout.com/projects/anna-suite
7 // Redistribution and use in source and binary forms, with or without
8 // modification, are permitted provided that the following conditions
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
17 // * Neither the name of the copyright holder 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.
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.
33 // Authors: eduardo.ramos.testillano@gmail.com
34 // cisco.tierra@gmail.com
37 #ifndef anna_core_util_LRUMap_hpp
38 #define anna_core_util_LRUMap_hpp
42 #include <anna/config/defines.hpp>
47 Patrón que permite mantener una lista de N elementos de pares (Clave, Valor).
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
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.
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.
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;
65 typedef typename container::iterator iterator;
66 typedef typename container::const_iterator const_iterator;
70 \param name Nombre logico de esta instancia.
71 \param measure Unidad de medida. Solo se usa a efecto de salida de datos.
73 LRUMap(const char* name, const int maxSize) : a_name(name), a_maxSize(maxSize) { ;}
78 ~LRUMap() { clear(); }
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.
84 bool isEmpty() const throw() { return a_container.size() == 0; }
87 * Devuelve el número de elementos contenidos en este contenedor.
88 * \return el número de elementos contenidos en este contenedor.
90 int size() const throw() { return a_container.size(); }
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.
96 * \param key Clave de la que obtener el valor asociado.
98 * \return El puntero al valor asociado a la clave recibida como parámetro.
100 V* find(const K& key) throw() {
101 iterator ii = a_container.find(key);
107 * Recupera el valor asociado a la clave K y actualiza el momento de acceso.
109 millisecond(ii) = functions::millisecond();
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.
117 * \param key Clave de la pareja (K,V).
118 * \param v Valor asociado a la clave.
120 void add(const K& key, const V& v) throw() {
121 iterator ii = a_container.find(key);
123 // Sobreescribe el valor asociado a K y actualiza su tiempo de acceso.
126 millisecond(ii) = functions::millisecond();
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));
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);
142 for(iterator ii = begin(), maxii = end(); ii != maxii; ii ++) {
143 if(millisecond(ii) < minTime)
144 minTime = millisecond(minii = ii);
148 * El map no permite sobre-escribir la clave => por eso tenemos que borrar el nodo
149 * más antiguo y crear otro nuevo.
151 a_container.erase(minii);
152 timed_value tvalue(v, functions::millisecond());
153 a_container.insert(value_type(key, tvalue));
157 Vacía este contenedor.
159 void clear() throw() { a_container.clear(); }
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.
166 iterator begin() throw() { return a_container.begin(); }
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.
173 const_iterator begin() const throw() { return a_container.begin(); }
176 * Devuelve un iterator al final del contenedor, teniendo que la ordenación de los pares (K,V) se hará en
178 * \return El primer elemento del contenedor.
180 iterator end() throw() { return a_container.end(); }
183 * Devuelve un iterator al final del contenedor, teniendo que la ordenación de los pares (K,V) se hará en
185 * \return El primer elemento del contenedor.
187 const_iterator end() const throw() { return a_container.end(); }
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).
195 static K key(iterator& ii) throw() { return ii->first; }
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).
203 static V& value(iterator& ii) throw() {
204 timed_value* v = &ii->second;
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.
213 static Millisecond& millisecond(iterator& ii) throw() {
214 timed_value* v = &ii->second;
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).
224 static K key(const_iterator& ii) throw() { return ii->first; }
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).
232 static const V& value(const_iterator& ii) throw() {
233 const timed_value* v = &ii->second;
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.
242 static Millisecond millisecond(const_iterator& ii) throw() {
243 const timed_value* v = &ii->second;
248 Devuelve una cadena con la informacion referente a esta clase.
249 \return Una cadena con la informacion referente a esta clase.
251 std::string asString() const
253 std::string msg("LRUMap { Name: ");
255 msg += functions::asText(" | N: ", a_maxSize);
256 msg += functions::asText(" | n: ", size());
263 container a_container;