如何实现STL样式的迭代器并避免常见的陷阱?

时间:2011-11-08 17:06:18

标签: c++ iterator const-iterator

我制作了一个集合,我想提供一个STL风格的随机访问迭代器。我正在寻找迭代器的示例实现,但我没有找到任何。我知道[]*运算符需要const重载。迭代器有什么要求是“STL风格”,还有哪些其他缺陷需要避免(如果有的话)?

附加上下文:这是一个库,除非我真的需要,否则我不想引入任何依赖。我编写自己的集合,以便能够使用相同的编译器在C ++ 03和C ++ 11之间提供二进制兼容性(因此没有STL可能会破坏)。

8 个答案:

答案 0 :(得分:212)

http://www.cplusplus.com/reference/std/iterator/有一个方便的图表,详细说明了C ++ 11标准第24.2.2节的规范。基本上,迭代器具有描述有效操作的标记,并且标记具有层次结构。下面纯粹是象征性的,这些类实际上并不存在。

iterator {
    iterator(const iterator&);
    ~iterator();
    iterator& operator=(const iterator&);
    iterator& operator++(); //prefix increment
    reference operator*() const;
    friend void swap(iterator& lhs, iterator& rhs); //C++11 I think
};

input_iterator : public virtual iterator {
    iterator operator++(int); //postfix increment
    value_type operator*() const;
    pointer operator->() const;
    friend bool operator==(const iterator&, const iterator&);
    friend bool operator!=(const iterator&, const iterator&); 
};
//once an input iterator has been dereferenced, it is 
//undefined to dereference one before that.

output_iterator : public virtual iterator {
    reference operator*() const;
    iterator operator++(int); //postfix increment
};
//dereferences may only be on the left side of an assignment
//once an output iterator has been dereferenced, it is 
//undefined to dereference one before that.

forward_iterator : input_iterator, output_iterator {
    forward_iterator();
};
//multiple passes allowed

bidirectional_iterator : forward_iterator {
    iterator& operator--(); //prefix decrement
    iterator operator--(int); //postfix decrement
};

random_access_iterator : bidirectional_iterator {
    friend bool operator<(const iterator&, const iterator&);
    friend bool operator>(const iterator&, const iterator&);
    friend bool operator<=(const iterator&, const iterator&);
    friend bool operator>=(const iterator&, const iterator&);

    iterator& operator+=(size_type);
    friend iterator operator+(const iterator&, size_type);
    friend iterator operator+(size_type, const iterator&);
    iterator& operator-=(size_type);  
    friend iterator operator-(const iterator&, size_type);
    friend difference_type operator-(iterator, iterator);

    reference operator[](size_type) const;
};

contiguous_iterator : random_access_iterator { //C++17
}; //elements are stored contiguously in memory.

您既可以专门化std::iterator_traits<youriterator>,也可以在迭代器本身中放置相同的typedef,或者从std::iterator(具有这些typedef)继承。我更喜欢第二个选项,以避免更改std命名空间中的内容,并且为了便于阅读,但大多数人都是从std::iterator继承。

struct std::iterator_traits<youriterator> {        
    typedef ???? difference_type; //almost always ptrdiff_t
    typedef ???? value_type; //almost always T
    typedef ???? reference; //almost always T& or const T&
    typedef ???? pointer; //almost always T* or const T*
    typedef ???? iterator_category;  //usually std::forward_iterator_tag or similar
};

请注意,iterator_category应该是std::input_iterator_tagstd::output_iterator_tagstd::forward_iterator_tagstd::bidirectional_iterator_tagstd::random_access_iterator_tag中的一个,具体取决于迭代器满足的要求。根据您的迭代器,您可以选择专门化std::nextstd::prevstd::advancestd::distance,但这很少需要。在极为罕见的案例中,您可能希望专注std::beginstd::end

您的容器可能还应该有一个const_iterator,它是一个(可能是可变的)迭代器,用于表示与iterator类似的常量数据,但它应该可以从iterator隐式构造用户应该无法修改数据。它的内部指针通常是指向非常量数据的指针,并且iterator继承自const_iterator,以便最大限度地减少代码重复。

