Namensräume
Varianten
Aktionen

std::result_of, std::invoke_result

Von cppreference.com
< cpp‎ | types
 
 
Metaprogrammierungsbibliothek
Typmerkmale
Typkategorien
(C++11)
(C++11)(DR*)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11) 
(C++11)
(C++11)
Typeneigenschaften
(C++11)
(C++11)
(C++14)
(C++11)(deprecated in C++26)
(C++11)(bis C++20*)
(C++11)(veraltet in C++20)
(C++11)
Typmerkmalskonstanten
Metafunktionen
(C++17)
Unterstützte Operationen
Beziehungen und Eigenschaftsabfragen
Typmodifikationen
(C++11)(C++11)(C++11)
Typentransformationen
(C++11)(veraltet in C++23)
(C++11)(veraltet in C++23)
(C++11)
result_ofinvoke_result
(C++11)(bis C++20*)(C++17)

(C++11)
(C++11)
(C++17)
Rationale Arithmetik zur Compilezeit
Ganzzahlsequenzen zur Compilezeit
 
Definiert in der Kopfdatei <type_traits>
template< class >

class result_of; // nicht definiert

template< class F, class... ArgTypes >

class result_of<F(ArgTypes...)>;
(1) (seit C++11)
(veraltet in C++17)
(in C++20 entfernt)
template< class F, class... ArgTypes >
class invoke_result;
(2) (seit C++17)

Leitet den Rückgabetypieineines INVOKE Ausdrucks zur Kompilierzeit ab.

F muss ein aufrufbarer Typ, ein Funktionsreferenztyp oder ein Referenztyp auf einen aufrufbaren Typ sein. Das Aufrufen von F mit ArgTypes... muss ein wohlgeformter Ausdruck sein.

(seit C++11)
(bis C++14)

F und alle Typen in ArgTypes können beliebige vollständige Typen, Arrays unbekannter Größe oder (möglicherweise cv-qualifizierte) void sein.

(seit C++14)

Wenn das Programm Spezialisierungen für eine der auf dieser Seite beschriebenen Vorlagen hinzufügt, ist das Verhalten undefiniert.

Inhalt

[bearbeiten] Member-Typen

Mitgliedertyp Definition
type Der Rückgabetypie des Callable-Typs F, wenn er mit den Argumenten ArgTypes... aufgerufen wird. Nur definiert, wenn F in einem nicht-auswertenden Kontext mit den Argumenten ArgTypes... aufgerufen werden kann.(seit C++14)

[bearbeiten] Hilfstypen

template< class T >
using result_of_t = typename result_of<T>::type;
(1) (seit C++14)
(veraltet in C++17)
(in C++20 entfernt)
template< class F, class... ArgTypes >
using invoke_result_t = typename invoke_result<F, ArgTypes...>::type;
(2) (seit C++17)

[bearbeiten] Mögliche Implementierung

namespace detail
{
    template<class T>
    struct is_reference_wrapper : std::false_type {};
    template<class U>
    struct is_reference_wrapper<std::reference_wrapper<U>> : std::true_type {};
 
    template<class T>
    struct invoke_impl
    {
        template<class F, class... Args>
        static auto call(F&& f, Args&&... args)
            -> decltype(std::forward<F>(f)(std::forward<Args>(args)...));
    };
 
    template<class B, class MT>
    struct invoke_impl<MT B::*>
    {
        template<class T, class Td = typename std::decay<T>::type,
            class = typename std::enable_if<std::is_base_of<B, Td>::value>::type>
        static auto get(T&& t) -> T&&;
 
        template<class T, class Td = typename std::decay<T>::type,
            class = typename std::enable_if<is_reference_wrapper<Td>::value>::type>
        static auto get(T&& t) -> decltype(t.get());
 
        template<class T, class Td = typename std::decay<T>::type,
            class = typename std::enable_if<!std::is_base_of<B, Td>::value>::type,
            class = typename std::enable_if<!is_reference_wrapper<Td>::value>::type>
        static auto get(T&& t) -> decltype(*std::forward<T>(t));
 
        template<class T, class... Args, class MT1,
            class = typename std::enable_if<std::is_function<MT1>::value>::type>
        static auto call(MT1 B::*pmf, T&& t, Args&&... args)
            -> decltype((invoke_impl::get(
                std::forward<T>(t)).*pmf)(std::forward<Args>(args)...));
 
        template<class T>
        static auto call(MT B::*pmd, T&& t)
            -> decltype(invoke_impl::get(std::forward<T>(t)).*pmd);
    };
 
    template<class F, class... Args, class Fd = typename std::decay<F>::type>
    auto INVOKE(F&& f, Args&&... args)
        -> decltype(invoke_impl<Fd>::call(std::forward<F>(f),
            std::forward<Args>(args)...));
} // namespace detail
 
// Minimal C++11 implementation:
template<class> struct result_of;
template<class F, class... ArgTypes>
struct result_of<F(ArgTypes...)>
{
    using type = decltype(detail::INVOKE(std::declval<F>(), std::declval<ArgTypes>()...));
};
 
