std::function

 

C++

Compiler-Unterstützung

Freestanding und gehostet

Sprache

Standardbibliothek

Header der Standardbibliothek

Benannte Anforderungen

Feature-Test-Makros (C++20)

Bibliothek für Sprachunterstützung

Konzepte-Bibliothek (C++20)

Diagnostik-Bibliothek

Speicherverwaltungsbibliothek

Metaprogrammierungsbibliothek (C++11)

Allgemeine Dienstprogramme-Bibliothek

Container-Bibliothek

Iterator-Bibliothek

Ranges-Bibliothek (C++20)

Algorithmen-Bibliothek

Bibliothek für Zeichenketten

Textverarbeitungsbibliothek

Numerik-Bibliothek

Datums- und Zeitbibliothek

Ein-/Ausgabe-Bibliothek

Dateisystembibliothek (C++17)

Unterstützung für nebenläufige Programmierung (C++11)

Ausführungssteuerungsbibliothek (C++26)

Technische Spezifikationen

Symbolverzeichnis

Externe Bibliotheken

 

Dienstprogramm-Bibliotheken

Sprachunterstützung Typunterstützung (Basistypen, RTTI) Bibliotheks-Feature-Test-Makros (C++20) Programm-Dienstprogramme Variadische Funktionen initializer_list (C++11) is_constant_evaluated (C++20) is_within_lifetime (C++26) source_location (C++20) Coroutine-Unterstützung (C++20) Vertragsunterstützung (C++26) Drei-Wege-Vergleich three_way_comparablethree_way_comparable_with (C++20)(C++20) strong_ordering (C++20) weak_ordering (C++20) partial_ordering (C++20) common_comparison_category (C++20) compare_three_way_result (C++20) compare_three_way (C++20) strong_order (C++20) weak_order (C++20) partial_order (C++20) compare_strong_order_fallback (C++20) compare_weak_order_fallback (C++20) compare_partial_order_fallback (C++20)   is_eqis_ltis_lteq (C++20)(C++20)(C++20)   is_neqis_gtis_gteq (C++20)(C++20)(C++20)

Allgemeine Hilfsmittel Funktionsobjekte Bit-Manipulation (C++20) bitset hash (C++11) Relationale Operatoren (in C++20 veraltet) rel_ops::operator!=rel_ops::operator>    rel_ops::operator<=rel_ops::operator>= Ganzzahl-Vergleichsfunktionen cmp_equalcmp_lesscmp_less_than (C++20)(C++20)(C++20)   cmp_not_equalcmp_greatercmp_greater_than (C++20)(C++20)(C++20) in_range (C++20) Swap und Typ-Operationen swap ranges::swap (C++20) exchange (C++14) declval (C++11) to_underlying (C++23) forward (C++11) forward_like (C++23) move (C++11) move_if_noexcept (C++11) as_const (C++17) Gemeinsame Vokabulartypen pair tuple (C++11) optional (C++17) any (C++17) variant (C++17) tuple_size (C++11) tuple_element (C++11) apply (C++17) make_from_tuple (C++17) expected (C++23)

 

Funktionsobjekte

