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* )
Definiert im Header <functional>
template < class T >
class reference_wrapper ;
(seit C++11)

std::reference_wrapper ist eine Klassenvorlage, die eine Referenz in ein kopierbares, zuweisbares Objekt einpackt.

Insbesondere ist std::reference_wrapper ein CopyConstructible und CopyAssignable Wrapper um eine Referenz auf ein Objekt oder eine Referenz auf eine Funktion vom Typ T . Instanzen von std::reference_wrapper sind Objekte (sie können kopiert oder in Containern gespeichert werden), aber sie sind implizit konvertierbar zu T & , sodass sie als Argumente mit Funktionen verwendet werden können, die den zugrundeliegenden Typ per Referenz annehmen.

Wenn die gespeicherte Referenz Callable ist, ist std::reference_wrapper mit denselben Argumenten aufrufbar.

Hilfsfunktionen std::ref und std::cref werden häufig verwendet, um std::reference_wrapper Objekte zu erzeugen.

std::reference_wrapper wird verwendet, um Objekte per Referenz an std::bind , den Konstruktor von std::thread oder die Hilfsfunktionen std::make_pair und std::make_tuple zu übergeben. Es kann auch als Mechanismus verwendet werden, um Referenzen in Standardcontainern (wie std::vector ) zu speichern, die normalerweise keine Referenzen halten können.

std::reference_wrapper ist garantiert TriviallyCopyable .

(seit C++17)

T kann ein unvollständiger Typ sein.

(seit C++20)

Inhaltsverzeichnis

Mitgliedertypen

Typ Definition
type T
result_type
(in C++17 veraltet)
(in C++20 entfernt)
Der Rückgabetyp von T , falls T eine Funktion ist. Andernfalls nicht definiert.
argument_type
(in C++17 veraltet)
(in C++20 entfernt)
  • falls T eine Funktion oder ein Funktionszeiger ist, die/der ein Argument vom Typ A1 akzeptiert, dann ist argument_type gleich A1
  • falls T ein Zeiger auf eine Memberfunktion der Klasse T0 ist, die keine Argumente akzeptiert, dann ist argument_type gleich T0 * , möglicherweise cv-qualifiziert
  • falls T ein Klassentyp mit einem Membertyp T :: argument_type ist, dann ist argument_type ein Alias davon
first_argument_type
(in C++17 veraltet)
(in C++20 entfernt)
  • falls T eine Funktion oder ein Funktionszeiger ist, die/der zwei Argumente der Typen A1 und A2 akzeptiert, dann ist first_argument_type gleich A1
  • falls T ein Zeiger auf eine Memberfunktion der Klasse T0 ist, die ein Argument akzeptiert, dann ist first_argument_type gleich T0 * , möglicherweise cv-qualifiziert
  • falls T ein Klassentyp mit einem Membertyp T :: first_argument_type ist, dann ist first_argument_type ein Alias davon
second_argument_type
(in C++17 veraltet)
(in C++20 entfernt)
  • falls T eine Funktion oder ein Funktionszeiger ist, die/der zwei Argumente der Typen A1 und A2 akzeptiert, dann ist second_argument_type gleich A2
  • falls T ein Zeiger auf eine Memberfunktion der Klasse T0 ist, die ein Argument A1 akzeptiert, dann ist second_argument_type gleich A1 , möglicherweise cv-qualifiziert
  • falls T ein Klassentyp mit einem Membertyp T :: second_argument_type ist, dann ist second_argument_type ein Alias davon

Memberfunktionen

speichert eine Referenz in einem neuen std::reference_wrapper Objekt
(öffentliche Elementfunktion)
bindet einen std::reference_wrapper neu
(öffentliche Elementfunktion)
greift auf die gespeicherte Referenz zu
(öffentliche Elementfunktion)
ruft die gespeicherte Funktion auf
(öffentliche Elementfunktion)

Nicht-Member-Funktionen

vergleicht reference_wrapper -Objekte als ihre gespeicherten Referenzen
(Funktion)

Deduktionsleitfäden (seit C++17)

Hilfsklassen

bestimmt den gemeinsamen Referenztyp von reference_wrapper und Nicht- reference_wrapper
(Klassentemplate-Spezialisierung)

Mögliche Implementierung

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:
    // Typen
    using type = T;
    // Konstruktion/Kopieren/Zerstörung
    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;
    // Zuweisung
    reference_wrapper& operator=(const reference_wrapper& x) noexcept = default;
    // Zugriff
    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;
};
// Ableitungsanleitungen
template<class T>
reference_wrapper(T&) -> reference_wrapper<T>;

Beispiel

Demonstriert die Verwendung von std::reference_wrapper als Container von Referenzen, was den Zugriff auf denselben Container über mehrere Indizes ermöglicht.

#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);
}

Mögliche Ausgabe:

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

Siehe auch

(C++11) (C++11)
erstellt einen std::reference_wrapper mit einem von seinem Argument abgeleiteten Typ
(Funktions-Template)
(C++11)
bindet ein oder mehrere Argumente an ein Funktionsobjekt
(Funktions-Template)
ermittelt den in std::reference_wrapper eingepackten Referenztyp
(Klassen-Template)