std::reference_wrapper

Определён в заголовочном файле `<functional>`
template< class T > class reference_wrapper;		(начиная с C++11)

std::reference_wrapper — это шаблон класса, который оборачивает ссылку в копируемый объект с возможностью присваивания.

В частности, std::reference_wrapper — это обёртка над ссылкой на объект или функцией типа T, которая удовлетворяет требованиям CopyConstructible и CopyAssignable. Экземпляры 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), которые обычно не могут содержать ссылки.

Гарантируется, что std::reference_wrapper является TriviallyCopyable.

(начиная с C++17)

T может быть неполным типом.

(начиная с C++20)

Типы-члены

тип	определение
`type`	`T`
`result_type` (устарел в C++17) (удалён в C++20)	Тип возвращаемого значения `T`, если `T` является функцией. В противном случае не определён.
`argument_type` (устарел в C++17) (удалён в C++20)	если `T` является функцией или указателем на функцию, принимающую один аргумент типа `A1`, то `argument_type` — это `A1` если `T` является указателем на функцию-член класса `T0`, не принимающую аргументов, то `argument_type` — это T0*, возможно, с квалификатором cv если `T` является типом класса с типом-членом T::argument_type, то `argument_type` является его псевдонимом
`first_argument_type` (устарел в C++17) (удалён в C++20)	если `T` является функцией или указателем на функцию, принимающую два аргумента типов `A1` и `A2`, то `first_argument_type` — это `A1` если `T` является указателем на функцию-член класса `T0`, принимающую один аргумент, то `first_argument_type` — это T0*, возможно, с квалификатором cv если `T` является типом класса с типом-членом T::first_argument_type, то `first_argument_type` является его псевдонимом
`second_argument_type` (устарел в C++17) (удалён в C++20)	если `T` является функцией или указателем на функцию, принимающую два аргумента типов s `A1` и `A2`, то `second_argument_type` — это `A2` если `T` является указателем на функцию-член класса `T0`, принимающую один аргумент `A1`, то `second_argument_type` — это `A1`, возможно, с квалификатором cv если `T` является типом класса с типом-членом T::second_argument_type, то `second_argument_type` является его псевдонимом

Функции-члены

(конструктор)	сохраняет ссылку в новом объекте `std::reference_wrapper` (функция-член)
operator=	переназначает ссылку `std::reference_wrapper` (функция-член)
getoperator T&	предоставляет доступ к хранимой ссылке (функция-член)
operator()	вызывает хранимую функцию (функция-член)

Функции, не являющиеся членами

operator==operator<=>

(C++26)

сравнивает объекты reference_wrapper по хранимым в них ссылкам
(функция)

Направляющие вывода типов(начиная с C++17)

Вспомогательные классы

std::basic_common_reference<std::reference_wrapper>

(C++23)

определяет общий тип ссылки для reference_wrapper и не-reference_wrapper
(специализация шаблона класса)

Возможная реализация

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:
    // types
    using type = T;

    // construct/copy/destroy
    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;
 
    // assignment
    reference_wrapper& operator=(const reference_wrapper& x) noexcept = default;
 
    // access
    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;
};

// deduction guides
template<class T>
reference_wrapper(T&) -> reference_wrapper<T>;

Пример

Демонстрируется использование std::reference_wrapper в качестве контейнера ссылок, что позволяет обращаться к одному и тому же контейнеру с помощью нескольких индексов.

#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

См. также

refcref (C++11)(C++11)	создаёт `std::reference_wrapper` с типом, выведенным из аргумента (шаблон функции)
bind (C++11)	связывает один или несколько аргументов с функциональным объектом (шаблон функции)
unwrap_referenceunwrap_ref_decay (C++20)(C++20)	получает тип ссылки, обёрнутый в `std::reference_wrapper` (шаблон класса)

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/cpp/utility/functional/reference_wrapper