轉換迭代器

Author: David Abrahams, Jeremy Siek, Thomas Witt
Contact: dave@boost-consulting.com, jsiek@osl.iu.edu, witt@ive.uni-hannover.de
Organization: Boost Consulting, Indiana University Open Systems Lab, University of Hanover Institute for Transport Railway Operation and Construction
Date: 2006-09-11
Copyright: Copyright David Abrahams, Jeremy Siek, and Thomas Witt 2003.
概要: 轉換迭代器改編一個迭代器,將 operator* 改為對迭代器提領得到的值應用於一個函數對象,然後返回函數調用的結果。

目錄

transform_iterator 概要

template <class UnaryFunction,
class Iterator,
class Reference = use_default,
class Value = use_default>
class transform_iterator
{
public:
typedef /* 見下文 */ value_type;
typedef /* 見下文 */ reference;
typedef /* 見下文 */ pointer;
typedef iterator_traits<Iterator>::difference_type difference_type;
typedef /* 見下文 */ iterator_category;

transform_iterator();
transform_iterator(Iterator const& x, UnaryFunction f);

template<class F2, class I2, class R2, class V2>
transform_iterator(
transform_iterator<F2, I2, R2, V2> const& t
, typename enable_if_convertible<I2, Iterator>::type* = 0 // exposition only
, typename enable_if_convertible<F2, UnaryFunction>::type* = 0 // exposition only
);
UnaryFunction functor() const;
Iterator const& base() const;
reference operator*() const;
transform_iterator& operator++();
transform_iterator& operator--();
private:
Iterator m_iterator; // exposition only
UnaryFunction m_f; // exposition only
};

如果 Referenceuse_defaulttransform_iteratorreference 成員為 result_of<UnaryFunction(iterator_traits<Iterator>::reference)>::type. 否則,referenceReference.

如果 Valueuse_defaultvalue_type 成員為 remove_cv<remove_reference<reference> >::type. 否則,value_typeValue.

如果 Iterator 符合可讀左值迭代器,並且 Iterator 符合隨機訪問遍歷迭代器,則 iterator_category 可轉換為 random_access_iterator_tag. 否則,如果 Iterator 符合雙向遍歷迭代器,則 iterator_category 可轉換為 bidirectional_iterator_tag. 否則 iterator_category 可轉換為 forward_iterator_tag. 如果 Iterator 不符合可讀左值迭代器則 iterator_category 可轉換為 input_iterator_tag.

transform_iterator 的要求

類型 UnaryFunction 必須是可賦值的、可複製構造的,並且表達式 f(*i) 必須是有效的,其中 f 為類型 UnaryFunction 的一個對象,i 為類型 Iterator 的一個對象,f(*i) 的類型必須是 result_of<UnaryFunction(iterator_traits<Iterator>::reference)>::type.

參數 Iterator 應符合可讀迭代器。

transform_iterator 的模型

transform_iterator 的結果符合以下概念中 Iterator 所符合的最強化的一個。

  • 可寫左值迭代器,如果 transform_iterator::reference 為非常量引用。
  • 可讀左值迭代器,如果 transform_iterator::reference 為常量引用。
  • 否則,可讀迭代器。

transform_iterator 符合其 Iterator 參數所符合的最強化的標準遍歷概念。

如果 transform_iterator 符合可讀左值迭代器,則它依據其 Iterator 參數的情況符合以下原有迭代器概念。

如果 Iterator 符合 則 transform_iterator 符合
單遍迭代器 輸入迭代器
前向遍歷迭代器 前向迭代器
雙向遍歷迭代器 雙向迭代器
隨機訪問遍歷迭代器 隨機訪問迭代器

如果 transform_iterator 符合可寫左值迭代器,則它為非常量迭代器(參照舊式迭代器要求中的定義)。

transform_iterator<F1, X, R1, V1>transform_iterator<F2, Y, R2, V2> 可交互,當且僅當 XY 是可交互的。

transform_iterator 的操作

除了 transform_iterator 所符合的概念所要求的操作以外,transform_iterator 還提供了以下操作。

transform_iterator();

返回: 一個 transform_iterator 實例,帶有缺省構造的 m_fm_iterator.

transform_iterator(Iterator const& x, UnaryFunction f);

返回: 一個 transform_iterator 實例,其 m_f 初始化為 fm_iterator 初始化為 x.
template<class F2, class I2, class R2, class V2>
transform_iterator(
transform_iterator<F2, I2, R2, V2> const& t
, typename enable_if_convertible<I2, Iterator>::type* = 0 // exposition only
, typename enable_if_convertible<F2, UnaryFunction>::type* = 0 // exposition only
);
返回: 一個 transform_iterator 實例,其 m_f 初始化為 t.functor()m_iterator 初始化為 t.base().
要求: OtherIterator 可隱式轉換為 Iterator.

UnaryFunction functor() const;

返回: m_f

Iterator const& base() const;

返回: m_iterator

reference operator*() const;

返回: m_f(*m_iterator)

transform_iterator& operator++();

作用: ++m_iterator
返回: *this

transform_iterator& operator--();

作用: --m_iterator
返回: *this
 
template <class UnaryFunction, class Iterator>
transform_iterator<UnaryFunction, Iterator>
make_transform_iterator(Iterator it, UnaryFunction fun);
返回: 一個 transform_iterator<UnaryFunction, Iterator> 實例,其 m_f 初始化為 fm_iterator 初始化為 x.
template <class UnaryFunction, class Iterator>
transform_iterator<UnaryFunction, Iterator>
make_transform_iterator(Iterator it);
返回: 一個 transform_iterator<UnaryFunction, Iterator> 實例,其 m_f 為缺省構造,m_iterator 初始化為 x.

例子

這是一個簡單的例子,使用 transform_iterators 類來生成對提領得到的值進行乘法(或加法)運算的迭代器。在這個例子中使用 lambda 庫會顯得更酷。

int x[] = { 1, 2, 3, 4, 5, 6, 7, 8 };
const int N = sizeof(x)/sizeof(int);

typedef boost::binder1st< std::multiplies<int> > Function;
typedef boost::transform_iterator<Function, int*> doubling_iterator;

doubling_iterator i(x, boost::bind1st(std::multiplies<int>(), 2)),
i_end(x + N, boost::bind1st(std::multiplies<int>(), 2));

std::cout << "multiplying the array by 2:" << std::endl;
while (i != i_end)
std::cout << *i++ << " ";
std::cout << std::endl;

std::cout << "adding 4 to each element in the array:" << std::endl;
std::copy(boost::make_transform_iterator(x, boost::bind1st(std::plus<int>(), 4)),
boost::make_transform_iterator(x + N, boost::bind1st(std::plus<int>(), 4)),
std::ostream_iterator<int>(std::cout, " "));
std::cout << std::endl;

輸出結果是:

multiplying the array by 2:
2 4 6 8 10 12 14 16
adding 4 to each element in the array:
5 6 7 8 9 10 11 12

該例子的源代碼請見 這裡