std::iterator_traits

 

C++

編譯器支援

自由（freestanding）與宿主（hosted）

語言

標準庫

標準庫標頭檔案

具名要求

特性測試宏 (C++20)

語言支援庫

概念庫 (C++20)

診斷庫

記憶體管理庫

超程式設計庫 (C++11)

通用工具庫

容器庫

迭代器庫

範圍庫 (C++20)

演算法庫

字串庫

文字處理庫

數值庫

日期和時間庫

輸入/輸出庫

檔案系統庫 (C++17)

併發支援庫 (C++11)

執行控制庫 (C++26)

技術規範

符號索引

外部庫

 

迭代器庫

迭代器概念
indirectly_readable (C++20) indirectly_writable (C++20) weakly_incrementable (C++20) incrementable (C++20) is-integer-like is-signed-integer-like (C++20)(C++20)	sentinel_for (C++20) sized_sentinel_for (C++20) input_iterator (C++20) output_iterator (C++20) input_or_output_iterator (C++20)	forward_iterator (C++20) bidirectional_iterator (C++20) random_access_iterator (C++20) contiguous_iterator (C++20)
迭代器原語
input_iterator_tagoutput_iterator_tagforward_iterator_tagbidirectional_iterator_tagrandom_access_iterator_tagcontiguous_iterator_tag (C++20)	iter_value_titer_difference_titer_reference_titer_const_reference_titer_rvalue_reference_titer_common_reference_t (C++20)(C++20)(C++20)(C++23)(C++20)(C++20)	iterator (C++17 中已棄用) iterator_traits incrementable_traits (C++20) indirectly_readable_traits (C++20)
演算法概念與工具
間接可呼叫概念
indirectly_unary_invocableindirectly_regular_unary_invocable (C++20)(C++20)	indirect_unary_predicate (C++20) indirect_binary_predicate (C++20)	indirect_equivalence_relation (C++20) indirect_strict_weak_order (C++20)
常用演算法要求
indirectly_movable (C++20) indirectly_movable_storable (C++20) indirectly_copyable (C++20)	indirectly_copyable_storable (C++20)   indirectly_swappable (C++20) indirectly_comparable (C++20)	permutable (C++20) mergeable (C++20) sortable (C++20)
工具
indirect_result_t (C++20)	projected (C++20)	projected_value_t (C++26)
迭代器介面卡
reverse_iterator make_reverse_iterator (C++14) move_iterator (C++11) make_move_iterator (C++11) default_sentinel_tdefault_sentinel (C++20)(C++20) unreachable_sentinel_tunreachable_sentinel (C++20)(C++20)	front_insert_iterator back_insert_iterator inserter insert_iterator front_inserter back_inserter move_sentinel (C++20)	common_iterator (C++20) counted_iterator (C++20) basic_const_iterator (C++23) const_iterator (C++23) const_sentinel (C++23) make_const_iterator (C++23) make_const_sentinel (C++23)
流迭代器 istream_iterator    ostream_iterator istreambuf_iterator ostreambuf_iterator	迭代器定製點 ranges::iter_move (C++20) ranges::iter_swap (C++20)
迭代器操作 advance distance prev (C++11)   next (C++11) ranges::advance (C++20) ranges::distance (C++20) ranges::prev (C++20) ranges::next (C++20)	範圍訪問 begincbegin (C++11)(C++14) rbegincrbegin (C++14)(C++14)   endcend (C++11)(C++14) rendcrend (C++14)(C++14)   sizessize (C++17)(C++20) empty (C++17) data (C++17)

 

定義於標頭檔案 <iterator>
template< class Iter > struct iterator_traits;
template< class T > struct iterator_traits<T*>;
template< class T > struct iterator_traits<const T*>;		(C++20 中移除)

std::iterator_traits 是型別特徵類，它為 LegacyIterator 型別的屬性提供統一介面。這使得僅透過迭代器實現演算法成為可能。

該模板可以針對使用者定義的迭代器進行特化，以便即使型別不提供常用 typedef，也可以檢索有關迭代器的資訊。

使用者特化可以將其巢狀型別 iterator_concept 定義為 迭代器類別標籤之一，以指示與迭代器概念的符合性。

(C++20 起)

模板引數

Iter

-

要檢索屬性的迭代器型別

成員型別

巢狀型別	定義
difference_type	Iter::difference_type
value_type	Iter::value_type
pointer	Iter::pointer
reference	Iter::reference
iterator_category	Iter::iterator_category

如果 Iter 不包含上述五個巢狀型別中的任何一個，則此模板不包含任何具有這些名稱的成員（std::iterator_traits 相容 SFINAE）。

(C++17 起) (C++20 前)