我在Writing your own STL Container的帖子有一个更完整的容器/迭代器原型。

答案 1 :(得分:14)

Boost.Iterator中的iterator_facade documentation提供了一个关于为链表实现迭代器的精彩教程。你能用它作为在容器上构建随机访问迭代器的起点吗?

如果没有其他内容,您可以查看iterator_facade提供的成员函数和typedef,并将其作为构建自己的成员函数和起始点。

答案 2 :(得分:8)

Thomas Becker写了一篇关于这个主题的有用文章here

之前出现过这种(可能更简单)的方法:How to correctly implement custom iterators and const_iterators?

答案 3 :(得分:6)

以下是原始指针迭代器的示例。

你不应该使用iterator类来处理原始指针!

#include <iostream>
#include <vector>
#include <list>
#include <iterator>
#include <assert.h>

template<typename T>
class ptr_iterator
    : public std::iterator<std::forward_iterator_tag, T>
{
    typedef ptr_iterator<T>  iterator;
    pointer pos_;
public:
    ptr_iterator() : pos_(nullptr) {}
    ptr_iterator(T* v) : pos_(v) {}
    ~ptr_iterator() {}

    iterator  operator++(int) /* postfix */         { return pos_++; }
    iterator& operator++()    /* prefix */          { ++pos_; return *this; }
    reference operator* () const                    { return *pos_; }
    pointer   operator->() const                    { return pos_; }
    iterator  operator+ (difference_type v)   const { return pos_ + v; }
    bool      operator==(const iterator& rhs) const { return pos_ == rhs.pos_; }
    bool      operator!=(const iterator& rhs) const { return pos_ != rhs.pos_; }
};

template<typename T>
ptr_iterator<T> begin(T *val) { return ptr_iterator<T>(val); }


template<typename T, typename Tsize>
ptr_iterator<T> end(T *val, Tsize size) { return ptr_iterator<T>(val) + size; }

基于原始指针范围的循环解决方法。如果有更好的方法从原始指针进行基于范围的循环,请纠正我。

template<typename T>
class ptr_range
{
    T* begin_;
    T* end_;
public:
    ptr_range(T* ptr, size_t length) : begin_(ptr), end_(ptr + length) { assert(begin_ <= end_); }
    T* begin() const { return begin_; }
    T* end() const { return end_; }
};

template<typename T>
ptr_range<T> range(T* ptr, size_t length) { return ptr_range<T>(ptr, length); }

简单测试

void DoIteratorTest()
{
    const static size_t size = 10;
    uint8_t *data = new uint8_t[size];
    {
        // Only for iterator test
        uint8_t n = '0';
        auto first = begin(data);
        auto last = end(data, size);
        for (auto it = first; it != last; ++it)
        {
            *it = n++;
        }

        // It's prefer to use the following way:
        for (const auto& n : range(data, size))
        {
            std::cout << " char: " << static_cast<char>(n) << std::endl;
        }
    }
    {
        // Only for iterator test
        ptr_iterator<uint8_t> first(data);
        ptr_iterator<uint8_t> last(first + size);
        std::vector<uint8_t> v1(first, last);

        // It's prefer to use the following way:
        std::vector<uint8_t> v2(data, data + size);
    }
    {
        std::list<std::vector<uint8_t>> queue_;
        queue_.emplace_back(begin(data), end(data, size));
        queue_.emplace_back(data, data + size);
    }
}

答案 4 :(得分:4)

首先,您可以查看here以获取各个迭代器类型需要支持的各种操作的列表。

接下来,当你创建了迭代器类时,你需要为它专门化std::iterator_traits并提供一些必要的typedef s(如iterator_categoryvalue_type)或者从std::iterator派生,它为您定义所需的typedef,因此可以与默认std::iterator_traits一起使用。

