GaudiUtils::Allocator< Type > Class Template Reference

#include <GaudiKernel/Allocator.h>

Collaboration diagram for GaudiUtils::Allocator< Type >:

Classes
struct	rebind

Public Types
typedef Type	value_type
typedef size_t	size_type
typedef ptrdiff_t	difference_type
typedef Type *	pointer
typedef const Type *	const_pointer
typedef Type &	reference
typedef const Type &	const_reference

Public Member Functions
	Allocator () throw ()
	Constructor. More...
	~Allocator () throw ()
	destructor More...
Type *	MallocSingle ()
	Malloc and Free methods to be used when overloading new and delete operators in the client <Type> object. More...
void	FreeSingle (Type *anElement)
void	ResetStorage ()
	Returns allocated storage to the free store, resets allocator and page sizes. More...
size_t	GetAllocatedSize () const
	Returns the size of the total memory allocated. More...
template<class U >
	Allocator (const Allocator< U > &right) throw ()
	Copy constructor. More...
pointer	address (reference r) const
	Returns the address of values. More...
const_pointer	address (const_reference r) const
pointer	allocate (size_type n, void *=0)
	Allocates space for n elements of type Type, but does not initialise. More...
void	deallocate (pointer p, size_type n)
	Deallocates n elements of type Type, but doesn't destroy. More...
void	construct (pointer p, const Type &val)
	Initialises *p by val. More...
void	destroy (pointer p)
	Destroy *p but doesn't deallocate. More...
size_type	max_size () const throw ()
	Returns the maximum number of elements that can be allocated. More...

Private Attributes
GaudiUtils::AllocatorPool	mem

Detailed Description

template<class Type>
class GaudiUtils::Allocator< Type >

Allocator. The class is imported from Geant4 project

Date

2006-02-10

Definition at line 79 of file Allocator.h.

Member Typedef Documentation

const_pointer

template<class Type >

typedef const Type* GaudiUtils::Allocator< Type >::const_pointer

Definition at line 114 of file Allocator.h.

const_reference

template<class Type >

typedef const Type& GaudiUtils::Allocator< Type >::const_reference

Definition at line 116 of file Allocator.h.

difference_type

template<class Type >

typedef ptrdiff_t GaudiUtils::Allocator< Type >::difference_type

Definition at line 112 of file Allocator.h.

pointer

template<class Type >

typedef Type* GaudiUtils::Allocator< Type >::pointer

Definition at line 113 of file Allocator.h.

reference

template<class Type >

typedef Type& GaudiUtils::Allocator< Type >::reference

Definition at line 115 of file Allocator.h.

size_type

template<class Type >

typedef size_t GaudiUtils::Allocator< Type >::size_type

Definition at line 111 of file Allocator.h.

value_type

template<class Type >

typedef Type GaudiUtils::Allocator< Type >::value_type

Definition at line 110 of file Allocator.h.

Constructor & Destructor Documentation

Allocator() [1/2]

template<class Type >

GaudiUtils::Allocator< Type >::Allocator
throw	(
	)

Constructor.

Definition at line 187 of file Allocator.h.

: mem( sizeof( Type ) ) {}

~Allocator()

template<class Type >

GaudiUtils::Allocator< Type >::~Allocator ( ) throw ( )

inline

destructor

Definition at line 84 of file Allocator.h.

{}

Allocator() [2/2]

template<class Type >

template<class U >

GaudiUtils::Allocator< Type >::Allocator ( const Allocator< U > &  right ) throw ( )

inline

Copy constructor.

Definition at line 120 of file Allocator.h.

: mem( right.mem ) {}

Member Function Documentation

address() [1/2]

template<class Type >

const_pointer GaudiUtils::Allocator< Type >::address ( const_reference  r ) const

inline

Definition at line 124 of file Allocator.h.

{ return &r; }

address() [2/2]

template<class Type >

pointer GaudiUtils::Allocator< Type >::address ( reference  r ) const

inline

Returns the address of values.

Definition at line 123 of file Allocator.h.

{ return &r; }

allocate()

template<class Type >

pointer GaudiUtils::Allocator< Type >::allocate ( size_type  n, void *  = 0  )

inline

Allocates space for n elements of type Type, but does not initialise.

Definition at line 127 of file Allocator.h.

                                                 {
      // Allocates space for n elements of type Type, but does not initialise
      //
      Type* mem_alloc = 0;
      if ( n == 1 )
        mem_alloc = MallocSingle();
      else
        mem_alloc = static_cast<Type*>( ::operator new( n * sizeof( Type ) ) );
      return mem_alloc;
    }

construct()

template<class Type >

void GaudiUtils::Allocator< Type >::construct ( pointer  p, const Type &  val  )

inline

Initialises *p by val.

Definition at line 150 of file Allocator.h.

{ new ( (void*)p ) Type( val ); }

deallocate()

template<class Type >

void GaudiUtils::Allocator< Type >::deallocate ( pointer  p, size_type  n  )

inline

Deallocates n elements of type Type, but doesn't destroy.

Definition at line 139 of file Allocator.h.

                                              {
      // Deallocates n elements of type Type, but doesn't destroy
      //
      if ( n == 1 )
        FreeSingle( p );
      else
        ::operator delete( (void*)p );
      return;
    }

destroy()

template<class Type >

void GaudiUtils::Allocator< Type >::destroy ( pointer  p )

inline

Destroy *p but doesn't deallocate.

Definition at line 152 of file Allocator.h.

{ p->~Type(); }

FreeSingle()

template<class Type >

void GaudiUtils::Allocator< Type >::FreeSingle ( Type *  anElement )

inline

Definition at line 203 of file Allocator.h.

                                                            {
  mem.Free( anElement );
  return;
}

GetAllocatedSize()

template<class Type >

size_t GaudiUtils::Allocator< Type >::GetAllocatedSize

inline

Returns the size of the total memory allocated.

Definition at line 225 of file Allocator.h.

                                                         {
  return mem.Size();
}

MallocSingle()

template<class Type >

Type * GaudiUtils::Allocator< Type >::MallocSingle

inline

Malloc and Free methods to be used when overloading new and delete operators in the client <Type> object.

Definition at line 194 of file Allocator.h.

                                              {
  return static_cast<Type*>( mem.Alloc() );
}

max_size()

template<class Type >

size_type GaudiUtils::Allocator< Type >::max_size ( ) const throw ( )

inline

Returns the maximum number of elements that can be allocated.

Definition at line 155 of file Allocator.h.

                                       {
      // Returns the maximum number of elements that can be allocated
      //
      return 2147483647 / sizeof( Type );
    }

ResetStorage()

template<class Type >

void GaudiUtils::Allocator< Type >::ResetStorage

inline

Returns allocated storage to the free store, resets allocator and page sizes.

Note: contents in memory are lost using this call !

Definition at line 213 of file Allocator.h.

                                             {
  // Clear all allocated storage and return it to the free store
  //
  mem.Reset();
  return;
}

Member Data Documentation

mem

template<class Type >

GaudiUtils::AllocatorPool GaudiUtils::Allocator< Type >::mem

private

Definition at line 168 of file Allocator.h.

---

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

• GaudiKernel/include/GaudiKernel/Allocator.h