Namespaces
Variants

std:: reference_wrapper

From cppreference.net
Utilities library
Function objects
Function invocation
(C++17) (C++23)
Identity function object
(C++20)
Reference wrappers
reference_wrapper
(C++11)
(C++11) (C++11)
Old binders and adaptors
( until C++17* )
( until C++17* )
( until C++17* )
( until C++17* )
( until C++17* ) ( until C++17* ) ( until C++17* ) ( until C++17* )
( until C++20* )
( until C++20* )
( until C++17* ) ( until C++17* )
( until C++17* ) ( until C++17* )

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

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 ), которые обычно не могут содержать ссылки.

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 является функцией или указателем на функцию, принимающую два аргумента типов 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
(публичная функция-член)
перепривязывает std::reference_wrapper
(публичная функция-член)
получает доступ к сохранённой ссылке
(публичная функция-член)
вызывает сохранённую функцию
(публичная функция-член)

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

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

Руководства по выводу (начиная с C++17)

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

определяет общий ссылочный тип для 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:
    // типы
    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>;

Пример

Демонстрирует использование 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

Смотрите также

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