anna::Recycler< T, _Allocator > Class Template Reference

#include <Recycler.hpp>

Inheritance diagram for anna::Recycler< T, _Allocator >:

Public Types
typedef std::list< T * >	container
typedef container::iterator	iterator
typedef container::const_iterator	const_iterator
typedef std::map< T *, iterator >	random_container
typedef random_container::iterator	random_iterator
typedef random_container::value_type	random_item

Public Member Functions
	Recycler (const bool randomAccess=false)
virtual	~Recycler ()
int	getSize () const
int	size () const
T *	create () noexcept(false)
iterator	find (T *t) noexcept(false)
void	release (T *t)
void	release (iterator ii)
void	release (const T *t)
void	clear ()
iterator	begin ()
const_iterator	begin () const
iterator	end ()
const_iterator	end () const

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

Detailed Description

template<typename T, typename _Allocator = Allocator <T>>
class anna::Recycler< T, _Allocator >

Mantiene una lista de punteros que puede crecer dinamicamente, no obstante, siempre que sea posible intenta reusar punteros creados previamente.

Parameters

T	Clase de la que mantener la lista de punteros pre-asignados.
Allocator	Clase encargada de reservar la memoria para los objetos T en el momento en que sea necesaria una nueva instancia.

Warning

no actua como clase segura en MT, ver anna::SafeRecycler

Member Typedef Documentation

const_iterator

template<typename T, typename _Allocator = Allocator <T>>

typedef container::const_iterator anna::Recycler< T, _Allocator >::const_iterator

container

template<typename T, typename _Allocator = Allocator <T>>

typedef std::list<T*> anna::Recycler< T, _Allocator >::container

iterator

template<typename T, typename _Allocator = Allocator <T>>

typedef container::iterator anna::Recycler< T, _Allocator >::iterator

random_container

template<typename T, typename _Allocator = Allocator <T>>

typedef std::map<T*, iterator> anna::Recycler< T, _Allocator >::random_container

random_item

template<typename T, typename _Allocator = Allocator <T>>

typedef random_container::value_type anna::Recycler< T, _Allocator >::random_item

random_iterator

template<typename T, typename _Allocator = Allocator <T>>

typedef random_container::iterator anna::Recycler< T, _Allocator >::random_iterator

Constructor & Destructor Documentation

Recycler()

template<typename T, typename _Allocator = Allocator <T>>

anna::Recycler< T, _Allocator >::Recycler ( const bool  randomAccess = false )

inline

Constructor.

Parameters

randomAccess

Indicador que permite activar el uso de estructuras de datos adicionales que permite que los métodos find y release realicen la búsqueda del objeto de forma optimizada. Se ha comprobado que si necesitamos tratar en torno a un centenar de instancias es más eficiente no activar las estructuras para acceso directo, para más objetos resulta imprescinble.

                                            {
    a_size = 0;
    a_randomContainer = (randomAccess == true) ? new random_container : NULL;
  }

~Recycler()

template<typename T, typename _Allocator = Allocator <T>>

virtual anna::Recycler< T, _Allocator >::~Recycler ( )

inlinevirtual

Destructor.

                      {
    clear();    // Pasa todos los punteros a_holes

    for(iterator ii = a_holes.begin(), maxii = a_holes.end(); ii != maxii; ii ++) {
      _Allocator::destroy(data(ii));
    }

    a_holes.clear();
    delete a_randomContainer;
  }

Member Function Documentation

begin() [1/2]

template<typename T, typename _Allocator = Allocator <T>>

iterator anna::Recycler< T, _Allocator >::begin ( )

inline

Devuelve un iterator al primer elemento, activo, contenido en el reciclador.

Returns

Un iterator al primer elemento, activo, contenido en el reciclador.

{ return a_objects.begin(); }

begin() [2/2]

template<typename T, typename _Allocator = Allocator <T>>

const_iterator anna::Recycler< T, _Allocator >::begin ( ) const

inline

Devuelve un iterator al primer elemento, activo, contenido en el reciclador.

Returns

Un iterator al primer elemento, activo, contenido en el reciclador.

{ return a_objects.begin(); }

clear()

template<typename T, typename _Allocator = Allocator <T>>

void anna::Recycler< T, _Allocator >::clear ( )

inline

Marca como disponibles todos los objetos contenidos en memoria.

  {
    a_holes.splice(a_holes.end(), a_objects);
    a_size = 0;

    if(a_randomContainer)
      a_randomContainer->clear();
  }

create()

template<typename T, typename _Allocator = Allocator <T>>

T* anna::Recycler< T, _Allocator >::create ( )

inlinenoexcept

Devuelve un puntero de tipo T. Solo crearia una nueva instancia de la clase T si al invocar a este metoodo no existe ninguna otra instancia que se pueda reutilizar, en cuyo caso haria una nueva reserva.

Cada una de las llamadas a este metodo debe tener su correspondiente llamada al metodo release cuando el puntero deje de ser util.

Returns

