[#PoolAllocator-0e]
= PoolAllocator
:mrdocs:

Forwards all allocations&sol;deallocations to the PoolResource&period;

== Synopsis

Declared in `&lt;support&sol;allocators&sol;pool&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template&lt;
    class T,
    std::size&lowbar;t MAX&lowbar;BLOCK&lowbar;SIZE&lowbar;BYTES,
    std::size&lowbar;t ALIGN&lowbar;BYTES = alignof(T)&gt;
class PoolAllocator;
----

== Types

[cols="1,4"]
|===
| Name| Description
| xref:PoolAllocator-0e/rebind.adoc[`rebind`] 
| The rebind struct here is mandatory because we use non type template arguments for PoolAllocator&period; See https&colon;&sol;&sol;en&period;cppreference&period;com&sol;w&sol;cpp&sol;named&lowbar;req&sol;Allocator&num;cite&lowbar;note&hyphen;2
|===


== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:PoolAllocator-0e/ResourceType.adoc[`ResourceType`] 
| The pool resource type that backs this allocator&period;
| xref:PoolAllocator-0e/value_type.adoc[`value&lowbar;type`] 
| The type of object this allocator allocates&period;
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:PoolAllocator-0e/2constructor-0e.adoc[`PoolAllocator`]         [.small]#[constructor]#
| Constructors
| xref:PoolAllocator-0e/operator_assign.adoc[`operator&equals;`] 
| Copy assignment&semi; shares the same backing resource&period;
| xref:PoolAllocator-0e/allocate.adoc[`allocate`] 
| Forwards each call to the resource&period;
| xref:PoolAllocator-0e/deallocate.adoc[`deallocate`] 
| Forwards each call to the resource&period;
| xref:PoolAllocator-0e/resource.adoc[`resource`] 
| Access the backing pool resource&period;
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `PoolAllocator`
| Forwards all allocations&sol;deallocations to the PoolResource&period;
|===

== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:operator_eq-019.adoc[`operator&equals;&equals;`]
| Compares two pool allocators for equality&period;
|===


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