anna::MultiMap< T, SortBy, TKey > Class Template Reference

#include <MultiMap.hpp>

Inheritance diagram for anna::MultiMap< T, SortBy, TKey >:

Collaboration diagram for anna::MultiMap< T, SortBy, TKey >:

Public Types
typedef std::vector< T * >	container
typedef container::iterator	iterator
typedef container::const_iterator	const_iterator
typedef container::value_type	value_type

Public Member Functions
	MultiMap ()
	MultiMap (const MultiMap &other)
virtual	~MultiMap ()
bool	add (T *_vv) noexcept(false)
bool	contains (const T *_vv) const
void	clearAndDestroy ()
T *	erase (const T *_vv) noexcept(false)
iterator	erase_iterator (iterator ii)
T *	find (const TKey &key)
iterator	find_iterator (const TKey &key)
const T *	find (const TKey &key) const

Static Public Member Functions
static T *	data (iterator ii)
static const T *	data (const_iterator ii)

Detailed Description

template<typename T, typename SortBy, typename TKey = int>
class anna::MultiMap< T, SortBy, TKey >

Patron para ordenar instancias de objetos en base de una clave. El uso de este patrón está aconsejado cuando tenemos que gestionar cientos o miles de objetos. La eficiencia de los borrado y las inserciones es O(log N).

Parameters

T	Clase del patron.
SortBy	Clase que ofrece el valor por el que ordenar. Debe implementar un metodo constante con la signatura: TKey value (const T*)
TKey	Tipo de clave usado para calcular la ordenacion. Debe implementar los operadores '=', '<' y '==' y el contructor copia.

Member Typedef Documentation

const_iterator

template<typename T, typename SortBy, typename TKey = int>

typedef container::const_iterator anna::MultiMap< T, SortBy, TKey >::const_iterator

container

template<typename T, typename SortBy, typename TKey = int>

typedef std::vector<T*> anna::MultiMap< T, SortBy, TKey >::container

iterator

template<typename T, typename SortBy, typename TKey = int>

typedef container::iterator anna::MultiMap< T, SortBy, TKey >::iterator

value_type

template<typename T, typename SortBy, typename TKey = int>

typedef container::value_type anna::MultiMap< T, SortBy, TKey >::value_type

Constructor & Destructor Documentation

MultiMap() [1/2]

template<typename T, typename SortBy, typename TKey = int>

anna::MultiMap< T, SortBy, TKey >::MultiMap ( )

inline

Constructor.

{;}

MultiMap() [2/2]

template<typename T, typename SortBy, typename TKey = int>

anna::MultiMap< T, SortBy, TKey >::MultiMap ( const MultiMap< T, SortBy, TKey > &  other )

inlineexplicit

Constructor copia.

Parameters

other

Instancia de la que copiar.

: container(other) {}

~MultiMap()

template<typename T, typename SortBy, typename TKey = int>

virtual anna::MultiMap< T, SortBy, TKey >::~MultiMap ( )

inlinevirtual

Destructor.

{ this->clear(); }

Member Function Documentation

add()

template<typename T, typename SortBy, typename TKey = int>

bool anna::MultiMap< T, SortBy, TKey >::add ( T *  _vv )

inlinenoexcept

Incorpora la instancia recibida como parametro en la lista ordenada de objetos.

Parameters

_vv	Instancia a guardar en el map. Si es NULL la operacion no tendra ningun efecto.

Returns

true si ha registrado la nueva instancia o false en otro caso.

                  {
    if(_vv == NULL)
      return false;

    iterator maxii = this->end();
    iterator ii = std::upper_bound(this->begin(), maxii, _vv, a_lessT);

    if(ii == maxii)
      this->push_back(_vv);
    else
      this->insert(ii, _vv);

    return true;
  }

clearAndDestroy()

template<typename T, typename SortBy, typename TKey = int>

void anna::MultiMap< T, SortBy, TKey >::clearAndDestroy ( )

inline

Borra las entradas contenidas en el vector ordenado y libera la memoria asociada a las mismas.

                         {
    for(iterator ii = this->begin(), maxii = this->end(); ii != maxii; ii ++)
      delete data(ii);

    this->clear();
  }