免责声明:我知道有些人不太喜欢cplusplus.com,但他们提供了一些非常有用的信息。

答案 5 :(得分:2)

出于不同的原因,我和你在同一条船上(部分教育,部分限制)。我不得不重新编写标准库的所有容器,容器必须符合标准。这意味着,如果我用 stl 版本换出我的容器,代码将会起作用。这也意味着我必须重新编写迭代器。

无论如何,我看了EASTL。除了学习大量关于我从未学过的容器,使用 stl 容器或通过我的本科课程。主要原因是 EASTL stl 对应物更具可读性(我发现这仅仅是因为缺少所有宏和直接编码风格)。那里有一些蠢事(比如异常的#ifdefs),但没有什么可以压倒你。

正如其他人所提到的,请查看cplusplus.com对迭代器和容器的参考。

答案 6 :(得分:1)

我正在尝试解决能够迭代几个不同文本数组的问题,所有这些文本数组都存储在大型struct的内存驻留数据库中。

以下内容是在MFC测试应用程序上使用Visual Studio 2017社区版解决的。我将其作为示例,因为该帖子是我遇到的提供了一些帮助但仍不足以满足我需求的几个帖子之一。

包含内存驻留数据的struct看起来像以下内容。为了简洁起见,我删除了大多数元素,并且也未包括所使用的预处理器定义(正在使用的SDK适用于C和C ++,并且已经过时)。

我感兴趣的是为各种WCHAR二维数组提供迭代器,这些数组包含助记符的文本字符串。

typedef struct  tagUNINTRAM {
    // stuff deleted ...
    WCHAR   ParaTransMnemo[MAX_TRANSM_NO][PARA_TRANSMNEMO_LEN]; /* prog #20 */
    WCHAR   ParaLeadThru[MAX_LEAD_NO][PARA_LEADTHRU_LEN];   /* prog #21 */
    WCHAR   ParaReportName[MAX_REPO_NO][PARA_REPORTNAME_LEN];   /* prog #22 */
    WCHAR   ParaSpeMnemo[MAX_SPEM_NO][PARA_SPEMNEMO_LEN];   /* prog #23 */
    WCHAR   ParaPCIF[MAX_PCIF_SIZE];            /* prog #39 */
    WCHAR   ParaAdjMnemo[MAX_ADJM_NO][PARA_ADJMNEMO_LEN];   /* prog #46 */
    WCHAR   ParaPrtModi[MAX_PRTMODI_NO][PARA_PRTMODI_LEN];  /* prog #47 */
    WCHAR   ParaMajorDEPT[MAX_MDEPT_NO][PARA_MAJORDEPT_LEN];    /* prog #48 */
    //  ... stuff deleted
} UNINIRAM;

当前方法是使用模板为每个数组定义一个代理类,然后使用单个迭代器类,该迭代器类可通过使用代表该数组的代理对象用于在特定数组上进行迭代。

内存驻留数据的副本存储在一个对象中,该对象处理从/向磁盘读取内存驻留数据。此类CFilePara包含模板化代理类(MnemonicIteratorDimSize以及派生其的子类MnemonicIteratorDimSizeBase)和迭代器类MnemonicIterator

创建的代理对象附加到迭代器对象,该迭代器对象通过基类描述的接口访问必要的信息,所有代理类都从该基类派生而来。结果是只有一种迭代器类可以与几种不同的代理类一起使用,因为不同的代理类都公开相同的接口,即代理基类的接口。

第一件事是创建一组标识符,这些标识符将提供给类工厂,以为该类型的助记符生成特定的代理对象。这些标识符用作用户界面的一部分,以标识用户感兴趣的特定配置数据,并可能对其进行修改。

const static DWORD_PTR dwId_TransactionMnemonic = 1;
const static DWORD_PTR dwId_ReportMnemonic = 2;
const static DWORD_PTR dwId_SpecialMnemonic = 3;
const static DWORD_PTR dwId_LeadThroughMnemonic = 4;

代理类

模板化代理类及其基类如下。我需要容纳几种不同类型的wchar_t文本字符串数组。二维数组具有不同数量的助记符,具体取决于助记符的类型(用途),并且不同类型的助记符具有不同的最大长度,介于五个文本字符和二十个文本字符之间。派生代理类的模板很自然,模板需要每个助记符中的最大字符数。创建代理对象后,然后使用SetRange()方法指定实际的助记符数组及其范围。

// proxy object which represents a particular subsection of the
// memory resident database each of which is an array of wchar_t
// text arrays though the number of array elements may vary.
class MnemonicIteratorDimSizeBase
{
    DWORD_PTR  m_Type;

public:
    MnemonicIteratorDimSizeBase(DWORD_PTR x) { }
    virtual ~MnemonicIteratorDimSizeBase() { }

    virtual wchar_t *begin() = 0;
    virtual wchar_t *end() = 0;
    virtual wchar_t *get(int i) = 0;
    virtual int ItemSize() = 0;
    virtual int ItemCount() = 0;

    virtual DWORD_PTR ItemType() { return m_Type; }
};

template <size_t sDimSize>
class MnemonicIteratorDimSize : public MnemonicIteratorDimSizeBase
{
    wchar_t    (*m_begin)[sDimSize];
    wchar_t    (*m_end)[sDimSize];

public:
    MnemonicIteratorDimSize(DWORD_PTR x) : MnemonicIteratorDimSizeBase(x), m_begin(0), m_end(0) { }
    virtual ~MnemonicIteratorDimSize() { }

    virtual wchar_t *begin() { return m_begin[0]; }
    virtual wchar_t *end() { return m_end[0]; }
    virtual wchar_t *get(int i) { return m_begin[i]; }

    virtual int ItemSize() { return sDimSize; }
    virtual int ItemCount() { return m_end - m_begin; }

    void SetRange(wchar_t (*begin)[sDimSize], wchar_t (*end)[sDimSize]) {
        m_begin = begin; m_end = end;
    }

};

迭代器类

迭代器类本身如下。此类仅提供基本的正向迭代器功能,这是当前所需的全部功能。但是,我希望当我需要其他一些东西时,它会改变或扩展。

class MnemonicIterator
{
private:
    MnemonicIteratorDimSizeBase   *m_p;  // we do not own this pointer. we just use it to access current item.
    int      m_index;                    // zero based index of item.
    wchar_t  *m_item;                    // value to be returned.

public:
    MnemonicIterator(MnemonicIteratorDimSizeBase *p) : m_p(p) { }
    ~MnemonicIterator() { }

    // a ranged for needs begin() and end() to determine the range.
    // the range is up to but not including what end() returns.
    MnemonicIterator & begin() { m_item = m_p->get(m_index = 0); return *this; }                 // begining of range of values for ranged for. first item
    MnemonicIterator & end() { m_item = m_p->get(m_index = m_p->ItemCount()); return *this; }    // end of range of values for ranged for. item after last item.
    MnemonicIterator & operator ++ () { m_item = m_p->get(++m_index); return *this; }            // prefix increment, ++p
    MnemonicIterator & operator ++ (int i) { m_item = m_p->get(m_index++); return *this; }       // postfix increment, p++
    bool operator != (MnemonicIterator &p) { return **this != *p; }                              // minimum logical operator is not equal to
    wchar_t * operator *() const { return m_item; }                                              // dereference iterator to get what is pointed to
};

代理对象工厂根据助记符标识符确定要创建的对象。创建代理对象,并且返回的指针是标准基类类型,以便具有统一的接口,无论访问哪个不同的助记符节。 SetRange()方法用于向代理对象指定代理代表的特定数组元素以及数组元素的范围。

CFilePara::MnemonicIteratorDimSizeBase * CFilePara::MakeIterator(DWORD_PTR x)
{
    CFilePara::MnemonicIteratorDimSizeBase  *mi = nullptr;

    switch (x) {
    case dwId_TransactionMnemonic:
        {
            CFilePara::MnemonicIteratorDimSize<PARA_TRANSMNEMO_LEN> *mk = new CFilePara::MnemonicIteratorDimSize<PARA_TRANSMNEMO_LEN>(x);
            mk->SetRange(&m_Para.ParaTransMnemo[0], &m_Para.ParaTransMnemo[MAX_TRANSM_NO]);
            mi = mk;
        }
        break;
    case dwId_ReportMnemonic:
        {
            CFilePara::MnemonicIteratorDimSize<PARA_REPORTNAME_LEN> *mk = new CFilePara::MnemonicIteratorDimSize<PARA_REPORTNAME_LEN>(x);
            mk->SetRange(&m_Para.ParaReportName[0], &m_Para.ParaReportName[MAX_REPO_NO]);
            mi = mk;
        }
        break;
    case dwId_SpecialMnemonic:
        {
            CFilePara::MnemonicIteratorDimSize<PARA_SPEMNEMO_LEN> *mk = new CFilePara::MnemonicIteratorDimSize<PARA_SPEMNEMO_LEN>(x);
            mk->SetRange(&m_Para.ParaSpeMnemo[0], &m_Para.ParaSpeMnemo[MAX_SPEM_NO]);
            mi = mk;
        }
        break;
    case dwId_LeadThroughMnemonic:
        {
            CFilePara::MnemonicIteratorDimSize<PARA_LEADTHRU_LEN> *mk = new CFilePara::MnemonicIteratorDimSize<PARA_LEADTHRU_LEN>(x);
            mk->SetRange(&m_Para.ParaLeadThru[0], &m_Para.ParaLeadThru[MAX_LEAD_NO]);
            mi = mk;
        }
        break;
    }

    return mi;
}

使用代理类和迭代器

使用代理类及其迭代器,如以下循环所示,以使用助记符列表填充CListCtrl对象。我正在使用std::unique_ptr,以便当不再需要代理类并且std::unique_ptr超出范围时,将清除内存。

此源代码执行的操作是为struct中的数组创建一个代理对象,该对象对应于指定的助记符标识符。然后,它为该对象创建一个迭代器,使用范围为for的{​​{1}}控件进行填充,然后进行清理。这些都是原始的CListCtrl文本字符串,它们可能恰好是数组元素的数目,因此我们将字符串复制到临时缓冲区中,以确保文本以零结尾。

wchar_t

答案 7 :(得分:1)

现在是用于基于范围的for循环的键迭代器。

template<typename C>
class keys_it
{
    typename C::const_iterator it_;
public:
    using key_type        = typename C::key_type;
    using pointer         = typename C::key_type*;
    using difference_type = std::ptrdiff_t;

    keys_it(const typename C::const_iterator & it) : it_(it) {}

    keys_it         operator++(int               ) /* postfix */ { return it_++         ; }
    keys_it&        operator++(                  ) /*  prefix */ { ++it_; return *this  ; }
    const key_type& operator* (                  ) const         { return it_->first    ; }
    const key_type& operator->(                  ) const         { return it_->first    ; }
    keys_it         operator+ (difference_type v ) const         { return it_ + v       ; }
    bool            operator==(const keys_it& rhs) const         { return it_ == rhs.it_; }
    bool            operator!=(const keys_it& rhs) const         { return it_ != rhs.it_; }
};

template<typename C>
class keys_impl
{
    const C & c;
public:
    keys_impl(const C & container) : c(container) {}
    const keys_it<C> begin() const { return keys_it<C>(std::begin(c)); }
    const keys_it<C> end  () const { return keys_it<C>(std::end  (c)); }
};

template<typename C>
keys_impl<C> keys(const C & container) { return keys_impl<C>(container); }

用法:

std::map<std::string,int> my_map;
// fill my_map
for (const std::string & k : keys(my_map))
{
    // do things
}

这就是我想要的。但是似乎没有人拥有它。

您可以获得我的OCD代码对齐作为奖励。

作为练习,请为values(my_map)

编写自己的练习