anna::LRUMap< K, V > Class Template Reference

#include <LRUMap.hpp>

Public Types
typedef container::iterator	iterator
typedef container::const_iterator	const_iterator

Public Member Functions
	LRUMap (const char *name, const int maxSize)
	~LRUMap ()
bool	isEmpty () const
int	size () const
V *	find (const K &key)
void	add (const K &key, const V &v)
void	clear ()
iterator	begin ()
const_iterator	begin () const
iterator	end ()
const_iterator	end () const
std::string	asString () const

Static Public Member Functions
static K	key (iterator &ii)
static V &	value (iterator &ii)
static Millisecond &	millisecond (iterator &ii)
static K	key (const_iterator &ii)
static const V &	value (const_iterator &ii)
static Millisecond	millisecond (const_iterator &ii)

Detailed Description

template<typename K, typename V>
class anna::LRUMap< K, V >

Patrón que permite mantener una lista de N elementos de pares (Clave, Valor).

Es capaz de realizar una búsqueda indexada de la clave para obtener el valor, pero además es capaz de mantener estable el número de elementos contenidos en ésta clase.

Si se alcanza el número máximo de elementos indicados en el constructor, si se requiere incluir un nuevo objeto, primero liberará el objeto que lleve más tiempo si ser usado.

Parameters

K	clase que actuará como clave del mapa. Requiere el contructor de copia, y los operadores de comparación == y <.
V	clase que actuará como dato asociado a la clave. Requiere el constructor copia y el operador copia.

Member Typedef Documentation

const_iterator

template<typename K , typename V >

typedef container::const_iterator anna::LRUMap< K, V >::const_iterator

iterator

template<typename K , typename V >

typedef container::iterator anna::LRUMap< K, V >::iterator

Constructor & Destructor Documentation

LRUMap()

template<typename K , typename V >

anna::LRUMap< K, V >::LRUMap ( const char *  name, const int  maxSize  )

inline

Constructor.

Parameters

name	Nombre logico de esta instancia.
measure	Unidad de medida. Solo se usa a efecto de salida de datos.

: a_name(name), a_maxSize(maxSize) { ;}

~LRUMap()

template<typename K , typename V >

anna::LRUMap< K, V >::~LRUMap ( )

inline

Destructor.

{ clear(); }

Here is the call graph for this function:

Member Function Documentation

add()

template<typename K , typename V >

void anna::LRUMap< K, V >::add ( const K &  key, const V &  v  )

inline

Establece el valor de pareja (K,V). Si no existe se crea y si existe se sobre escribe el valor asociado a V, y se actualiza su tiempo de acceso.

Parameters

key	Clave de la pareja (K,V).
v	Valor asociado a la clave.

                                     {
    iterator ii = a_container.find(key);

    // Sobreescribe el valor asociado a K y actualiza su tiempo de acceso.
    if(ii != end()) {
      value(ii) = v;
      millisecond(ii) = functions::millisecond();
      return;
    }

    // Si no se ha alcanzado el máximo, sólo hay que insertar el nuevo (K,V)
    if(size() < a_maxSize) {
      timed_value tvalue(v, functions::millisecond());
      a_container.insert(value_type(key, tvalue));
      return;
    }

    // Se ha alcanzado el máximo, hay que buscar el que haga más tiempo que no se
    // accede => el que tenga el menor 'Time' asociado.
    iterator minii = begin();
    Millisecond minTime = millisecond(minii);

    for(iterator ii = begin(), maxii = end(); ii != maxii; ii ++) {
      if(millisecond(ii) < minTime)
        minTime = millisecond(minii = ii);
    }

    /*
     * El map no permite sobre-escribir la clave => por eso tenemos que borrar el nodo
     * más antiguo y crear otro nuevo.
     */
    a_container.erase(minii);
    timed_value tvalue(v, functions::millisecond());
    a_container.insert(value_type(key, tvalue));
  }

Here is the call graph for this function:

asString()

template<typename K , typename V >

std::string anna::LRUMap< K, V >::asString ( void  ) const

inline

Devuelve una cadena con la informacion referente a esta clase.

Returns

Una cadena con la informacion referente a esta clase.

  {
    std::string msg("LRUMap { Name: ");
    msg += a_name;
    msg += functions::asText(" | N: ", a_maxSize);
    msg += functions::asText(" | n: ", size());
    return msg += " }";
  }

Here is the call graph for this function:

begin() [1/2]

template<typename K , typename V >

iterator anna::LRUMap< K, V >::begin ( )

inline

Devuelve un iterator al primer elemento del contenedor, teniendo que la ordenación de los pares (K,V) se hará en base a K.

Returns

El primer elemento del contenedor.

{ return a_container.begin(); }

begin() [2/2]

template<typename K , typename V >

const_iterator anna::LRUMap< K, V >::begin ( ) const

inline

Devuelve un iterator al primer elemento del contenedor, teniendo que la ordenación de los pares (K,V) se hará en base a K.

Returns

El primer elemento del contenedor.

