std::apply

 

C++

編譯器支援

自由（freestanding）與宿主（hosted）

語言

標準庫

標準庫標頭檔案

具名要求

特性測試宏 (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 );		(C++17 起) (直至 C++23)
template< class F, tuple-like Tuple > constexpr decltype(auto) apply( F&& f, Tuple&& t ) noexcept(/* see below */);		(C++23 起)

使用 t 的元素作為引數來呼叫 Callable 物件 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...>) // 僅用於說明
{
    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 返回的值。

異常

(無)	(直至 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 被約束為 tuple-like 型別，即其中每個型別都必須是 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';
 
    // 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)	呼叫任何帶有給定引數的 Callable 物件 並可能指定返回型別(C++23 起) (函式模板)