[#BloombergLP-bsltf-StdAllocatorAdaptor]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bsltf.adoc[bsltf]::StdAllocatorAdaptor
:relfileprefix: ../../
:mrdocs:

This class template provides the facade of an allocator but mostly delegates operations to the allocator object (of template parameter type) it adapts, except that it enables the propagation of the (stateful) allocator object to constructed elements, if appropriate.

== Synopsis

Declared in `<bsltf_stdallocatoradaptor.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class ALLOCATOR>
class StdAllocatorAdaptor
    : public ALLOCATOR
----

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `ALLOCATOR`
| 
|===

== Types

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bsltf/StdAllocatorAdaptor/rebind.adoc[`rebind`] 
| This nested `struct` template, parameterized by some `BDE_OTHER_TYPE`, provides a namespace for an `other` type alias, which is an allocator type following the same template as this one but that allocates elements of `BDE_OTHER_TYPE`. Note that this allocator type is convertible to and from `other` for any `BDE_OTHER_TYPE` including `void`.
|===


== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bsltf/StdAllocatorAdaptor/const_pointer.adoc[`const_pointer`] 
| Alias for `ALLOCATOR::const_pointer`.
| xref:BloombergLP/bsltf/StdAllocatorAdaptor/const_reference.adoc[`const_reference`] 
| Alias for `ALLOCATOR::const_reference`.
| xref:BloombergLP/bsltf/StdAllocatorAdaptor/difference_type.adoc[`difference_type`] 
| Alias for `ALLOCATOR::difference_type`.
| xref:BloombergLP/bsltf/StdAllocatorAdaptor/pointer.adoc[`pointer`] 
| Alias for `ALLOCATOR::pointer`.
| xref:BloombergLP/bsltf/StdAllocatorAdaptor/reference.adoc[`reference`] 
| Alias for `ALLOCATOR::reference`.
| xref:BloombergLP/bsltf/StdAllocatorAdaptor/size_type.adoc[`size_type`] 
| Alias for `ALLOCATOR::size_type`.
| xref:BloombergLP/bsltf/StdAllocatorAdaptor/value_type.adoc[`value_type`] 
| Alias for `ALLOCATOR::value_type`.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bsltf/StdAllocatorAdaptor/2constructor-088.adoc[`StdAllocatorAdaptor`]         [.small]#[constructor]#
| Create a standard allocator adaptor object for a default‐constructed allocator object of the (template parameter) type `ALLOCATOR`.
| xref:BloombergLP/bsltf/StdAllocatorAdaptor/2constructor-00.adoc[`StdAllocatorAdaptor`]         [.small]#[constructor]#
| Create a copy of the specified `original` allocator adaptor.
| xref:BloombergLP/bsltf/StdAllocatorAdaptor/2constructor-089.adoc[`StdAllocatorAdaptor`]         [.small]#[constructor]#
| Create a copy of the specified `other` allocator adaptor.
| xref:BloombergLP/bsltf/StdAllocatorAdaptor/2constructor-07.adoc[`StdAllocatorAdaptor`]         [.small]#[constructor]#
| Create a standard allocator adaptor object from the null pointer constant.
| xref:BloombergLP/bsltf/StdAllocatorAdaptor/2constructor-06.adoc[`StdAllocatorAdaptor`]         [.small]#[constructor]#
| Create a standard allocator adaptor object for the specified `allocator` of the (template parameter) type `ALLOCATOR`.
| xref:BloombergLP/bsltf/StdAllocatorAdaptor/operator_assign.adoc[`operator=`] 
| Assign to this object the value of the specified `rhs` object, and return a reference providing modifiable access to this object.
| xref:BloombergLP/bsltf/StdAllocatorAdaptor/allocator.adoc[`allocator`] 
| Return a reference to the non‐modifiable allocator instance associated with this standard allocator adaptor.
| xref:BloombergLP/bsltf/StdAllocatorAdaptor/construct.adoc[`construct`] 
| Construct an object of the (template parameter) `ELEMENT_TYPE`, by forwarding the allocator instance associated with this allocator adaptor, if appropriate, and the specified (variable number of) `arguments` to the corresponding constructor of `ELEMENT_TYPE`, at the specified uninitialized memory `address`. The behavior is undefined unless `address` is properly aligned for objects of `ELEMENT_TYPE`.
| xref:BloombergLP/bsltf/StdAllocatorAdaptor/select_on_container_copy_construction.adoc[`select_on_container_copy_construction`] 
| Return an allocator adaptor for the allocator object returned by the `select_on_container_copy_construction` class method in the `allocator_traits` class template for the allocator object, of the (template parameter) type `ALLOCATOR`, associated with this adaptor. The `allocator_traits` class template presumably delegates this call to the allocator object if such an operation is supported by the `ALLOCATOR` type, or provides a suitable default behavior if such an operation is not supported.
| xref:BloombergLP/bsltf/StdAllocatorAdaptor/2conversion.adoc[`operator BloombergLP::bslmf::NestedTraitDeclaration<StdAllocatorAdaptor, IsStdAllocator>`] 
| Declare `StdAllocatorAdaptor` as a standard allocator.
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bsltf/operator_not_eq-092.adoc[`operator!=`]
| Return `true` if the specified `lhs` and `rhs` adaptors are not equal and `false` otherwise. Two allocator adaptor instances are not equal if their associated allocator instances are not equal.
| xref:BloombergLP/bsltf/operator_eq-099.adoc[`operator==`]
| Return `true` if the specified `lhs` and `rhs` adaptors are equal and `false` otherwise. Two allocator adaptor instances are equal if their associated allocator instances are equal.
|===


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