[#BloombergLP-bdlma-AlignedAllocator]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlma.adoc[bdlma]::AlignedAllocator
:relfileprefix: ../../
:mrdocs:

Protocol for clients and suppliers of raw aligned memory.

== Synopsis

Declared in `<bdlma_alignedallocator.h>`

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

== Description

This protocol provides a pure abstract interface and contract for clients and suppliers of raw aligned memory. If the requested memory cannot be returned, the contract requires that an `std::bad_alloc` exception be thrown.

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bslma/Allocator.adoc[bslma::Allocator]`
| Pure abstract protocol for clients and suppliers of raw memory.
|===

== Type Aliases

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


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslma/Allocator/operator_assign.adoc[`operator=`] 
| 
| xref:BloombergLP/bslma/Allocator/allocate-03b.adoc[`allocate`] 
| Return a newly allocated block of memory of at least `size` bytes.
| xref:BloombergLP/bdlma/AlignedAllocator/allocateAligned.adoc[`allocateAligned`]  [.small]#[virtual]#
| Return a newly allocated block of at least `size` bytes with `alignment`.
| xref:BloombergLP/bslma/Allocator/deallocate-04.adoc[`deallocate`] 
| Return the memory block at `address` to this allocator.
| xref:BloombergLP/bslma/Allocator/deleteObject-09.adoc[`deleteObject`] 
| `deleteObject` overloads
| xref:BloombergLP/bslma/Allocator/deleteObjectRaw-06f.adoc[`deleteObjectRaw`] 
| `deleteObjectRaw` overloads
| xref:BloombergLP/bslma/Allocator/is_equal.adoc[`is_equal`] 
| 
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslma/Allocator/throwBadAlloc.adoc[`throwBadAlloc`] 
| Throw `std::bad_alloc` or abort the program.
|===


== Protected Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslma/Allocator/do_allocate.adoc[`do_allocate`]  [.small]#[virtual]#
| Return a newly allocated block of at least `bytes` with `alignment`.
| xref:BloombergLP/bslma/Allocator/do_deallocate.adoc[`do_deallocate`]  [.small]#[virtual]#
| Return the memory block at `p` having `bytes` and `alignment`.
| xref:BloombergLP/bslma/Allocator/do_is_equal.adoc[`do_is_equal`]  [.small]#[virtual]#
| Return whether this allocator can exchange memory with `other`.
|===



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