Namensräume
Varianten
Aktionen

std::reference_wrapper

Von cppreference.com
< cpp‎ | utility‎ | functional
 
C++
 
Dienstprogramm-Bibliotheken
Sprachunterstützung
Typunterstützung (Basistypen, RTTI)
Bibliotheks-Feature-Test-Makros (C++20)
Programm-Dienstprogramme
Variadische Funktionen
(C++11)
(C++20)
(C++26)
(C++20)
Coroutine-Unterstützung (C++20)
Vertragsunterstützung (C++26)
Drei-Wege-Vergleich
(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)

Allgemeine Hilfsmittel
Relationale Operatoren (in C++20 veraltet)
 
Funktionsobjekte
Funktionsaufruf
(C++17)(C++23)
Identitätsfunktions-Objekt
(C++20)
Referenz-Wrapper
reference_wrapper
(C++11)
(C++11)(C++11)
(C++20)(C++20)
Transparente Operator-Wrapper
(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)

Alte Binder und Adaptoren
(bis C++17*)
(bis C++17*)
(bis C++17*)
(bis C++17*)
(bis C++17*)  
(bis C++17*)
(bis C++17*)(bis C++17*)(bis C++17*)(bis C++17*)
(bis C++20*)
(bis C++20*)
(bis C++17*)(bis C++17*)
(bis C++17*)(bis C++17*)

(bis C++17*)
(bis C++17*)(bis C++17*)(bis C++17*)(bis C++17*)
(bis C++20*)
(bis C++20*)
 
std::reference_wrapper
 
Definiert in der Header-Datei <functional>
template< class T >
class reference_wrapper;
 (seit C++11)

std::reference_wrapper ist eine Klassenvorlage, die eine Referenz in einem kopierbaren, zuweisbaren Objekt kapselt.

Speziell ist std::reference_wrapper ein CopyConstructible und CopyAssignable Wrapper um eine Referenz auf ein Objekt oder 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 in T& konvertierbar, so dass sie als Argumente mit Funktionen verwendet werden können, die den zugrundeliegenden Typ per Referenz entgegennehmen.

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

Hilfsfunktionen std::ref und std::cref werden oft 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 zur Speicherung von Referenzen in Standardcontainern (wie std::vector) verwendet werden, die normalerweise keine Referenzen speichern können.

std::reference_wrapper ist garantiert TriviallyCopyable.

 (seit C++17)

T kann ein unvollständiger Typ sein.

 (seit C++20)

Inhalt

[bearbeiten] Member types

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

[bearbeiten] Member functions

 speichert eine Referenz in einem neuen std::reference_wrapper-Objekt
(public member function) [bearbeiten]
 weist einen std::reference_wrapper neu zu
(public member function) [bearbeiten]
 greift auf die gespeicherte Referenz zu
(public member function) [bearbeiten]
 ruft die gespeicherte Funktion auf
(public member function) [bearbeiten]

[bearbeiten] Non-member functions

(C++26)
 vergleicht reference_wrapper-Objekte entsprechend ihrer gespeicherten Referenzen
(function) [bearbeiten]

[bearbeiten] Deduktionshilfen(seit C++17)

[bearbeiten] Helper classes

(C++23)
 ermittelt den gemeinsamen Referenztyp von reference_wrapper und Nicht-reference_wrapper
(class template specialization) [bearbeiten]

[bearbeiten] 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:
    // 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>;

[bearbeiten] Beispiel

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

Führen Sie diesen Code aus
#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

[bearbeiten] Siehe auch

(C++11)(C++11)
 erstellt einen std::reference_wrapper mit einem Typ, der aus seinem Argument abgeleitet wird
(Funktions-Template) [bearbeiten]
(C++11)
 bindet ein oder mehrere Argumente an ein Funktions-Objekt
(Funktions-Template) [bearbeiten]
(C++20)(C++20)
 holt den Referenztyp, der in std::reference_wrapper gekapselt ist
(Klassen-Template) [bearbeiten]
Abgerufen von "https://cppreference.de/mwiki/index.php?title=cpp/utility/functional/reference_wrapper&oldid=173390"