contains()

template<typename T, typename SortBy, typename TKey = int>

bool anna::MultiMap< T, SortBy, TKey >::contains ( const T *  _vv ) const

inline

Devolvera true si la instancia recibida como parametro esta contenido en el map o en otro caso. Si la instancia recibida es NULL siempre devolvera false.

Parameters

_vv	Instancia a comprobar.

Returns

true si la instancia recibida como parametro esta contenido en el map o en otro caso.

{ return (_vv == NULL) ? false : (find(SortBy::value(_vv)) != NULL); }

data() [1/2]

template<typename T, typename SortBy, typename TKey = int>

static T* anna::MultiMap< T, SortBy, TKey >::data ( iterator  ii )

inlinestatic

Devuelve el objeto referenciado por el iterador.

Returns

El objeto referenciado por el iterador.

{ return *ii; }

data() [2/2]

template<typename T, typename SortBy, typename TKey = int>

static const T* anna::MultiMap< T, SortBy, TKey >::data ( const_iterator  ii )

inlinestatic

Devuelve el objeto referenciado por el iterador.

Returns

El objeto referenciado por el iterador.

{ return *ii; }

erase()

template<typename T, typename SortBy, typename TKey = int>

T* anna::MultiMap< T, SortBy, TKey >::erase ( const T *  _vv )

inlinenoexcept

Elimina la instancia recibida como parametro de la lista ordenada de objetos, pero no se libera su memoria.

Parameters

_vv	Instancia a guardar en el map. Si es NULL la operacion no tendra ningun efecto.

Returns

La instancia correspondiente a la entrada borrada o NULL si no se encontró ninguna entrada válida.

                  {
    if(_vv == NULL)
      return NULL;

    iterator maxii = this->end();
    iterator ii = std::lower_bound(this->begin(), this->end(), _vv, a_lessT);

    if(ii == maxii)
      return NULL;

    T* dd = data(ii);

    if(!(SortBy::value(_vv) == SortBy::value(dd)))
      return NULL;

    container::erase(ii);
    return dd;
  }

erase_iterator()

template<typename T, typename SortBy, typename TKey = int>

iterator anna::MultiMap< T, SortBy, TKey >::erase_iterator ( iterator  ii )

inline

Borra la entrada asociada al iterador recibido. El iterador recibido deja de ser válido.

Parameters

ii	Posición a borrar

Returns

La nueva posición a la que debería pasar el iterador una vez borrada la entrada.

{ return container::erase(ii); }

find() [1/2]

template<typename T, typename SortBy, typename TKey = int>

T* anna::MultiMap< T, SortBy, TKey >::find ( const TKey &  key )

inline

Devuelve la instancia asociada a la clave recibida como parametro o NULL si no existe.

Parameters

key	Clave a buscar en el map.

Returns

la instancia asociada a la clave recibida como parametro o NULL si no existe.

  {
    iterator maxii = this->end();
    iterator ii = lower_bound(this->begin(), maxii, key, a_lessKey);

    if(ii == maxii)
      return NULL;

    T* pos = data(ii);
    return (SortBy::value(pos) == key) ? pos : NULL;
  }

find() [2/2]

template<typename T, typename SortBy, typename TKey = int>

const T* anna::MultiMap< T, SortBy, TKey >::find ( const TKey &  key ) const

inline

Devuelve la instancia asociada a la clave recibida como parametro o NULL si no existe.

Parameters

key	Clave a buscar en el map.

Returns

la instancia asociada a la clave recibida como parametro o NULL si no existe.

                                       {
    return const_cast <MultiMap <T, SortBy, TKey>*>(this)->find(key);
  }

find_iterator()

template<typename T, typename SortBy, typename TKey = int>

iterator anna::MultiMap< T, SortBy, TKey >::find_iterator ( const TKey &  key )

inline

Devuelve el iterador a la instancia asociada a la clave recibida.

Returns

el iterador a la instancia asociada a la clave recibida.

  {
    return lower_bound(this->begin(), this->end(), key, a_lessKey);
  }

---

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

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