scoped_allocator_adaptor Class

 

The new home for Visual Studio documentation is Visual Studio 2017 Documentation on docs.microsoft.com.

The latest version of this topic can be found at scoped_allocator_adaptor Class.

Represents a nest of allocators.

template <class Outer, class... Inner>  
class scoped_allocator_adaptor;  

The template class encapsulates a nest of one or more allocators. Each such class has an outermost allocator of type outer_allocator_type, a synonym for Outer, which is a public base of the scoped_allocator_adaptor object. Outer is used to allocate memory to be used by a container. You can obtain a reference to this allocator base object by calling outer_allocator.

The remainder of the nest has type inner_allocator_type. An inner allocator is used to allocate memory for elements within a container. You can obtain a reference to the stored object of this type by calling inner_allocator. If Inner... is not empty, inner_allocator_type has type scoped_allocator_adaptor<Inner...>, and inner_allocator designates a member object. Otherwise, inner_allocator_type has type scoped_allocator_adaptor<Outer>, and inner_allocator designates the entire object.

The nest behaves as if it has arbitrary depth, replicating its innermost encapsulated allocator as needed.

Several concepts that are not a part of the visible interface aid in describing the behavior of this template class. An outermost allocator mediates all calls to the construct and destroy methods. It is effectively defined by the recursive function OUTERMOST(X), where OUTERMOST(X) is one of the following.

  • If X.outer_allocator() is well formed, then OUTERMOST(X) is OUTERMOST(X.outer_allocator()).

  • Otherwise, OUTERMOST(X) is X.

Three types are defined for the sake of exposition:

TypeDescription
OutermostThe type of OUTERMOST(*this).
Outermost_traitsallocator_traits<Outermost>
Outer_traitsallocator_traits<Outer>

Constructors

NameDescription
scoped_allocator_adaptor::scoped_allocator_adaptor ConstructorConstructs a scoped_allocator_adaptor object.

Typedefs

NameDescription
const_pointerThis type is a synonym for the const_pointer that is associated with the allocator Outer.
const_void_pointerThis type is a synonym for the const_void_pointer that is associated with the allocator Outer.
difference_typeThis type is a synonym for the difference_type that is associated with the allocator Outer.
inner_allocator_typeThis type is a synonym for the type of the nested adaptor scoped_allocator_adaptor<Inner...>.
outer_allocator_typeThis type is a synonym for the type of the base allocator Outer.
pointerThis type is a synonym for the pointer associated with the allocator Outer.
propagate_on_container_copy_assignmentThe type holds true only if Outer_traits::propagate_on_container_copy_assignment holds true or inner_allocator_type::propagate_on_container_copy_assignment holds true.
propagate_on_container_move_assignmentThe type holds true only if Outer_traits::propagate_on_container_move_assignment holds true or inner_allocator_type::propagate_on_container_move_assignment holds true.
propagate_on_container_swapThe type holds true only if Outer_traits::propagate_on_container_swap holds true or inner_allocator_type::propagate_on_container_swap holds true.
size_typeThis type is a synonym for the size_type associated with the allocator Outer.
value_typeThis type is a synonym for the value_type associated with the allocator Outer.
void_pointerThis type is a synonym for the void_pointer associated with the allocator Outer.

Structs

NameDescription
scoped_allocator_adaptor::rebind StructDefines the type Outer::rebind\<Other>::other as a synonym for scoped_allocator_adaptor\<Other, Inner...>.

Methods

NameDescription
scoped_allocator_adaptor::allocate MethodAllocates memory by using the Outer allocator.
scoped_allocator_adaptor::construct MethodConstructs an object.
scoped_allocator_adaptor::deallocate MethodDeallocates objects by using the outer allocator.
scoped_allocator_adaptor::destroy MethodDestroys a specified object.
scoped_allocator_adaptor::inner_allocator MethodRetrieves a reference to the stored object of type inner_allocator_type.
scoped_allocator_adaptor::max_size MethodDetermines the maximum number of objects that can be allocated by the outer allocator.
scoped_allocator_adaptor::outer_allocator MethodRetrieves a reference to the stored object of type outer_allocator_type.
scoped_allocator_adaptor::select_on_container_copy_construction MethodCreates a new scoped_allocator_adaptor object with each stored allocator object initialized by calling select_on_container_copy_construction for each corresponding allocator.

Header: <scoped_allocator>

Namespace: std

Allocates memory by using the Outer allocator.

pointer allocate(size_type count);pointer allocate(size_type count, const_void_pointer hint);

Parameters

count
The number of elements for which sufficient storage is to be allocated.

hint
A pointer that might assist the allocator object by locating the address of an object allocated prior to the request.

Return Value

The first member function returns Outer_traits::allocate(outer_allocator(), count). The second member function returns Outer_traits::allocate(outer_allocator(), count, hint).

Constructs an object.

template <class Ty, class... Atypes>  
void construct(Ty* ptr, Atypes&&... args);

template <class Ty1, class Ty2, class... Atypes1, class... Atypes2>  
void construct(pair<Ty1, Ty2>* ptr, piecewise_construct_t,  
    tuple<Atypes1&&...>  
first, tuple<Atypes1&&...> second);

