std::invoke, std::invoke_r
From cppreference.com
< cpp | utility | functional
| ヘッダ <functional> で定義 |
||
template< class F, class... Args > std::invoke_result_t<F, Args...> |
(1) | (C++17以降) (C++20 以降 constexpr) |
template< class R, class F, class... Args > constexpr R |
(2) | (C++23から) |
1) f をパラメータ args を伴う Callable オブジェクトとして、
INVOKE(std::forward<F>(f), std::forward<Args>(args)...) で呼び出す。このオーバーロードは、std::is_invocable_v<F, Args...> が true の場合にのみオーバーロード解決に参加する。2) f をパラメータ args を伴う Callable オブジェクトとして、
INVOKE<R>(std::forward<F>(f), std::forward<Args>(args)...) で呼び出す。このオーバーロードは、std::is_invocable_r_v<R, F, Args...> が true の場合にのみオーバーロード解決に参加する。目次 |
[編集] パラメータ
| f | - | 呼び出される Callable オブジェクト |
| args | - | f に渡す引数 |
[編集] 戻り値
1) f によって返される値。
[編集] 例外
1)
noexcept 指定:
noexcept(std::is_nothrow_invocable_v<F, Args...>)
2)
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++11) |
メンバへのポインタから関数オブジェクトを生成する (関数テンプレート) |
| (C++11)(C++20で削除)(C++17) |
呼び出し可能オブジェクトを引数のセットで呼び出した結果の型を推論する (クラステンプレート) |
| 与えられた引数型で型が呼び出し可能であるか (std::invoke のように) チェックする (クラステンプレート) | |
| (C++17) |
引数のタプルを使って関数を呼び出す (関数テンプレート) |
