std:: reference_wrapper

std::reference_wrapper は、参照をコピー可能で代入可能なオブジェクトにラップするクラステンプレートです。

具体的には、 std::reference_wrapper は、 CopyConstructible かつ CopyAssignable なラッパーであり、型 T のオブジェクトへの参照または関数への参照を包みます。 std::reference_wrapper のインスタンスはオブジェクトであり（コピーやコンテナへの格納が可能）、暗黙的に T & に変換可能です。そのため、基になる型を参照で受け取る関数の引数として使用することができます。

格納された参照が Callable である場合、 std::reference_wrapper は同じ引数で呼び出し可能です。

ヘルパー関数 std::ref および std::cref は、しばしば std::reference_wrapper オブジェクトを生成するために使用されます。

std::reference_wrapper は、オブジェクトを参照で std::bind や std::thread のコンストラクタ、あるいはヘルパー関数である std::make_pair や std::make_tuple に渡すために使用されます。また、通常は参照を保持できない標準コンテナ（ std::vector など）内部で参照を格納する仕組みとしても使用できます。

メンバー型

メンバー関数

非メンバー関数

推論ガイド (C++17以降)

ヘルパークラス

実装例

namespace detail
{
    template<class T> constexpr T& FUN(T& t) noexcept { return t; }
    template<class T> void FUN(T&&) = delete;
}
template<class T>
class reference_wrapper
{
public:
    // 型
    using type = T;
    // 構築/コピー/破棄
    template<class U, class = decltype(
        detail::FUN<T>(std::declval<U>()),
        std::enable_if_t<!std::is_same_v<reference_wrapper, std::remove_cvref_t<U>>>()
    )>
    constexpr reference_wrapper(U&& u)
        noexcept(noexcept(detail::FUN<T>(std::forward<U>(u))))
        : _ptr(std::addressof(detail::FUN<T>(std::forward<U>(u)))) {}
    reference_wrapper(const reference_wrapper&) noexcept = default;
    // 代入
    reference_wrapper& operator=(const reference_wrapper& x) noexcept = default;
    // アクセス
    constexpr operator T& () const noexcept { return *_ptr; }
    constexpr T& get() const noexcept { return *_ptr; }
    template<class... ArgTypes>
    constexpr std::invoke_result_t<T&, ArgTypes...>
        operator() (ArgTypes&&... args ) const
            noexcept(std::is_nothrow_invocable_v<T&, ArgTypes...>)
    {
        return std::invoke(get(), std::forward<ArgTypes>(args)...);
    }
private:
    T* _ptr;
};
// 推論ガイド
template<class T>
reference_wrapper(T&) -> reference_wrapper<T>;

例

#include <algorithm>
#include <functional>
#include <iostream>
#include <list>
#include <numeric>
#include <random>
#include <vector>
void println(auto const rem, std::ranges::range auto const& v)
{
    for (std::cout << rem; auto const& e : v)
        std::cout << e << ' ';
    std::cout << '\n';
}
int main()
{
    std::list<int> l(10);
    std::iota(l.begin(), l.end(), -4);
    // can't use shuffle on a list (requires random access), but can use it on a vector
    std::vector<std::reference_wrapper<int>> v(l.begin(), l.end());
    std::ranges::shuffle(v, std::mt19937{std::random_device{}()});
    println("Contents of the list: ", l);
    println("Contents of the list, as seen through a shuffled vector: ", v);
    std::cout << "Doubling the values in the initial list...\n";
    std::ranges::for_each(l, [](int& i) { i *= 2; });
    println("Contents of the list, as seen through a shuffled vector: ", v);
}

Contents of the list: -4 -3 -2 -1 0 1 2 3 4 5
Contents of the list, as seen through a shuffled vector: -1 2 -2 1 5 0 3 -3 -4 4
Doubling the values in the initial list...
Contents of the list, as seen through a shuffled vector: -2 4 -4 2 10 0 6 -6 -8 8

関連項目