Funktions-Wrapper Funktion (C++11) move_only_function (C++23) copyable_function (C++26) function_ref (C++26) mem_fn (C++11) bad_function_call (C++11)	Partielle Funktionsanwendung bind_frontbind_back (C++20)(C++23) bind (C++11) is_bind_expression (C++11) is_placeholder (C++11) _1, _2, _3, ... (C++11)
Funktionsaufruf invokeinvoke_r (C++17)(C++23) Identitätsfunktions-Objekt identity (C++20)	Referenz-Wrapper reference_wrapper (C++11) refcref (C++11)(C++11) unwrap_referenceunwrap_ref_decay (C++20)(C++20)
Operator-Wrapper plus minus negate multiplies divides modulus bit_and bit_or bit_not (C++14)   bit_xor equal_to not_equal_to greater less greater_equal less_equal logical_and logical_or logical_not	Transparente Operator-Wrapper plus<> (C++14) minus<> (C++14) negate<> (C++14) multiplies<> (C++14)   divides<> (C++14) modulus<> (C++14) bit_and<> (C++14) bit_or<> (C++14) bit_not<> (C++14) bit_xor<> (C++14) equal_to<> (C++14) not_equal_to<> (C++14) greater<> (C++14) less<> (C++14) greater_equal<> (C++14) less_equal<> (C++14) logical_and<> (C++14) logical_or<> (C++14) logical_not<> (C++14)
Negatoren not_fn (C++17) Sucher default_searcher (C++17) boyer_moore_searcher (C++17) boyer_moore_horspool_searcher (C++17)	Beschränkte Komparatoren ranges::equal_to (C++20) ranges::not_equal_to (C++20) ranges::greater (C++20) ranges::less (C++20) ranges::greater_equal (C++20) ranges::less_equal (C++20) compare_three_way (C++20)
Alte Binder und Adaptoren
unary_function (bis C++17*) binary_function (bis C++17*) ptr_fun (bis C++17*) pointer_to_unary_function (bis C++17*) pointer_to_binary_function (bis C++17*)   mem_fun (bis C++17*) mem_fun_tmem_fun1_tconst_mem_fun_tconst_mem_fun1_t (bis C++17*)(bis C++17*)(bis C++17*)(bis C++17*) not1 (bis C++20*) not2 (bis C++20*)	binder1stbinder2nd (bis C++17*)(bis C++17*) bind1stbind2nd (bis C++17*)(bis C++17*) mem_fun_ref (bis C++17*) mem_fun_ref_tmem_fun1_ref_tconst_mem_fun_ref_tconst_mem_fun1_ref_t (bis C++17*)(bis C++17*)(bis C++17*)(bis C++17*) unary_negate (bis C++20*) binary_negate (bis C++20*)

 

std::function

Memberfunktionen

function::function

function::~function

function::operator=

function::swap

function::assign (bis C++17)

function::operator bool

function::operator()

function::target_type

function::target

Nicht-Member-Funktionen

operator==operator!= (bis C++20)

swap(std::function)

Hilfsklassen

uses_allocator<std::function> (bis C++17)

Deduction guides(C++17)

 

Definiert in der Header-Datei <functional>
template< class > class function; /* undefined */		(seit C++11)
template< class R, class... Args > class function<R(Args...)>;		(seit C++11)

Die Klassen-Template std::function ist ein allgemeiner polymorpher Funktions-Wrapper. Instanzen von std::function können jeden CopyConstructible und Callable Ziel speichern, kopieren und aufrufen -- Funktionen (über Zeiger darauf), Lambda-Ausdrücke, Bind-Ausdrücke oder andere Funktions-Objekte, sowie Zeiger auf Memberfunktionen und Zeiger auf Datenmember.

Das gespeicherte aufrufbare Objekt wird als Ziel von std::function bezeichnet. Wenn ein std::function kein Ziel enthält, wird es als leer bezeichnet. Der Aufruf des Ziels eines leeren std::function führt zum Auslösen einer std::bad_function_call Ausnahme.

std::function erfüllt die Anforderungen von CopyConstructible und CopyAssignable.

Member types

Typ	Definition
result_type	R
argument_type (deprecated in C++17)(removed in C++20)	T, falls sizeof...(Args)==1 und T der erste und einzige Typ in Args... ist
first_argument_type (deprecated in C++17)(removed in C++20)	T1, falls sizeof...(Args)==2 und T1 der erste der beiden Typen in Args... ist
second_argument_type (deprecated in C++17)(removed in C++20)	T2, falls sizeof...(Args)==2 und T2 der zweite der beiden Typen in Args... ist

Member functions

(Konstruktor)	konstruiert eine neue std::function Instanz (public member function)
(Destruktor)	zerstört eine std::function Instanz (public member function)
operator=	weist ein neues Ziel zu (public member function)
swap	tauscht die Inhalte (public member function)
assign (removed in C++17)	weist ein neues Ziel zu (public member function)
operator bool	prüft, ob ein Ziel enthalten ist (public member function)
operator()	ruft das Ziel auf (public member function)
Zielzugriff
target_type	gibt den typeid des gespeicherten Ziels zurück (public member function)
target	gibt einen Zeiger auf das gespeicherte Ziel zurück (public member function)

Non-member functions

std::swap(std::function) (C++11)	spezialisiert den Algorithmus std::swap (function template)
operator==operator!= (in C++20 entfernt)	vergleicht ein std::function mit nullptr (function template)

Helper classes

std::uses_allocator<std::function> (C++11) (bis C++17)

spezialisiert das std::uses_allocator Typ-Trait (class template specialization)

Notes

