[#BloombergLP-bslma-SequentialAllocator]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslma.adoc[bslma]::SequentialAllocator
:relfileprefix: ../../
:mrdocs:

This class implements the `ManagedAllocator` protocol to provide a fast allocator of arbitrarily&hyphen;sized blocks of memory&period; Both the `release` method and the destructor atomically delete all memory managed by this allocator&semi; the `deallocate` method, however, has no effect for this class&period;

== Synopsis

Declared in `&lt;bslma&lowbar;sequentialallocator&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class SequentialAllocator
    : public xref:BloombergLP/bslma/ManagedAllocator.adoc[ManagedAllocator]
----

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bslma/ManagedAllocator.adoc[ManagedAllocator]`
| Provide a protocol for allocators with the ability to `release` all memory currently allocated through the protocol back to the memory supplier of the derived concrete allocator object&period;
|===

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslma/Allocator/size_type.adoc[`size&lowbar;type`] 
| Alias for an unsigned integral type capable of representing the number of bytes in this platform&apos;s virtual address space&period;
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslma/SequentialAllocator/2constructor-09.adoc[`SequentialAllocator`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bslma/SequentialAllocator/2destructor.adoc[`&#126;SequentialAllocator`] [.small]#[destructor]# [.small]#[virtual]#
| Destroy this sequential allocator and release all associated memory&period;
| xref:BloombergLP/bslma/Allocator/operator_assign.adoc[`operator&equals;`] 
| 
| xref:BloombergLP/bslma/SequentialAllocator/allocate-06.adoc[`allocate`] 
| `allocate` overloads
| xref:BloombergLP/bslma/SequentialAllocator/allocateAndExpand-0e.adoc[`allocateAndExpand`] 
| `allocateAndExpand` overloads
| xref:BloombergLP/bslma/SequentialAllocator/deallocate-01.adoc[`deallocate`] 
| This method has no effect for this allocator&period;
| xref:BloombergLP/bslma/Allocator/deleteObject-09.adoc[`deleteObject`] 
| `deleteObject` overloads
| xref:BloombergLP/bslma/Allocator/deleteObjectRaw-06f.adoc[`deleteObjectRaw`] 
| `deleteObjectRaw` overloads
| xref:BloombergLP/bslma/SequentialAllocator/expand-07.adoc[`expand`] 
| `expand` overloads
| xref:BloombergLP/bslma/Allocator/is_equal.adoc[`is&lowbar;equal`] 
| 
| xref:BloombergLP/bslma/SequentialAllocator/release.adoc[`release`]  [.small]#[virtual]#
| Release all memory currently allocated through this allocator&period;
| xref:BloombergLP/bslma/SequentialAllocator/reserveCapacity.adoc[`reserveCapacity`]  [.small]#[virtual]#
| Reserve sufficient memory to satisfy allocation requests for at least the specified `numBytes` without replenishment (i&period;e&period;, without internal allocation)&period; The behavior is undefined unless `0 &lt;&equals; numBytes`&period;
| xref:BloombergLP/bslma/SequentialAllocator/truncate.adoc[`truncate`] 
| Reduce the amount of memory allocated at the specified `address`&period;
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslma/Allocator/throwBadAlloc.adoc[`throwBadAlloc`] 
| Throw `std&colon;&colon;bad&lowbar;alloc` if exceptions are enabled or abort the program otherwise&period; Derived classes and helper functions will typically call this function when they are unable to satisfy an allocation request&period; This function never returns&period;
|===


== Protected Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslma/Allocator/do_allocate.adoc[`do&lowbar;allocate`]  [.small]#[virtual]#
| Return a newly allocated block of memory of (at least) the specified positive `bytes` and having at least the specified `alignment`&period; Unless overriden in a derived class, the return value is `this&hyphen;&gt;allocate(bytes)`&period; If this allocator cannot return the requested number of bytes or cannot satisfy the alignment request, then it will throw a `std&colon;&colon;bad&lowbar;alloc` exception in an exception&hyphen;enabled build, or else will abort the program in a non&hyphen;exception build&period; Unless overriden in a derived class, this function will forward the allocation request to the `allocate` virtual function, padding `bytes` and adjusting the return value as necessary to ensure sufficient alignment&period; Note that if `bytes` is `0`, the same non&hyphen;null value will be returned every time&period;
| xref:BloombergLP/bslma/Allocator/do_deallocate.adoc[`do&lowbar;deallocate`]  [.small]#[virtual]#
| Return the memory block at the specified `p` address, having the specified `bytes` and specified `alignment`, back to this allocator&period; Unless overriden in a derived class, this function will forward the deallocation request to the `deallocate` virtual function, padding `bytes` and adjusting `p` as necessary to account for `alignment` values other than the natural alignment for an object of size `bytes`&period; The behavior is undefined unless `address` is a block allocated from this allocator object using the same `bytes` and `alignment` and not already deallocated&period;
| xref:BloombergLP/bslma/Allocator/do_is_equal.adoc[`do&lowbar;is&lowbar;equal`]  [.small]#[virtual]#
| Return `true` if this allocator is equal to the specified `other` allocator, meaning (at least) that a memory block allocated by one can be deallocated by the other&semi; otherwise return `false`&period; Unless overriden, this method returns `this &equals;&equals; &amp;other`&period;
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#
