This class provides methods for creating and deleting nodes using the appropriate allocator‐traits of the parameterized ALLOCATOR. This type is intended to be used as a private base‐class for a node‐based container, in order to take advantage of the empty‐base‐class optimization in the case where the base‐class has 0 size (as may the case if the parameterized ALLOCATOR is not a bslma::Allocator).

Synopsis

Declared in <bslstl_simplepool.h>

template<
    class VALUE,
    class ALLOCATOR>
class SimplePool
    : public SimplePool_Type<ALLOCATOR>::AllocatorType

Base Classes

Name

Description

SimplePool_Type<ALLOCATOR>::AllocatorType

Type Aliases

Name

Description

AllocatorTraits

Alias for the allocator traits for the parameterized ALLOCATOR.

AllocatorType

Alias for the allocator type for a bsls::AlignmentUtil::MaxAlignedType.

ValueType

Alias for the parameterized type VALUE.

size_type

Unsigned integer type measuring pool size.

Member Functions

Name

Description

SimplePool [constructor]

Create a memory pool, adopting all outstanding memory allocations associated with the specified original pool, that returns blocks of contiguous memory of the sizeof the paramterized VALUE using the allocator associated with original. The chunk size is set to that of original and continues to double in size up to an implementation defined maximum number of blocks per chunk. Note that original is left in a valid but unspecified state.

SimplePool [constructor]

Create a memory pool that returns blocks of contiguous memory of the size of the parameterized VALUE using the specified allocator to supply memory. The chunk size grows starting with at least sizeof(VALUE), doubling in size up to an implementation defined maximum number of blocks per chunk.

~SimplePool [destructor]

Destroy this pool, releasing all associated memory back to the underlying allocator.

adopt

Adopt all outstanding memory allocations associated with the specified memory pool. The behavior is undefined unless this pool uses the same allocator as that associated with pool. The behavior is undefined unless this pool is in the default‐constructed state.

allocate

Return the address of a block of memory of at least the size of VALUE. Note that the memory is not initialized.

allocator

Return a reference providing modifiable access to the rebound allocator traits for the node‐type. Note that this operation returns a base‐class (AllocatorType) reference to this object.

allocator

Return a reference providing non‐modifiable access to the rebound allocator traits for the node‐type. Note that this operation returns a base‐class (AllocatorType) reference to this object.

deallocate

Relinquish the memory block at the specified address back to this pool object for reuse. The behavior is undefined unless address is non‐zero, was allocated by this pool, and has not already been deallocated.

hasFreeBlocks

Return true if this object holds free (currently unused) blocks, and false otherwise.

quickSwapExchangeAllocators

Efficiently exchange the memory blocks and the allocator of this object with those of the specified other object. This method provides the no‐throw exception‐safety guarantee.

quickSwapRetainAllocators

Efficiently exchange the memory blocks of this object with those of the specified other object. This method provides the no‐throw exception‐safety guarantee. The behavior is undefined unless allocator() == other.allocator().

release

Relinquish all memory currently allocated via this pool object.

reserve

Dynamically allocate a new chunk containing the specified numBlocks number of blocks, and add the chunk to the free memory list of this pool. The additional memory is added irrespective of the amount of free memory when called. The behavior is undefined unless 0 < numBlocks.

swap

Efficiently exchange the memory blocks of this object with those of the specified other object. This method provides the no‐throw exception‐safety guarantee. The behavior is undefined unless allocator() == other.allocator().

Created with MrDocs