std::align

 

C++

コンパイラサポート

フリースタンディングとホスト

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

汎用ユーティリティライブラリ

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

ファイルシステムライブラリ (C++17)

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

メモリ管理ライブラリ

voidify (説明用*) 未初期化メモリのアルゴリズム uninitialized_copy uninitialized_fill uninitialized_move (C++17) uninitialized_default_construct (C++17) uninitialized_value_construct (C++17) destroy (C++17) destroy_at (C++17) uninitialized_copy_n (C++11) uninitialized_fill_n uninitialized_move_n (C++17) uninitialized_default_construct_n (C++17) uninitialized_value_construct_n (C++17) destroy_n (C++17) construct_at (C++20) 制約付き未初期化 メモリアルゴリズム ranges::uninitialized_copy (C++20) ranges::uninitialized_fill (C++20) ranges::uninitialized_move (C++20) ranges::construct_at (C++20) ranges::destroy (C++20) ranges::destroy_n (C++20) ranges::destroy_at (C++20) ranges::uninitialized_copy_n (C++20) ranges::uninitialized_fill_n (C++20) ranges::uninitialized_move_n (C++20) ranges::uninitialized_default_construct (C++20) ranges::uninitialized_value_construct (C++20) ranges::uninitialized_default_construct_n (C++20)  ranges::uninitialized_value_construct_n (C++20) Cライブラリ malloc calloc realloc aligned_alloc (C++17) free

アロケータ allocator allocator_traits (C++11) allocation_result (C++23) allocator_arg (C++11) uses_allocator (C++11) uses_allocator_construction_args (C++20) make_obj_using_allocator (C++20) uninitialized_construct_using_allocator (C++20)  scoped_allocator_adaptor (C++11) pmr::polymorphic_allocator (C++17) メモリリソース pmr::memory_resource (C++17) pmr::get_default_resource (C++17) pmr::set_default_resource (C++17) pmr::new_delete_resource (C++17) pmr::null_memory_resource (C++17) pmr::synchronized_pool_resource (C++17) pmr::unsynchronized_pool_resource (C++17) pmr::monotonic_buffer_resource (C++17) pmr::pool_options (C++17) ガベージコレクションのサポート declare_reachable (C++11)(C++23まで) undeclare_reachable (C++11)(C++23まで) declare_no_pointers (C++11)(C++23まで) undeclare_no_pointers (C++11)(C++23まで) pointer_safety (C++11)(C++23まで) get_pointer_safety (C++11)(C++23まで) 未初期化ストレージ raw_storage_iterator (C++20まで*) get_temporary_buffer (C++20まで*) return_temporary_buffer (C++20まで*) 明示的な生存期間管理 start_lifetime_asstart_lifetime_as_array (C++23)(C++23)

スマートポインタ unique_ptr (C++11) shared_ptr (C++11) weak_ptr (C++11) auto_ptr (C++17まで*) owner_less (C++11) owner_less<void> (C++17) owner_hash (C++26) owner_equal (C++26) enable_shared_from_this (C++11) bad_weak_ptr (C++11) default_delete (C++11) out_ptr_t (C++23) inout_ptr_t (C++23) 低レベルメモリ 管理 operator new operator new[] operator delete operator delete[] get_new_handler (C++11) set_new_handler launder (C++17) bad_alloc bad_array_new_length (C++11) nothrow_t align_val_t (C++17) destroying_delete_t (C++20) new_handler nothrow その他 pointer_traits (C++11) to_address (C++20) addressof (C++11) align (C++11) assume_aligned (C++20) is_sufficiently_aligned (C++26)

 

ヘッダ <memory> で定義
void* align( std::size_t alignment,              std::size_t size,              void*& ptr,              std::size_t& space );		(C++11以降)

指定された alignment でアライメントされた、size バイトの領域を指すポインタをバッファ ptr (サイズ space) から取得し、アライメントに使用されたバイト数だけ space 引数を減少させます。最初のアライメントされたアドレスが返されます。

この関数は、指定されたアライメントで要求されたバイト数をバッファに格納できる場合にのみ、ポインタを変更します。バッファが小さすぎる場合、関数は何もせず nullptr を返します。

alignment が2のべき乗でない場合、動作は未定義です。

パラメータ

alignment	-	目的のアライメント
size	-	アライメントされるストレージのサイズ
ptr	-	少なくとも space バイトの連続したストレージ (バッファ) を指すポインタ
スペース	-	操作対象のバッファのサイズ

戻り値

調整された ptr の値。提供された領域が小さすぎる場合はヌルポインタ値。

例

std::align を使用して、異なる型のオブジェクトをメモリに配置する方法を示します。

このコードを実行

#include <iostream>
#include <memory>
#include <new>
 
template<std::size_t N>
struct MyAllocator
{
    std::byte data[N];
    std::size_t sz{N};
    void* p;
 
    MyAllocator() : p(data) {}
 
    // Note: only well-defined for implicit-lifetime types
    template<typename T>
    T* implicit_aligned_alloc(std::size_t a = alignof(T))
    {
        if (std::align(a, sizeof(T), p, sz))
        {
            T* result = std::launder(reinterpret_cast<T*>(p));
            p = static_cast<std::byte*>(p) + sizeof(T);
            sz -= sizeof(T);
            return result;
        }
        return nullptr;
    }
};
 
int main()
{
    MyAllocator<64> a;
    std::cout << "allocated a.data at " << (void*)a.data
              << " (" << sizeof a.data << " bytes)\n";
 
    // Allocate a char
    if (char* p = a.implicit_aligned_alloc<char>())
    {
        *p = 'a';
        std::cout << "allocated a char at " << (void*)p << '\n';
    }
 
    // Allocate an int
    if (int* p = a.implicit_aligned_alloc<int>())
    {
        *p = 1;
        std::cout << "allocated an int at " << (void*)p << '\n';
    }
 
    // Allocate an int, aligned at a 32-byte boundary
    if (int* p = a.implicit_aligned_alloc<int>(32))
    {
        *p = 2;
        std::cout << "allocated an int at " << (void*)p << " (32-byte alignment)\n";
    }
}

実行結果の例

allocated a.data at 0x7ffc654e8530 (64 bytes)
allocated a char at 0x7ffc654e8530
allocated an int at 0x7ffc654e8534
allocated an int at 0x7ffc654e8540 (32-byte alignment)

不具合報告

以下の動作変更を伴う欠陥報告が、以前に公開されたC++標準に遡って適用されました。

DR	適用対象	公開された動作	正しい動作
LWG 2377	C++11	alignment は、基本的なアライメント値またはサポートされている拡張アライメント値である必要がある	2のべき乗であるだけでよい

関連項目

alignof (C++11)	型のアライメント要件を問い合わせる (演算子)
alignas (C++11)	変数用のストレージを特定の量でアラインすることを指定します。 (指定子)
aligned_storage (C++11以降)(C++23で非推奨)	与えられたサイズの型の未初期化ストレージとして使用するのに適した型を定義する (クラステンプレート)
assume_aligned (C++20)	ポインタがアラインされていることをコンパイラに伝えます (関数テンプレート)