Vorsicht ist geboten, wenn ein std::function, dessen Ergebnistyp eine Referenz ist, aus einem Lambda-Ausdruck ohne nachfolgenden Rückgabetyp initialisiert wird. Aufgrund der Art und Weise, wie die Auto-Deduktion funktioniert, gibt ein solcher Lambda-Ausdruck immer ein prvalue zurück. Daher wird sich die resultierende Referenz normalerweise an ein temporäres Objekt binden, dessen Lebensdauer endet, wenn std::function::operator() zurückkehrt.

(bis C++23)

Wenn ein std::function, das eine Referenz zurückgibt, aus einer Funktion oder einem Funktions-Objekt initialisiert wird, das ein prvalue zurückgibt (einschließlich eines Lambda-Ausdrucks ohne nachfolgenden Rückgabetyp), ist das Programm ill-formed, da die Bindung der zurückgegebenen Referenz an ein temporäres Objekt verboten ist.

(seit C++23)

std::function<const int&()> F([] { return 42; }); // Error since C++23: can't bind
                                                  // the returned reference to a temporary
int x = F(); // Undefined behavior until C++23: the result of F() is a dangling reference
 
std::function<int&()> G([]() -> int& { static int i{0x2A}; return i; }); // OK
 
std::function<const int&()> H([i{052}] -> const int& { return i; }); // OK

Example

Führen Sie diesen Code aus

#include <functional>
#include <iostream>
 
struct Foo
{
    Foo(int num) : num_(num) {}
    void print_add(int i) const { std::cout << num_ + i << '\n'; }
    int num_;
};
 
void print_num(int i)
{
    std::cout << i << '\n';
}
 
struct PrintNum
{
    void operator()(int i) const
    {
        std::cout << i << '\n';
    }
};
 
int main()
{
    // store a free function
    std::function<void(int)> f_display = print_num;
    f_display(-9);
 
    // store a lambda
    std::function<void()> f_display_42 = []() { print_num(42); };
    f_display_42();
 
    // store the result of a call to std::bind
    std::function<void()> f_display_31337 = std::bind(print_num, 31337);
    f_display_31337();
 
    // store a call to a member function
    std::function<void(const Foo&, int)> f_add_display = &Foo::print_add;
    const Foo foo(314159);
    f_add_display(foo, 1);
    f_add_display(314159, 1);
 
    // store a call to a data member accessor
    std::function<int(Foo const&)> f_num = &Foo::num_;
    std::cout << "num_: " << f_num(foo) << '\n';
 
    // store a call to a member function and object
    using std::placeholders::_1;
    std::function<void(int)> f_add_display2 = std::bind(&Foo::print_add, foo, _1);
    f_add_display2(2);
 
    // store a call to a member function and object ptr
    std::function<void(int)> f_add_display3 = std::bind(&Foo::print_add, &foo, _1);
    f_add_display3(3);
 
    // store a call to a function object
    std::function<void(int)> f_display_obj = PrintNum();
    f_display_obj(18);
 
    auto factorial = [](int n)
    {
        // store a lambda object to emulate "recursive lambda"; aware of extra overhead
        std::function<int(int)> fac = [&](int n) { return (n < 2) ? 1 : n * fac(n - 1); };
        // note that "auto fac = [&](int n) {...};" does not work in recursive calls
        return fac(n);
    };
    for (int i{5}; i != 8; ++i)
        std::cout << i << "! = " << factorial(i) << ";  ";
    std::cout << '\n';
}

Mögliche Ausgabe

-9
42
31337
314160
314160
num_: 314159
314161
314162
18
5! = 120;  6! = 720;  7! = 5040;

See also

move_only_function (C++23)	Move-only-Wrapper für jedes aufrufbare Objekt, das Qualifizierer in einer gegebenen Aufrufsignatur unterstützt (Klassen-Template)
copyable_function (C++26)	kopierfähiger Wrapper für jedes kopierkonstruierbare aufrufbare Objekt, das Qualifizierer in einer gegebenen Aufrufsignatur unterstützt (Klassen-Template)
function_ref (C++26)	nicht-besitzender Wrapper für jedes aufrufbare Objekt (Klassen-Template)
bad_function_call (C++11)	die Ausnahme, die beim Aufrufen eines leeren std::function ausgelöst wird (Klasse)
mem_fn (C++11)	erstellt ein Funktions-Objekt aus einem Zeiger auf ein Member (Funktions-Template)
typeid	fragt Informationen über einen Typ ab und gibt ein std::type_info-Objekt zurück, das den Typ repräsentiert