std::aligned_storage

 

C++

Language

Standard library headers

Concepts

Utilities library

Strings library

Containers library

Algorithms library

Iterators library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

Technical Specifications

 

Utilities library

Type support (basic types, RTTI, type traits)

Dynamic memory management

Error handling

Program utilities

Variadic functions

Date and time

Function objects

initializer_list (C++11)

bitset

hash (C++11)

Relational operators

rel_ops::operator!=rel_ops::operator>rel_ops::operator<=rel_ops::operator>=

Pairs and tuples

pair

tuple (C++11)

piecewise_construct_t (C++11)

piecewise_construct (C++11)

integer_sequence (C++14)

Swap, forward and move

swap

exchange (C++14)

forward (C++11)

move (C++11)

move_if_noexcept (C++11)

Type operations

declval (C++11)

as_const (C++17)

 

Type support

Basic types
Fundamental types
Fixed width integer types (C++11)
ptrdiff_t size_t max_align_t (C++11)	nullptr_t (C++11) offsetof NULL
Numeric limits
numeric_limits
C numeric limits interface
Runtime type information
type_info type_index (C++11)	bad_typeid bad_cast
Type traits
Type categories
is_void (C++11) is_null_pointer (C++14) is_array (C++11) is_pointer (C++11) is_enum (C++11) is_union (C++11) is_class (C++11) is_function (C++11)	is_object (C++11) is_scalar (C++11) is_compound (C++11) is_integral (C++11) is_floating_point (C++11) is_fundamental (C++11) is_arithmetic (C++11)
is_reference (C++11)
is_lvalue_reference (C++11)
is_rvalue_reference (C++11)
is_member_pointer (C++11)
is_member_object_pointer (C++11)
is_member_function_pointer (C++11)

Type properties
is_const (C++11) is_volatile (C++11) is_pod (C++11) is_empty (C++11) is_polymorphic (C++11) is_final (C++14) is_abstract (C++11)	is_trivial (C++11) is_trivially_copyable (C++11) is_standard_layout (C++11) is_literal_type (C++11) is_signed (C++11) is_unsigned (C++11)
Type trait constants
integral_constantbool_constanttrue_typefalse_type (C++11)(C++17)(C++11)(C++11)
Metafunctions
conjunction (C++17)
disjunction (C++17)
negation (C++17)

Supported operations
is_constructibleis_trivially_constructibleis_nothrow_constructible (C++11)(C++11)(C++11)
is_default_constructibleis_trivially_default_constructibleis_nothrow_default_constructible (C++11)(C++11)(C++11)
is_copy_constructibleis_trivially_copy_constructibleis_nothrow_copy_constructible (C++11)(C++11)(C++11)
is_move_constructibleis_trivially_move_constructibleis_nothrow_move_constructible (C++11)(C++11)(C++11)
is_assignableis_trivially_assignableis_nothrow_assignable (C++11)(C++11)(C++11)
is_copy_assignableis_trivially_copy_assignableis_nothrow_copy_assignable (C++11)(C++11)(C++11)
is_move_assignableis_trivially_move_assignableis_nothrow_move_assignable (C++11)(C++11)(C++11)
is_destructibleis_trivially_destructibleis_nothrow_destructible (C++11)(C++11)(C++11)
has_virtual_destructor (C++11)
Relationships and property queries
is_same (C++11) is_base_of (C++11) is_convertible (C++11)	alignment_of (C++11) rank (C++11) extent (C++11)
Type modifications
remove_cvremove_constremove_volatile (C++11)(C++11)(C++11) add_cvadd_constadd_volatile (C++11)(C++11)(C++11) make_signed (C++11) make_unsigned (C++11)	remove_reference (C++11) add_lvalue_referenceadd_rvalue_reference (C++11)(C++11) remove_pointer (C++11) add_pointer (C++11) remove_extent (C++11) remove_all_extents (C++11)
Type transformations
aligned_storage (C++11) aligned_union (C++11) decay (C++11) enable_if (C++11) void_t (C++17)	conditional (C++11) common_type (C++11) underlying_type (C++11) result_of (C++11)

 

Defined in header <type_traits>
template< std::size_t Len, std::size_t Align = /*default-alignment*/ > struct aligned_storage;		(since C++11)

Provides the member typedef type, which is a PODType suitable for use as uninitialized storage for any object whose size is at most Len and whose alignment requirement is a divisor of Align.

The default value of Align is the most stringent (the largest) alignment requirement for any object whose size is at most Len. If the default value is not used, Align must be the value of alignof(T) for some type T, or the behavior is undefined.

The behavior is undefined if Len == 0.

Member types

Name	Definition
type	the POD type of at least size Len with alignment requirement Align

Helper types

template< std::size_t Len, std::size_t Align = /*default-alignment*/ > using aligned_storage_t = typename aligned_storage<Len, Align>::type;		(since C++14)

Notes

The type defined by std::aligned_storage<>::type can be used to create uninitialized memory blocks suitable to hold the objects of given type, optionally aligned stricter than their natural alignment requirement, for example on a cache or page boundary.

As with any other uninitialized storage, the objects are created using placement new and destroyed with explicit destructor calls.

Possible implementation

Except for default argument, aligned_storage is expressible in terms of alignas:

template<std::size_t Len, std::size_t Align /* default alignment not implemented */> struct aligned_storage { typedef struct { alignas(Align) unsigned char data[Len]; } type; };

Example

A primitive static vector class, demonstrating creation, access, and destruction of objects in aligned storage

Run this code

#include <iostream>
#include <type_traits>
#include <string>
 
template<class T, std::size_t N>
class static_vector
{
    // properly aligned uninitialized storage for N T's
    typename std::aligned_storage<sizeof(T), alignof(T)>::type data[N];
    std::size_t m_size = 0;
 
public:
    // Create an object in aligned storage
    template<typename ...Args> void emplace_back(Args&&... args) 
    {
        if( m_size >= N ) // possible error handling
            throw std::bad_alloc{};
        new(data+m_size) T(std::forward<Args>(args)...);
        ++m_size;
    }
 
    // Access an object in aligned storage
    const T& operator[](std::size_t pos) const 
    {
        return *reinterpret_cast<const T*>(data+pos);
    }
 
    // Delete objects from aligned storage
    ~static_vector() 
    {
        for(std::size_t pos = 0; pos < m_size; ++pos) {
            reinterpret_cast<const T*>(data+pos)->~T();
        }
    }
};
 
int main()
{
    static_vector<std::string, 10> v1;
    v1.emplace_back(5, '*');
    v1.emplace_back(10, '*');
    std::cout << v1[0] << '\n' << v1[1] << '\n';
}

Output:

*****
**********

See also

alignas specifier	specifies that the storage for the variable should be aligned by specific amount (C++11)
alignment_of (C++11)	obtains the type's alignment requirements (class template)
aligned_union (C++11)	defines the type suitable for use as uninitialized storage for all given types (class template)
max_align_t (C++11)	POD type with alignment requirement as great as any other scalar type (typedef)