std::apply

 

C++

编译器支持

独立和托管

语言

标准库

标准库头文件

具名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

实用工具库

语言支持 类型支持 (基本类型，RTTI) 库特性测试宏 (C++20) 程序实用工具 可变参数函数 initializer_list (C++11) is_constant_evaluated (C++20) is_within_lifetime (C++26) source_location (C++20) 协程支持 (C++20) 契约式支持 (C++26) 三路比较 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)

通用实用工具 函数对象 位操作 (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 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)

 

定义于头文件 <tuple>
template< class F, class Tuple > constexpr decltype(auto) apply( F&& f, Tuple&& t );		(since C++17) (until C++23)
template< class F, tuple-like Tuple > constexpr decltype(auto) apply( F&& f, Tuple&& t ) noexcept(/* see below */);		(since C++23)

使用 t 的元素作为参数，调用 可调用 对象 f。

给定仅用于阐释目的的函数 apply-impl 定义如下

template<class F,class Tuple, std::size_t... I>
constexpr decltype(auto)
    apply-impl(F&& f, Tuple&& t, std::index_sequence<I...>) // exposition only
{
    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	-	要调用的 可调用 对象
t	-	元组，其元素将用作 f 的实参

返回值

由 f 返回的值。

异常

(无)	(until 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.	(since C++23)

注解

Tuple 不需要是 std::tuple，而可以是任何支持 std::get 和 std::tuple_size 的类型；特别是，可以使用 std::array 和 std::pair。	(until C++23)
Tuple 被约束为 tuple-like，即，其中的每个类型都需要是 std::tuple 的特化，或者是另一个对 tuple-like 建模的类型（例如 std::array 和 std::pair）。	(since C++23)

特性测试 宏	值	Std	特性
__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';
 
    // Error: can't deduce the function type
    // 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'; 
 
    // advanced example
    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) (函数模板)