std::invoke, std::invoke_r

ヘッダ `<functional>`
template< class F, class... Args > std::invoke_result_t<F, Args...> invoke( F&& f, Args&&... args ) noexcept(/* see below */);	で定義 (1)	(C++17以上) (C++20以降constexpr)
template< class R, class F, class... Args > constexpr R invoke_r( F&& f, Args&&... args ) noexcept(/* see below */);	(2)	(C++23以上)

1) Callable オブジェクト f をパラメータ args で INVOKE(std::forward<F>(f), std::forward<Args>(args)...) のように呼び出します。このオーバーロードは、std::is_invocable_v<F, Args...> が true である場合にのみオーバーロード解決に参加します。

2) Callable オブジェクト f をパラメータ args で INVOKE<R>(std::forward<F>(f), std::forward<Args>(args)...) のように呼び出します。このオーバーロードは、std::is_invocable_r_v<R, F, Args...> が true である場合にのみオーバーロード解決に参加します。

パラメータ

f	-	Callable 呼び出されるCallableオブジェクト
args	-	f に渡す引数

戻り値

1) f によって返される値。

2)

が（ cv修飾された可能性のある） void でない場合、 f によって返される値は、

に暗黙的に変換される。それ以外の場合はなし。

例外

1)

noexcept 指定子:

noexcept ( std:: is_nothrow_invocable_v < F, Args... > )

2)

noexcept noexcept指定:

noexcept ( std:: is_nothrow_invocable_r_v < R, F, Args... > )

実装例

invoke (1)

namespace detail
{
    template<class>
    constexpr bool is_reference_wrapper_v = false;
    template<class U>
    constexpr bool is_reference_wrapper_v<std::reference_wrapper<U>> = true;
    template<class T>
    using remove_cvref_t = std::remove_cv_t<std::remove_reference_t<T>>;
    template<class C, class Pointed, class Object, class... Args>
    constexpr decltype(auto) invoke_memptr(Pointed C::* member, Object&& object,
                                           Args&&... args)
    {
        using object_t = remove_cvref_t<Object>;
        constexpr bool is_member_function = std::is_function_v<Pointed>;
        constexpr bool is_wrapped = is_reference_wrapper_v<object_t>;
        constexpr bool is_derived_object = std::is_same_v<C, object_t>
                                        || std::is_base_of_v<C, object_t>;
        if constexpr (is_member_function)
        {
            if constexpr (is_derived_object)
                return (std::forward<Object>(object) .* member)
                           (std::forward<Args>(args)...);
            else if constexpr (is_wrapped)
                return (object.get() .* member)(std::forward<Args>(args)...);
            else
                return ((*std::forward<Object>(object)) .* member)
                           (std::forward<Args>(args)...);
        }
        else
        {
            static_assert(std::is_object_v<Pointed> && sizeof...(args) == 0);
            if constexpr (is_derived_object)
                return std::forward<Object>(object) .* member;
            else if constexpr (is_wrapped)
                return object.get() .* member;
            else
                return (*std::forward<Object>(object)) .* member;
        }
    }
} // namespace detail
template<class F, class... Args>
constexpr std::invoke_result_t<F, Args...> invoke(F&& f, Args&&... args)
    noexcept(std::is_nothrow_invocable_v<F, Args...>)
{
    if constexpr (std::is_member_pointer_v<detail::remove_cvref_t<F>>)
        return detail::invoke_memptr(f, std::forward<Args>(args)...);
    else
        return std::forward<F>(f)(std::forward<Args>(args)...);
}

invoke_r (2)

template<class R, class F, class... Args>
    requires std::is_invocable_r_v<R, F, Args...>
constexpr R invoke_r(F&& f, Args&&... args)
    noexcept(std::is_nothrow_invocable_r_v<R, F, Args...>)
{
    if constexpr (std::is_void_v<R>)
        std::invoke(std::forward<F>(f), std::forward<Args>(args)...);
    else
        return std::invoke(std::forward<F>(f), std::forward<Args>(args)...);
}

注記

機能テストマクロ	値	標準	機能
`__cpp_lib_invoke`	`201411L`	(C++17)	`std::invoke` , ( 1 )
`__cpp_lib_invoke_r`	`202106L`	(C++23)	`std::invoke_r` , ( 2 )

例

このコードを実行

#include <functional>
#include <iostream>
#include <type_traits>
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()
{
    std::cout << "invoke a free function: ";
    std::invoke(print_num, -9);
    std::cout << "invoke a lambda: ";
    std::invoke([](){ print_num(42); });
    std::cout << "invoke a member function: ";
    const Foo foo(314159);
    std::invoke(&Foo::print_add, foo, 1);
    std::cout << "invoke (i.e., access) a data member num_: "
              << std::invoke(&Foo::num_, foo) << '\n';
    std::cout << "invoke a function object: ";
    std::invoke(PrintNum(), 18);
#if defined(__cpp_lib_invoke_r)
    auto add = [](int x, int y){ return x + y; };
    std::cout << "invoke a lambda converting result to float: ";
    auto ret = std::invoke_r<float>(add, 11, 22);
    static_assert(std::is_same<decltype(ret), float>());
    std::cout << std::fixed << ret << "\ninvoke print_num: ";
    std::invoke_r<void>(print_num, 44);
#endif
}

出力例:

invoke a free function: -9
invoke a lambda: 42
invoke a member function: 314160
invoke (i.e., access) a data member num_: 314159
invoke a function object: 18
invoke a lambda converting result to float: 33.000000
invoke print_num: 44

コンパイラサポート
フリースタンディングとホスト環境
言語
標準ライブラリ
標準ライブラリヘッダ
名前付き要件
機能テストマクロ (C++20)
言語サポートライブラリ
コンセプトライブラリ (C++20)
診断ライブラリ
メモリ管理ライブラリ
メタプログラミングライブラリ (C++11)
汎用ユーティリティライブラリ
コンテナライブラリ
イテレータライブラリ
レンジライブラリ (C++20)
アルゴリズムライブラリ
文字列ライブラリ
テキスト処理ライブラリ
数値ライブラリ
日付と時間ライブラリ
入出力ライブラリ
ファイルシステムライブラリ (C++17)
並行処理サポートライブラリ (C++11)
実行制御ライブラリ (C++26)
技術仕様書
シンボルインデックス
外部ライブラリ

mem_fn (C++11)	メンバへのポインタから関数オブジェクトを作成する (関数テンプレート)
result_of invoke_result (C++11) (C++20で削除) (C++17)	呼び出し可能オブジェクトを引数セットで呼び出した結果の型を推論する (クラステンプレート)
is_invocable is_invocable_r is_nothrow_invocable is_nothrow_invocable_r (C++17)	型が指定された引数型で呼び出し可能かどうかをチェックする（ std::invoke によって呼び出されるかのように） (クラステンプレート)
apply (C++17)	引数のタプルで関数を呼び出す (関数テンプレート)

ja.cppreference.net

Namespaces

Variants

std::invoke, std::invoke_r

目次

パラメータ

戻り値

例外

実装例

注記

例

関連項目