Un puntero a una instancia de tipo T.

                  {
    T* result = NULL;

    if(a_holes.empty() == false)  {
      iterator top = a_holes.begin();
      result = data(top);
      a_objects.splice(a_objects.end(), a_holes, top);
    } else
      a_objects.push_back(result = _Allocator::create());

    if(a_randomContainer != NULL) {
      iterator ii = a_objects.end();
      ii --;
      a_randomContainer->insert(random_item(result, ii));
    }

    a_size ++;
    return result;
  }

data() [1/2]

template<typename T, typename _Allocator = Allocator <T>>

static T* anna::Recycler< T, _Allocator >::data ( iterator  ii )

inlinestatic

Devuelve el objeto referenciado por el iterator recibido como parametro.

Returns

El objeto referenciado por el iterator recibido como parametro.

{ return *ii; }

data() [2/2]

template<typename T, typename _Allocator = Allocator <T>>

static const T* anna::Recycler< T, _Allocator >::data ( const_iterator  ii )

inlinestatic

Devuelve el objeto referenciado por el iterator recibido como parametro.

Returns

El objeto referenciado por el iterator recibido como parametro.

{ return *ii; }

end() [1/2]

template<typename T, typename _Allocator = Allocator <T>>

iterator anna::Recycler< T, _Allocator >::end ( )

inline

Devuelve un iterator al final de la lista de elementos activos en el reciclador.

Returns

Un iterator al final de la lista de elementos activos en el reciclador.

{ return a_objects.end(); }

end() [2/2]

template<typename T, typename _Allocator = Allocator <T>>

const_iterator anna::Recycler< T, _Allocator >::end ( ) const

inline

Devuelve un iterator al final de la lista de elementos activos en el reciclador.

Returns

Un iterator al final de la lista de elementos activos en el reciclador.

{ return a_objects.end(); }

find()

template<typename T, typename _Allocator = Allocator <T>>

iterator anna::Recycler< T, _Allocator >::find ( T *  t )

inlinenoexcept

Devuelve el iterador que apunta al objeto recibido como parametro. Si el objeto no se encuentra dentro de la lista devolverá end ()

Returns

el iterador que apunta al objeto recibido como parametro.

                  {
    iterator result = end();

    if(a_randomContainer != NULL) {
      random_iterator jj = a_randomContainer->find(t);

      if(jj != a_randomContainer->end())
        result = the_iterator(jj);
    } else {
      for(iterator ii = begin(), maxii = end(); ii != maxii; ii ++) {
        if(data(ii) == t) {
          result = ii;
          break;
        }
      }
    }

    return result;
  }

getSize()

template<typename T, typename _Allocator = Allocator <T>>

int anna::Recycler< T, _Allocator >::getSize ( ) const

inline

Devuelve el número de elementos realmente utilizados hasta ahora.

Returns

El número de elementos realmente utilizados hasta ahora.

{ return a_size; }

release() [1/3]

template<typename T, typename _Allocator = Allocator <T>>

void anna::Recycler< T, _Allocator >::release ( T *  t )

inline

Libera el puntero recibido como parametro. No se libera fisicamente sino que se deja marcado como reusable.

Si el puntero pasado como parametro no ha sido obtenido mediante el metodo create los resultados no estan definidos.

Parameters

t	Instancia de un puntero de tipo T obtenido a partir del metodo create.

  {
    if(t == NULL)
      return;

    iterator result = end();

    if(a_randomContainer != NULL) {
      random_iterator jj = a_randomContainer->find(t);

      if(jj != a_randomContainer->end()) {
        result = the_iterator(jj);
        a_randomContainer->erase(jj);
      }
    } else {
      for(iterator ii = begin(), maxii = end(); ii != maxii; ii ++) {
        if(data(ii) == t) {
          result = ii;
          break;
        }
      }
    }

    if(result == end())
      return;

    a_holes.splice(a_holes.end(), a_objects, result);

    if(a_size > 0)
      a_size --;
  }

release() [2/3]

template<typename T, typename _Allocator = Allocator <T>>

void anna::Recycler< T, _Allocator >::release ( iterator  ii )

inline

Libera el puntero asociado al iterador recibido como parametro.

Parameters

ii	Instancia a liberar.

{ release(data(ii));  }

release() [3/3]

template<typename T, typename _Allocator = Allocator <T>>

void anna::Recycler< T, _Allocator >::release ( const T *  t )

inline

Libera el puntero recibido como parametro. No se libera fisicamente sino que se deja marcado como reusable.

Si el puntero pasado como parametro no ha sido obtenido mediante el metodo create los resultados no estan definidos.

Parameters

t	Instancia de un puntero de tipo T obtenido a partir del metodo create.

{ release(const_cast <T*>(t)); }

size()

template<typename T, typename _Allocator = Allocator <T>>

int anna::Recycler< T, _Allocator >::size ( ) const

inline

Devuelve el número de elementos realmente utilizados hasta ahora.

Returns

El número de elementos realmente utilizados hasta ahora.

{ return a_size; }

---

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

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