{ return a_container.begin(); }

clear()

template<typename K , typename V >

void anna::LRUMap< K, V >::clear ( )

inline

Vacía este contenedor.

{ a_container.clear(); }

end() [1/2]

template<typename K , typename V >

iterator anna::LRUMap< K, V >::end ( )

inline

Devuelve un iterator al final del contenedor, teniendo que la ordenación de los pares (K,V) se hará en base a K.

Returns

El primer elemento del contenedor.

{ return a_container.end(); }

end() [2/2]

template<typename K , typename V >

const_iterator anna::LRUMap< K, V >::end ( ) const

inline

Devuelve un iterator al final del contenedor, teniendo que la ordenación de los pares (K,V) se hará en base a K.

Returns

El primer elemento del contenedor.

{ return a_container.end(); }

find()

template<typename K , typename V >

V* anna::LRUMap< K, V >::find ( const K &  key )

inline

Devuelve el puntero al valor asociado a la clave recibida como parámetro. Puede ser NULL si la pareja (K,V) no está registrada en el contenedor.

Parameters

key	Clave de la que obtener el valor asociado.

Returns

El puntero al valor asociado a la clave recibida como parámetro.

                        {
    iterator ii =  a_container.find(key);

    if(ii == end())
      return NULL;

    /*
     * Recupera el valor asociado a la clave K y actualiza el momento de acceso.
     */
    millisecond(ii) = functions::millisecond();
    return &value(ii);
  }

Here is the call graph for this function:

isEmpty()

template<typename K , typename V >

bool anna::LRUMap< K, V >::isEmpty ( ) const

inline

Devuelve el indicador de validez de esta media.

Returns

true Si la media no tiene ningun valor o false en caso contrario.

{ return a_container.size() == 0; }

key() [1/2]

template<typename K , typename V >

static K anna::LRUMap< K, V >::key ( iterator &  ii )

inlinestatic

Devuelve la clave asociada al iterador recibido como parámetro.

Parameters

ii	Iterador que debe estar comprendido entre [begin (), end).

Returns

la clave asociada al iterador recibido como parámetro.

Warning

Los acceso mediante iterador no actualiza el tiempo de acceso a la pareja (K,V).

{ return ii->first;  }

key() [2/2]

template<typename K , typename V >

static K anna::LRUMap< K, V >::key ( const_iterator &  ii )

inlinestatic

Devuelve la clave asociada al iterador recibido como parámetro.

Parameters

ii	Iterador que debe estar comprendido entre [begin (), end).

Returns

la clave asociada al iterador recibido como parámetro.

Warning

Los acceso mediante iterador no actualiza el tiempo de acceso a la pareja (K,V).

{ return ii->first;  }

millisecond() [1/2]

template<typename K , typename V >

static Millisecond& anna::LRUMap< K, V >::millisecond ( iterator &  ii )

inlinestatic

Devuelve el tiempo de acceso asociado al iterador recibido como parámetro.

Parameters

ii	Iterador que debe estar comprendido entre [begin (), end).

Returns

el tiempo de acceso asociado al iterador recibido como parámetro.

                                                {
    timed_value* v = &ii->second;
    return v->second;
  }

millisecond() [2/2]

template<typename K , typename V >

static Millisecond anna::LRUMap< K, V >::millisecond ( const_iterator &  ii )

inlinestatic

Devuelve el tiempo de acceso asociado al iterador recibido como parámetro.

Parameters

ii	Iterador que debe estar comprendido entre [begin (), end).

Returns

el tiempo de acceso asociado al iterador recibido como parámetro.

                                                     {
    const timed_value* v = &ii->second;
    return v->second;
  }

size()

template<typename K , typename V >

int anna::LRUMap< K, V >::size ( ) const

inline

Devuelve el número de elementos contenidos en este contenedor.

Returns

el número de elementos contenidos en este contenedor.

{ return a_container.size(); }

value() [1/2]

template<typename K , typename V >

static V& anna::LRUMap< K, V >::value ( iterator &  ii )

inlinestatic

Devuelve el valor asociado al iterador recibido como parámetro.

Parameters

ii	Iterador que debe estar comprendido entre [begin (), end).

Returns

el valor asociado al iterador recibido como parámetro.

Warning

Los acceso mediante iterador no actualiza el tiempo de acceso a la pareja (K,V).

                                {
    timed_value* v = &ii->second;
    return v->first;
  }

value() [2/2]

template<typename K , typename V >

static const V& anna::LRUMap< K, V >::value ( const_iterator &  ii )

inlinestatic

Devuelve el valor asociado al iterador recibido como parámetro.

Parameters

ii	Iterador que debe estar comprendido entre [begin (), end).

Returns

el valor asociado al iterador recibido como parámetro.

Warning

Los acceso mediante iterador no actualiza el tiempo de acceso a la pareja (K,V).

                                            {
    const timed_value* v = &ii->second;
    return v->first;
  }

---

The documentation for this class was generated from the following file:

• /tmp/anna/include/anna/core/util/LRUMap.hpp