template <class Ty1, class Ty2>  
void construct(pair<Ty1, Ty2>* ptr);

template <class Ty1, class Ty2, class Uy1, class Uy2>  
void construct(pair<Ty1, Ty2>* ptr,  
    class Uy1&& first, class Uy2&& second);

template <class Ty1, class Ty2, class Uy1, class Uy2>  
void construct(pair<Ty1, Ty2>* ptr, const pair<Uy1, Uy2>& right);

template <class Ty1, class Ty2, class Uy1, class Uy2>  
void construct(pair<Ty1, Ty2>* ptr, pair<Uy1, Uy2>&& right);

Parameters

ptr
A pointer to the memory location where the object is to be constructed.

args
A list of arguments.

first
An object of the first type in a pair.

second
An object of the second type in a pair.

right
An existing object to be moved or copied.

Remarks

The first method constructs the object at ptr by calling Outermost_traits::construct(OUTERMOST(*this), ptr, xargs...), where xargs... is one of the following.

  • If uses_allocator<Ty, inner_allocator_type> holds false, then xargs... is args....

  • If uses_allocator<Ty, inner_allocator_type> holds true, and is_constructible<Ty, allocator_arg_t, inner_allocator_type, args...> holds true, then xargs... is allocator_arg, inner_allocator(), args....

  • If uses_allocator<Ty, inner_allocator_type> holds true, and is_constructible<Ty, args..., inner_allocator()> holds true, then xargs... is args..., inner_allocator().

The second method constructs the pair object at ptr by calling Outermost_traits::construct(OUTERMOST(*this), &ptr->first, xargs...), where xargs... is first... modified as in the above list, and Outermost_traits::construct(OUTERMOST(*this), &ptr->second, xargs...), where xargs... is second... modified as in the above list.

The third method behaves the same as this->construct(ptr, piecewise_construct, tuple<>, tuple<>).

The fourth method behaves the same as this->construct(ptr, piecewise_construct, forward_as_tuple(std::forward<Uy1>(first), forward_as_tuple(std::forward<Uy2>(second)).

The fifth method behaves the same as this->construct(ptr, piecewise_construct, forward_as_tuple(right.first), forward_as_tuple(right.second)).

The sixth method behaves the same as this->construct(ptr, piecewise_construct, forward_as_tuple(std::forward<Uy1>(right.first), forward_as_tuple(std::forward<Uy2>(right.second)).

Deallocates objects by using the outer allocator.

void deallocate(pointer ptr, size_type count);

Parameters

ptr
A pointer to the starting location of the objects to be deallocated.

count
The number of objects to deallocate.

Destroys a specified object.

template <class Ty>  
void destroy(Ty* ptr)  

Parameters

ptr
A pointer to the object to be destroyed.

Return Value

Outermost_traits::destroy(OUTERMOST(*this), ptr)

Retrieves a reference to the stored object of type inner_allocator_type.

inner_allocator_type& inner_allocator() noexcept;  
const inner_allocator_type& inner_allocator() const noexcept;  

Return Value

A reference to the stored object of type inner_allocator_type.

Determines the maximum number of objects that can be allocated by the outer allocator.

size_type max_size();

Return Value

Outer_traits::max_size(outer_allocator())

Retrieves a reference to the stored object of type outer_allocator_type.

outer_allocator_type& outer_allocator() noexcept;  
const outer_allocator_type& outer_allocator() const noexcept;  

Return Value

A reference to the stored object of type outer_allocator_type.

Defines the type Outer::rebind\<Other>::other as a synonym for scoped_allocator_adaptor\<Other, Inner...>.

struct rebind{
typedef Other_traits::rebind<Other>
Other_alloc;
typedef scoped_allocator_adaptor<Other_alloc, Inner...> other;
};

Constructs a scoped_allocator_adaptor object.

scoped_allocator_adaptor();

scoped_allocator_adaptor(const scoped_allocator_adaptor& right) noexcept;  
template <class Outer2>  
scoped_allocator_adaptor(
 const scoped_allocator_adaptor<Outer2, Inner...>& right) noexcept;  
template <class Outer2>  
scoped_allocator_adaptor(
 scoped_allocator_adaptor<Outer2, Inner...>&& right) noexcept;  
template <class Outer2>  
scoped_allocator_adaptor(Outer2&& al,  
    const Inner&... rest) noexcept;  

Parameters

right
An existing scoped_allocator_adaptor.

al
An existing allocator to be used as the outer allocator.

rest
A list of allocators to be used as the inner allocators.

Remarks

The first constructor default constructs its stored allocator objects. Each of the next three constructors constructs its stored allocator objects from the corresponding objects in right. The last constructor constructs its stored allocator objects from the corresponding arguments in the argument list.

Creates a new scoped_allocator_adaptor object with each stored allocator object initialized by calling select_on_container_copy_construction for each corresponding allocator.

scoped_allocator_adaptor select_on_container_copy_construction();

Return Value

This method effectively returns scoped_allocator_adaptor(Outer_traits::select_on_container_copy_construction(*this), inner_allocator().select_on_container_copy_construction()). The result is a new scoped_allocator_adaptor object with each stored allocator object initialized by calling al.select_on_container_copy_construction() for the corresponding allocator al.

Header Files Reference

Show: