Пространства имён
Варианты
Действия

std::reference_wrapper

Материал из cppreference.com
< cpp‎ | utility‎ | functional
 
C++
Поддержка компилятором
Автономные и размещённые реализации
Язык
Стандартная библиотека
Заголовки стандартной библиотеки
Требования к именованию
Макросы тестирования функциональности (C++20)
Поддержка языка
Библиотека концептов (C++20)
Библиотека метапрограммирования (C++11)
Библиотека диагностики
Библиотека общих утилит
Библиотека строк
Библиотека контейнеров
Библиотека итераторов
Библиотека диапазонов (C++20)
Библиотека алгоритмов
Библиотека численных данных
Библиотека ввода/вывода
Библиотека локализаций
Регулярные выражения (C++11)
Атомарные операции (C++11)
Библиотека поддержки конкуренции (C++11)
Библиотека файловой системы (C++17)
Технические спецификации
Указатель символов
Внешние библиотеки
 
Библиотека утилит
Языковая поддержка
Поддержка типов (базовые типы, RTTI)
Макросы тестирования функциональности библиотеки (C++20)    
Управление динамической памятью
Программные утилиты
Поддержка сопрограмм (C++20)
Вариативные функции
(C++20)
(C++26)
(C++11)
(C++20)
Трёхстороннее сравнение (C++20)
(C++20)(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)    
(C++20)(C++20)(C++20)(C++20)(C++20)(C++20)
Общие утилиты
Дата и время
Функциональные объекты
Библиотека форматирования (C++20)
(C++11)
Операторы отношения (устарело в C++20)
Целочисленные функции сравнения
(C++20)(C++20)(C++20)    
(C++20)
Операции обмена и типа
(C++20)
(C++14)
(C++11)
(C++23)
(C++11)
(C++23)
(C++11)
(C++11)
(C++17)
Общие лексические типы
(C++11)
(C++17)
(C++17)
(C++17)
(C++11)
(C++11)
(C++17)
(C++17)
(C++23)
Элементарные преобразования строк
(C++17)
(C++17)
(C++17)
 
Объекты функции
Функции обёртки
(C++11)
(C++23)
(C++26)
(C++26)
(C++11)
(C++11)
Применение частичных функций
(C++20)(C++23)
(C++11)
(C++11)
(C++11)
(C++11)
Вызов функции
(C++17)(C++23)
Объект идентичности функции
(C++20)
Обёртки ссылок
reference_wrapper
(C++11)
(C++11)(C++11)
(C++20)(C++20)
Прозрачные обёртки операторов
(C++14)
(C++14)
(C++14)
(C++14)  
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)
(C++14)

Отрицатели
(C++17)
Искатели
(C++17)
(C++17)
(C++17)    
Ограниченные компараторы
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
(C++20)
Старые привязки и адаптеры
(до C++17*)
(до C++17*)
(до C++17*)
(до C++17*)
(до C++17*)
(до C++17*)
(до C++17*)(до C++17*)(до C++17*)(до C++17*)
(до C++20*)
(до C++20*)
(до C++17*)(до C++17*)
(до C++17*)(до C++17*)

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

std::reference_wrapper это шаблонный класс, который заключает ссылку в копируемый присваиваемый объект. Он часто используется как механизм для хранения ссылок внутри стандартных контейнеров (таких как std::vector), которые обычно не могут содержать ссылки.

В частности, 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::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
Оригинал:
stores a reference in a new std::reference_wrapper object
Текст был переведён автоматически используя Переводчик Google.
Вы можете проверить и исправить перевод. Для инструкций щёлкните сюда.

(public функция-элемент) [править]
повторная привязка std::reference_wrapper
Оригинал:
rebinds a std::reference_wrapper
Текст был переведён автоматически используя Переводчик Google.
Вы можете проверить и исправить перевод. Для инструкций щёлкните сюда.

(public функция-элемент) [править]
доступ к сохраненной ссылке
Оригинал:
accesses the stored reference
Текст был переведён автоматически используя Переводчик Google.
Вы можете проверить и исправить перевод. Для инструкций щёлкните сюда.

(public функция-элемент) [править]
вызывает сохранённую функцию
(public функция-элемент) [править]

[править] Принципы вывода(начиная с 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>;

[править] Пример

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

Запустить этот код
#include <algorithm>
#include <functional>
#include <iostream>
#include <list>
#include <numeric>
#include <random>
#include <vector>
 
void print(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);
 
    // не может использовать перемешивание в списке (требуется произвольный доступ),
    // но может использовать его в векторе
    std::vector<std::reference_wrapper<int>> v(l.begin(), l.end());
 
    std::ranges::shuffle(v, std::mt19937{std::random_device{}()});
 
    print("Содержимое списка: ", l);
    print("Содержимое списка, как видно через перемешанный вектор: ", v);
 
    std::cout << "Удвоение значений в исходном списке...\n";
    std::ranges::for_each(l, [](int& i) { i *= 2; });
 
    print("Содержимое списка, как видно через перемешанный вектор: ", v);
}

Возможный вывод: 

Содержимое списка: -4 -3 -2 -1 0 1 2 3 4 5
Содержимое списка, как видно через перемешанный вектор: -1 2 -2 1 5 0 3 -3 -4 4
Удвоение значений в исходном списке...
Содержимое списка, как видно через перемешанный вектор: -2 4 -4 2 10 0 6 -6 -8 8

[править] Смотрите также

(C++11)(C++11)
 создаёт std::reference_wrapper с типом, выведенным из его аргумента
(шаблон функции) [править]
(C++11)
 связывает один или несколько аргументов с объектом функцией
(шаблон функции) [править]
(C++20)(C++20)
 получает ссылочный тип, заключённый в std::reference_wrapper
(шаблон класса) [править]
Источник — «https://ru.cppreference.com/mwiki/index.php?title=cpp/utility/functional/reference_wrapper&oldid=58705»