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

#include <SortedVector.hpp>

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

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

Public Types
typedef std::map< TKey, T * >	container
typedef container::iterator	iterator
typedef container::const_iterator	const_iterator
typedef container::value_type	value_type

Public Member Functions
	SortedVector ()
	SortedVector (const SortedVector &other)
virtual	~SortedVector ()
bool	contains (const T *t) const
bool	add (T *t) noexcept(false)
bool	erase (T *t) noexcept(false)
T *	find (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::SortedVector< T, SortBy, TKey >

Patron para ordenar instancias de objetos en base de una clave.

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.

Warning

no actua como clase segura en MT, ver anna::SafeSortedVector.

Member Typedef Documentation

const_iterator

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

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

container

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

typedef std::map<TKey, T*> anna::SortedVector< T, SortBy, TKey >::container

iterator

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

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

value_type

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

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

Constructor & Destructor Documentation

SortedVector() [1/2]

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

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

inline

Constructor.

{;}

SortedVector() [2/2]

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

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

inlineexplicit

Constructor copia.

Parameters

other

Instancia de la que copiar.

                                                   :
    container(other) {}

~SortedVector()

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

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

inlinevirtual

Destructor.

{ container::clear(); }

Member Function Documentation

add()

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

bool anna::SortedVector< T, SortBy, TKey >::add ( T *  t )

inlinenoexcept

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

Parameters

t	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(t == NULL)
      return false;

    TKey key(SortBy::value(t));
    value_type v(key, t);
    std::pair <iterator, bool> result = container::insert(v);
    return result.second;
  }

contains()

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

bool anna::SortedVector< T, SortBy, TKey >::contains ( const T *  t ) 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

t	Instancia a comprobar.

Returns

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

  {
    if(t == NULL)
      return false;

    TKey key(SortBy::value(t));
    return find(key) != NULL;
  }

data() [1/2]

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

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

inlinestatic

Devuelve el objeto referenciado por el iterador.

Returns

El objeto referenciado por el iterador.

{ return ii->second; }

data() [2/2]

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

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

inlinestatic

Devuelve el objeto referenciado por el iterador.

Returns

El objeto referenciado por el iterador.

{ return ii->second; }

erase()

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

bool anna::SortedVector< T, SortBy, TKey >::erase ( T *  t )

inlinenoexcept

Elimina la instancia recibida como parametro de la lista ordenada de objetos.

Parameters

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

Returns

true si ha eliminado la instancia o false en otro caso.

                  {
    if(t == NULL)
      return false;

    bool result = false;
    TKey key(SortBy::value(t));
    iterator ii = container::find(key);

    if(ii != container::end()) {
      container::erase(ii);
      result = true;
    }

    return result;
  }

find() [1/2]

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

T* anna::SortedVector< 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 ii = container::find(key);
    return (ii == container::end()) ? NULL : ii->second;
  }

find() [2/2]

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

const T* anna::SortedVector< 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 <SortedVector <T, SortBy, TKey>*>(this)->find(key);
  }

---

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

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