// Conforming C++14 implementation (is also a valid C++11 implementation):
namespace detail
{
    template<typename AlwaysVoid, typename, typename...>
    struct invoke_result {};
    template<typename F, typename...Args>
    struct invoke_result<
        decltype(void(detail::INVOKE(std::declval<F>(), std::declval<Args>()...))),
            F, Args...>
    {
        using type = decltype(detail::INVOKE(std::declval<F>(), std::declval<Args>()...));
    };
} // namespace detail
 
template<class> struct result_of;
template<class F, class... ArgTypes>
struct result_of<F(ArgTypes...)> : detail::invoke_result<void, F, ArgTypes...> {};
 
template<class F, class... ArgTypes>
struct invoke_result : detail::invoke_result<void, F, ArgTypes...> {};

[bearbeiten] Hinweise

Wie in C++11 formuliert, ist das Verhalten von std::result_of undefiniert, wenn INVOKE(std::declval<F>(), std::declval<ArgTypes>()...) schlecht geformt ist (z.B. wenn F überhaupt kein aufrufbarer Typ ist). C++14 ändert dies zu einem SFINAE (wenn F nicht aufrufbar ist, hat std::result_of<F(ArgTypes...)> einfach kein type-Mitglied).

Die Motivation hinter std::result_of ist die Bestimmung des Ergebnisses des Aufrufs eines Callable, insbesondere wenn der Ergebnistyp für verschiedene Argumentmengen unterschiedlich ist.

F(Args...) ist ein Funktionstyp, wobei Args... die Argumenttypen und F der Rückgabetyp ist. Als solcher leidet std::result_of unter mehreren Eigenheiten, die zu seiner Deprekation zugunsten von std::invoke_result in C++17 führten.

  • F darf kein Funktionstyp oder Array-Typ sein (kann aber eine Referenz darauf sein);
  • wenn eines der Args den Typ "Array von T" oder einen Funktionstyp T hat, wird es automatisch zu T* angepasst;
  • weder F noch eines der Args... darf ein abstrakter Klassentyp sein;
  • wenn eines der Args... einen Top-Level-cv-Qualifizierer hat, wird dieser verworfen;
  • keines der Args... darf vom Typ void sein.

Um diese Eigenheiten zu vermeiden, wird result_of oft mit Referenztypen als F und Args... verwendet. Zum Beispiel

template<class F, class... Args>
std::result_of_t<F&&(Args&&...)> // instead of std::result_of_t<F(Args...)>, which is wrong
    my_invoke(F&& f, Args&&... args)
    {
        /* implementation */
    }

[bearbeiten] Hinweise

Feature-Test-Makro Wert Std Feature
__cpp_lib_result_of_sfinae 201210L (C++14) std::result_of und SFINAE
__cpp_lib_is_invocable 201703L (C++17) std::is_invocable, std::invoke_result

[bearbeiten] Beispiele

#include <iostream>
#include <type_traits>
 
struct S
{
    double operator()(char, int&);
    float operator()(int) { return 1.0; }
};
 
template<class T>
typename std::result_of<T(int)>::type f(T& t)
{
    std::cout << "overload of f for callable T\n";
    return t(0);
}
 
template<class T, class U>
int f(U u)
{
    std::cout << "overload of f for non-callable T\n";
    return u;
}
 
int main()
{
    // the result of invoking S with char and int& arguments is double
    std::result_of<S(char, int&)>::type d = 3.14; // d has type double
    static_assert(std::is_same<decltype(d), double>::value, "");
 
    // std::invoke_result uses different syntax (no parentheses)
    std::invoke_result<S,char,int&>::type b = 3.14;
    static_assert(std::is_same<decltype(b), double>::value, "");
 
    // the result of invoking S with int argument is float
    std::result_of<S(int)>::type x = 3.14; // x has type float
    static_assert(std::is_same<decltype(x), float>::value, "");
 
    // result_of can be used with a pointer to member function as follows
    struct C { double Func(char, int&); };
    std::result_of<decltype(&C::Func)(C, char, int&)>::type g = 3.14;
    static_assert(std::is_same<decltype(g), double>::value, "");
 
    f<C>(1); // may fail to compile in C++11; calls the non-callable overload in C++14
}

Ausgabe

overload of f for non-callable T

[bearbeiten] Siehe auch

(C++17)(C++23)
ruft jedes Callable-Objekt mit gegebenen Argumenten auf und der Möglichkeit, den Rückgabetyp anzugeben(seit C++23)
(Funktions-Template) [bearbeiten]
prüft, ob ein Typ mit den gegebenen Argumenttypen aufgerufen werden kann (als ob durch std::invoke)
(Klassenvorlage) [bearbeiten]
(C++11)
erhält eine Referenz auf ein Objekt des Typ-Template-Arguments zur Verwendung in einem nicht-ausgewerteten Kontext
(Funktionsvorlage) [edit]