如果 Iter 沒有 pointer，但包含所有剩餘的四個巢狀型別，則這四個巢狀型別宣告如下： 巢狀型別 定義 difference_type Iter::difference_type value_type Iter::value_type pointer void reference Iter::reference iterator_category Iter::iterator_category 否則，如果 Iter 滿足僅用於說明的概念 __LegacyInputIterator，則巢狀型別宣告如下： 巢狀型別 定義 difference_type std::incrementable_traits<Iter>::difference_type value_type std::indirectly_readable_traits<Iter>::value_type pointer 如果有效，則為 Iter::pointer。 否則，如果有效，則為 decltype(std::declval<Iter&>().operator->())。 否則為 void。 reference 如果有效，則為 Iter::reference。 否則為 std::iter_reference_t<Iter>。 iterator_category 如果有效，則為 Iter::iterator_category。 否則，如果 Iter 滿足 __LegacyRandomAccessIterator，則為 std::random_access_iterator_tag。 否則，如果 Iter 滿足 __LegacyBidirectionalIterator，則為 std::bidirectional_iterator_tag。 否則，如果 Iter 滿足 __LegacyForwardIterator，則為 std::forward_iterator_tag。 否則為 std::input_iterator_tag。 否則，如果 Iter 滿足僅用於說明的概念 __LegacyIterator，則巢狀型別宣告如下： 巢狀型別 定義 difference_type 如果有效，則為 std::incrementable_traits<Iter>::difference_type。 否則為 void。 value_type void pointer void reference void iterator_category std::output_iterator_tag 否則，此模板不包含任何具有這些名稱的成員（std::iterator_traits 相容 SFINAE）。

(C++20 起)

特化

此型別特徵可以針對可作為迭代器使用的使用者提供型別進行特化。標準庫為指標型別 T* 提供部分特化，這使得可以使用原始指標的所有基於迭代器的演算法。

標準庫還為某些標準迭代器介面卡提供部分特化。

(C++20 起)

T* 特化巢狀型別

僅當 std::is_object_v<T> 為 true 時才進行特化。

(C++20 起)

巢狀型別	定義
difference_type	std::ptrdiff_t
value_type	T(直到 C++20)std::remove_cv_t<T>(自 C++20 起)
pointer	T*
reference	T&
iterator_category	std::random_access_iterator_tag
iterator_concept (自 C++20 起)	std::contiguous_iterator_tag

const T* 特化巢狀型別 巢狀型別 定義 difference_type std::ptrdiff_t value_type T pointer const T* reference const T& iterator_category std::random_access_iterator_tag

(C++20 前)

庫型別的特化

std::iterator_traits<std::common_iterator> (C++20)	為 std::common_iterator 型別的屬性提供統一介面 (類模板特化)
std::iterator_traits<std::counted_iterator> (C++20)	為 std::counted_iterator 型別的屬性提供統一介面 (類模板特化)

示例

顯示了雙向迭代器的通用 std::reverse() 實現。

執行此程式碼

#include <iostream>
#include <iterator>
#include <list>
#include <vector>
 
template<class BidirIt>
void my_reverse(BidirIt first, BidirIt last)
{
    typename std::iterator_traits<BidirIt>::difference_type n = std::distance(first, last);
    for (--n; n > 0; n -= 2)
    {
        typename std::iterator_traits<BidirIt>::value_type tmp = *first;
        *first++ = *--last;
        *last = tmp;
    }
}
 
int main()
{
    std::vector<int> v{1, 2, 3, 4, 5};
    my_reverse(v.begin(), v.end());
    for (int n : v)
        std::cout << n << ' ';
    std::cout << '\n';
 
    std::list<int> l{1, 2, 3, 4, 5};
    my_reverse(l.begin(), l.end());
    for (int n : l)
        std::cout << n << ' ';
    std::cout << '\n';
 
    int a[]{1, 2, 3, 4, 5};
    my_reverse(a, a + std::size(a));
    for (int n : a)
        std::cout << n << ' ';
    std::cout << '\n';
 
//  std::istreambuf_iterator<char> i1(std::cin), i2;
//  my_reverse(i1, i2); // compilation error: i1, i2 are input iterators
}

輸出

5 4 3 2 1
5 4 3 2 1
5 4 3 2 1

另請參閱

iterator (C++17 中已棄用)	基類，用於簡化簡單迭代器所需型別的定義 (類模板)
input_iterator_tagoutput_iterator_tagforward_iterator_tagbidirectional_iterator_tagrandom_access_iterator_tagcontiguous_iterator_tag (C++20)	用於指示迭代器類別的空類型別 (類)
iter_value_titer_reference_titer_const_reference_titer_difference_titer_rvalue_reference_titer_common_reference_t (C++20)(C++20)(C++23)(C++20)(C++20)(C++20)	計算迭代器的關聯型別 (別名模板)