std::apply

 

C++

编译器支持

自立实现与有宿主实现

语言

标准库

标准库标头

具名要求

功能特性测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

并发支持库 (C++11)

技术规范

符号索引

外部库

 

工具库

语言支持 类型支持（基本类型、 RTTI） 库功能特性测试宏 (C++20) 动态内存管理 程序工具 协程支持 (C++20) 变参数函数 is_constant_evaluated (C++20) is_within_lifetime (C++26) initializer_list (C++11) source_location (C++20) 三路比较 (C++20) 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_neqis_ltis_lteqis_gtis_gteq (C++20)(C++20)(C++20)(C++20)(C++20)(C++20)

通用工具 日期和时间 函数对象 格式化库 (C++20) bitset hash (C++11) 关系运算符 (C++20 中弃用) rel_ops::operator!=rel_ops::operator> rel_ops::operator<=rel_ops::operator>= 整数比较函数 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 与类型运算 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) 常用词汇类型 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) 初等字符串转换 to_chars (C++17) from_chars (C++17) chars_format (C++17) to_chars_result (C++17) from_chars_result (C++17)

 

在标头 <tuple> 定义
template< class F, class Tuple > constexpr decltype(auto) apply( F&& f, Tuple&& t );		(C++17 起) (C++23 前)
template< class F, tuple-like Tuple > constexpr decltype(auto) apply( F&& f, Tuple&& t ) noexcept(/* 见下文 */);		(C++23 起)

以元组 t 的元素作为参数调用可调用 (Callable) 对象 f。

给定定义如下的仅用于阐述的函数 apply-impl： template<class F, tuple-like Tuple, std::size_t... I> // C++23 前没有约束 Tuple
constexpr decltype(auto)
    apply-impl(F&& f, Tuple&& t, std::index_sequence<I...>) // 仅用于阐述
{
    return INVOKE(std::forward<F>(f), std::get<I>(std::forward<Tuple>(t))...);
}

效果等价于 return apply-impl(std::forward<F>(f), std::forward<Tuple>(t),
                  std::make_index_sequence<
                      std::tuple_size_v<std::decay_t<Tuple>>>{}); .

参数

f	-	要调用的可调用 (Callable) 对象
t	-	将元素作为 f 的参数的元组

返回值

f 所返回的值。

Exceptions

(无)	(C++23 前)
noexcept 说明：   noexcept(     noexcept(std::invoke(std::forward<F>(f),                          std::get<Is>(std::forward<Tuple>(t))...)) ) 其中 Is... 表示参数包： 0, 1, ..., std::tuple_size_v<std::remove_reference_t<Tuple>> - 1.	(C++23 起)

注解

Tuple 不必是 std::tuple，它可以被任何支持 std::get 和 std::tuple_size 的类型替代；特别是可以用 std::array 和 std::pair。	(C++23 前)
Tuple 被约束为元组式类型，即其中每个类型都必须是 std::tuple 的特化，或者实现了 tuple-like 的其他任何类型（例如 std::array 和 std::pair）。	(C++23 起)

功能特性测试宏	值	标准	备注
__cpp_lib_apply	201603L	(C++17)	std::apply

示例

运行此代码

#include <iostream>
#include <tuple>
#include <utility>
 
int add(int first, int second) { return first + second; }
 
template<typename T>
T add_generic(T first, T second) { return first + second; }
 
auto add_lambda = [](auto first, auto second) { return first + second; };
 
template<typename... Ts>
std::ostream& operator<<(std::ostream& os, std::tuple<Ts...> const& theTuple)
{
    std::apply
    (
        [&os](Ts const&... tupleArgs)
        {
            os << '[';
            std::size_t n{0};
            ((os << tupleArgs << (++n != sizeof...(Ts) ? ", " : "")), ...);
            os << ']';
        }, theTuple
    );
    return os;
}
 
int main()
{
    // OK
    std::cout << std::apply(add, std::pair(1, 2)) << '\n';
 
    // 错误：无法推导函数类型
    // std::cout << std::apply(add_generic, std::make_pair(2.0f, 3.0f)) << '\n'; 
 
    // OK
    std::cout << std::apply(add_lambda, std::pair(2.0f, 3.0f)) << '\n'; 
 
    // 进阶示例
    std::tuple myTuple(25, "Hello", 9.31f, 'c');
    std::cout << myTuple << '\n';
}

输出：

3
5
[25, Hello, 9.31, c]

参阅

make_tuple (C++11)	创建一个 tuple 对象，其类型根据各实参类型定义 (函数模板)
forward_as_tuple (C++11)	创建转发引用的 tuple (函数模板)
make_from_tuple (C++17)	以一个实参元组构造对象 (函数模板)
invokeinvoke_r (C++17)(C++23)	以给定实参和可能指定的返回类型 (C++23 起)调用任意可调用 (Callable) 对象 (函数模板)