| The Gaudi Framework v29r1 (5cd95fa2)

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

Classes | Public Types | Public Member Functions | Private Attributes | List of all members
GaudiUtils::Allocator< Type > Class Template Reference

Allocator. More...

`#include <GaudiKernel/Allocator.h>`

Collaboration diagram for GaudiUtils::Allocator< Type >:
[legend]

## 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 70 of file Allocator.h.

## Member Typedef Documentation

template<class Type>

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

Definition at line 106 of file Allocator.h.

template<class Type>

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

Definition at line 108 of file Allocator.h.

template<class Type>

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

Definition at line 104 of file Allocator.h.

template<class Type>

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

Definition at line 105 of file Allocator.h.

template<class Type>

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

Definition at line 107 of file Allocator.h.

template<class Type>

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

Definition at line 103 of file Allocator.h.

template<class Type>

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

Definition at line 102 of file Allocator.h.

## Constructor & Destructor Documentation

template<class Type >

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

Constructor.

Definition at line 184 of file Allocator.h.

184 : mem( sizeof( Type ) )
185 {
186 }
GaudiUtils::Allocator::mem
GaudiUtils::AllocatorPool mem
Definition: Allocator.h:165
Tuples::Type
Type
the list of available types for ntuples
Definition: TupleObj.h:84
template<class Type >

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

destructor

Definition at line 193 of file Allocator.h.

194 {
195 }
template<class Type>
template<class U >

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

Copy constructor.

Definition at line 112 of file Allocator.h.

112 : mem( right.mem )
113 {
114 }
std::right
T right(T...args)
GaudiUtils::Allocator::mem
GaudiUtils::AllocatorPool mem
Definition: Allocator.h:165

## Member Function Documentation

template<class Type>

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

Returns the address of values.

Definition at line 117 of file Allocator.h.

117 { return &r; }
template<class Type>

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

Definition at line 118 of file Allocator.h.

118 { return &r; }
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 121 of file Allocator.h.

122 {
123 // Allocates space for n elements of type Type, but does not initialise
124 //
125 Type* mem_alloc = 0;
126 if ( n == 1 )
127 mem_alloc = MallocSingle();
128 else
129 mem_alloc = static_cast<Type*>(::operator new( n * sizeof( Type ) ) );
130 return mem_alloc;
131 }
GaudiUtils::Allocator::MallocSingle
Type * MallocSingle()
Malloc and Free methods to be used when overloading new and delete operators in the client <Type> obj...
Definition: Allocator.h:202
GaudiPluginService.cpluginsvc.n
n
Definition: cpluginsvc.py:228
Tuples::Type
Type
the list of available types for ntuples
Definition: TupleObj.h:84
template<class Type>

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

Initialises *p by val.

Definition at line 146 of file Allocator.h.

146 { new ( (void*)p ) Type( val ); }
Tuples::Type
Type
the list of available types for ntuples
Definition: TupleObj.h:84
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 134 of file Allocator.h.

135 {
136 // Deallocates n elements of type Type, but doesn't destroy
137 //
138 if ( n == 1 )
139 FreeSingle( p );
140 else
141 ::operator delete( (void*)p );
142 return;
143 }
GaudiUtils::Allocator::FreeSingle
void FreeSingle(Type *anElement)
Definition: Allocator.h:212
GaudiPluginService.cpluginsvc.n
n
Definition: cpluginsvc.py:228
template<class Type>

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

Destroy *p but doesn't deallocate.

Definition at line 148 of file Allocator.h.

148 { p->~Type(); }
template<class Type >

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

Definition at line 212 of file Allocator.h.

213 {
214 mem.Free( anElement );
215 return;
216 }
GaudiUtils::Allocator::mem
GaudiUtils::AllocatorPool mem
Definition: Allocator.h:165
GaudiUtils::AllocatorPool::Free
void Free(void *b)
Return an element back to the pool.
Definition: AllocatorPool.h:129
template<class Type >

size_t GaudiUtils::Allocator< Type >::GetAllocatedSize | ( |  | ) | const
| inline

Returns the size of the total memory allocated.

Definition at line 236 of file Allocator.h.

237 {
238 return mem.Size();
239 }
GaudiUtils::AllocatorPool::Size
unsigned int Size() const
Return storage size.
Definition: AllocatorPool.h:140
GaudiUtils::Allocator::mem
GaudiUtils::AllocatorPool mem
Definition: Allocator.h:165
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 202 of file Allocator.h.

203 {
204 return static_cast<Type*>( mem.Alloc() );
205 }
GaudiUtils::Allocator::mem
GaudiUtils::AllocatorPool mem
Definition: Allocator.h:165
GaudiUtils::AllocatorPool::Alloc
void * Alloc()
Allocate one element.
Definition: AllocatorPool.h:115
Tuples::Type
Type
the list of available types for ntuples
Definition: TupleObj.h:84
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 151 of file Allocator.h.

152 {
153 // Returns the maximum number of elements that can be allocated
154 //
155 return 2147483647 / sizeof( Type );
156 }
Tuples::Type
Type
the list of available types for ntuples
Definition: TupleObj.h:84
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 223 of file Allocator.h.

224 {
225 // Clear all allocated storage and return it to the free store
226 //
227 mem.Reset();
228 return;
229 }
GaudiUtils::Allocator::mem
GaudiUtils::AllocatorPool mem
Definition: Allocator.h:165
GaudiUtils::AllocatorPool::Reset
void Reset()
Return storage to the free store.
Definition: AllocatorPool.cpp:88

## Member Data Documentation

template<class Type>

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

Definition at line 165 of file Allocator.h.

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

- GaudiKernel/GaudiKernel/Allocator.h