Написание собственного контейнера STL

120

Есть ли правила написания нового контейнера, который будет вести себя как любой другой STLконтейнер?

Авинаш
источник
7
Просмотрите реализации существующих стандартных контейнеров и попытайтесь понять их - функции, возвращаемые типы, перегрузки операторов, вложенные типы, управление памятью и все остальное.
Nawaz
Обычно я начинаю с копирования прототипов функций-членов любого контейнера, наиболее близкого по концепции к тому, что я делаю, либо из msdn, либо из стандарта. ( cplusplus.com не имеет функций C ++ 11, а www.sgi.com не соответствует)
Mooing Duck
@Mooing Duck: вы думаете, что msdn ближе к стандарту, чем sgi?
Дэни
3
Это определенно так. MSDN актуален - SGI является предварительным стандартом
Puppy
9
Лучшая онлайн-ссылка (с точки зрения полноты, правильности и особенно удобства использования) - безусловно, cppreference.com. Он также объясняет массу языковых функций, помимо библиотеки. И это вики, поэтому в нем должно быть меньше ошибок, чем на cplusplus.com.
rubenvb

Ответы:

209

Вот последовательность псевдо-контейнер я кусочкам из § 23.2.1 \ 4 Обратите внимание , что iterator_categoryдолжен быть один из std::input_iterator_tag,std::output_iterator_tag , std::forward_iterator_tag, std::bidirectional_iterator_tag, std::random_access_iterator_tag. Также обратите внимание, что приведенное ниже технически более строгое, чем требуется, но это идея. Обратите внимание, что подавляющее большинство «стандартных» функций технически необязательны из-за того, что итераторы хороши.

template <class T, class A = std::allocator<T> >
class X {
public:
    typedef A allocator_type;
    typedef typename A::value_type value_type; 
    typedef typename A::reference reference;
    typedef typename A::const_reference const_reference;
    typedef typename A::difference_type difference_type;
    typedef typename A::size_type size_type;

    class iterator { 
    public:
        typedef typename A::difference_type difference_type;
        typedef typename A::value_type value_type;
        typedef typename A::reference reference;
        typedef typename A::pointer pointer;
        typedef std::random_access_iterator_tag iterator_category; //or another tag

        iterator();
        iterator(const iterator&);
        ~iterator();

        iterator& operator=(const iterator&);
        bool operator==(const iterator&) const;
        bool operator!=(const iterator&) const;
        bool operator<(const iterator&) const; //optional
        bool operator>(const iterator&) const; //optional
        bool operator<=(const iterator&) const; //optional
        bool operator>=(const iterator&) const; //optional

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

        reference operator*() const;
        pointer operator->() const;
        reference operator[](size_type) const; //optional
    };
    class const_iterator {
    public:
        typedef typename A::difference_type difference_type;
        typedef typename A::value_type value_type;
        typedef typename const A::reference reference;
        typedef typename const A::pointer pointer;
        typedef std::random_access_iterator_tag iterator_category; //or another tag

        const_iterator ();
        const_iterator (const const_iterator&);
        const_iterator (const iterator&);
        ~const_iterator();

        const_iterator& operator=(const const_iterator&);
        bool operator==(const const_iterator&) const;
        bool operator!=(const const_iterator&) const;
        bool operator<(const const_iterator&) const; //optional
        bool operator>(const const_iterator&) const; //optional
        bool operator<=(const const_iterator&) const; //optional
        bool operator>=(const const_iterator&) const; //optional

        const_iterator& operator++();
        const_iterator operator++(int); //optional
        const_iterator& operator--(); //optional
        const_iterator operator--(int); //optional
        const_iterator& operator+=(size_type); //optional
        const_iterator operator+(size_type) const; //optional
        friend const_iterator operator+(size_type, const const_iterator&); //optional
        const_iterator& operator-=(size_type); //optional            
        const_iterator operator-(size_type) const; //optional
        difference_type operator-(const_iterator) const; //optional

        reference operator*() const;
        pointer operator->() const;
        reference operator[](size_type) const; //optional
    };

    typedef std::reverse_iterator<iterator> reverse_iterator; //optional
    typedef std::reverse_iterator<const_iterator> const_reverse_iterator; //optional

    X();
    X(const X&);
    ~X();

    X& operator=(const X&);
    bool operator==(const X&) const;
    bool operator!=(const X&) const;
    bool operator<(const X&) const; //optional
    bool operator>(const X&) const; //optional
    bool operator<=(const X&) const; //optional
    bool operator>=(const X&) const; //optional

    iterator begin();
    const_iterator begin() const;
    const_iterator cbegin() const;
    iterator end();
    const_iterator end() const;
    const_iterator cend() const;
    reverse_iterator rbegin(); //optional
    const_reverse_iterator rbegin() const; //optional
    const_reverse_iterator crbegin() const; //optional
    reverse_iterator rend(); //optional
    const_reverse_iterator rend() const; //optional
    const_reverse_iterator crend() const; //optional

    reference front(); //optional
    const_reference front() const; //optional
    reference back(); //optional
    const_reference back() const; //optional
    template<class ...Args>
    void emplace_front(Args&&...); //optional
    template<class ...Args>
    void emplace_back(Args&&...); //optional
    void push_front(const T&); //optional
    void push_front(T&&); //optional
    void push_back(const T&); //optional
    void push_back(T&&); //optional
    void pop_front(); //optional
    void pop_back(); //optional
    reference operator[](size_type); //optional
    const_reference operator[](size_type) const; //optional
    reference at(size_type); //optional
    const_reference at(size_type) const; //optional

    template<class ...Args>
    iterator emplace(const_iterator, Args&&...); //optional
    iterator insert(const_iterator, const T&); //optional
    iterator insert(const_iterator, T&&); //optional
    iterator insert(const_iterator, size_type, T&); //optional
    template<class iter>
    iterator insert(const_iterator, iter, iter); //optional
    iterator insert(const_iterator, std::initializer_list<T>); //optional
    iterator erase(const_iterator); //optional
    iterator erase(const_iterator, const_iterator); //optional
    void clear(); //optional
    template<class iter>
    void assign(iter, iter); //optional
    void assign(std::initializer_list<T>); //optional
    void assign(size_type, const T&); //optional

    void swap(X&);
    size_type size() const;
    size_type max_size() const;
    bool empty() const;

    A get_allocator() const; //optional
};
template <class T, class A = std::allocator<T> >
void swap(X<T,A>&, X<T,A>&); //optional

Кроме того, всякий раз, когда я создаю контейнер, я тестирую его примерно с таким классом:

#include <cassert>
struct verify;
class tester {
    friend verify;
    static int livecount;
    const tester* self;
public:
    tester() :self(this) {++livecount;}
    tester(const tester&) :self(this) {++livecount;}
    ~tester() {assert(self==this);--livecount;}
    tester& operator=(const tester& b) {
        assert(self==this && b.self == &b);
        return *this;
    }
    void cfunction() const {assert(self==this);}
    void mfunction() {assert(self==this);}
};
int tester::livecount=0;
struct verify {
    ~verify() {assert(tester::livecount==0);}
}verifier;

Создавайте контейнеры из testerобъектов и вызывайте каждый из них function()при тестировании контейнера. Не создавайте никаких глобальных testerобъектов. Если ваш контейнер где-то читерствует, этот testerкласс будетassert и вы узнаете, что где-то случайно обманули.

Мычание утки
источник
1
Это интересно. Как работает ваш тестер? Есть несколько ошибок синтаксического анализа, которые тривиальны (отсутствуют ';'), но не уверены, как работает этот деструктор verify. О, ты имел в виду assert(tester::livecount == 0);. Ммммм, до сих пор не знаю, как работает этот тестер. Не могли бы вы привести пример?
Адриан
2
У тестера есть единственный нестатический член, который является указателем на самого себя, а деструктор и члены - это способ проверить, не memcpyпроизошло ли недействительного . (тест не является надежным, но он улавливает некоторых). Это livecountпростой детектор утечек, позволяющий убедиться, что ваш контейнер вызвал равное количество конструкторов и деструкторов.
Mooing Duck
Хорошо, я это понимаю, но как это проверить ваш итератор? Кстати, я думаю, вы verifierне имели в виду varifier.
Адриан
4
@Adrian Нет, нет, вы пишете свой контейнер, а затем помещаете их в контейнер и делаете что-то с контейнером, чтобы убедиться, что вы случайно не использовали memcpy, и не забыли вызвать все деструкторы.
Mooing Duck
1
Могу я предложить наследование итератора из std::iteratorзаголовка<iterator>
sp2danny
28

Вам нужно будет прочитать раздел стандарта C ++ о контейнерах и требованиях, которые стандарт C ++ предъявляет к реализациям контейнеров.

Соответствующая глава в стандарте C ++ 03:

Раздел 23.1 Требования к контейнерам

Соответствующая глава в стандарте C ++ 11:

Раздел 23.2 Требования к контейнерам

Почти окончательный вариант стандарта C ++ 11 находится в свободном доступе здесь. .

Вы также можете прочитать несколько отличных книг, которые помогут вам понять требования с точки зрения пользователя контейнера. Две прекрасные книги, которые легко поразили меня:

Эффективное STL отScott Meyers &
The ++ Стандартной библиотеки C: учебник и справочник поNicolai Josutils

Алок Сохранить
источник
6

Вот очень упрощенная реализация поддельного вектора, который по сути представляет собой оболочку std::vectorи имеет собственный (но настоящий) итератор, имитирующий итератор STL. Опять же, итератор очень упрощен, он пропускает многие концепции, такие как const_iteratorпроверки действительности и т. Д.

Код запускается из коробки.

#include <iostream>
#include <string>
#include <vector>

template<typename T>
struct It
{
    std::vector<T>& vec_;
    int pointer_;

    It(std::vector<T>& vec) : vec_{vec}, pointer_{0} {}

    It(std::vector<T>& vec, int size) : vec_{vec}, pointer_{size} {}

    bool operator!=(const It<T>& other) const
    {
        return !(*this == other);
    }

    bool operator==(const It<T>& other) const
    {
        return pointer_ == other.pointer_;
    }

    It& operator++()
    {
        ++pointer_;            
        return *this;
    }

    T& operator*() const
    {
        return vec_.at(pointer_);   
    }
};

template<typename T>
struct Vector
{
    std::vector<T> vec_;

    void push_back(T item)
    {
        vec_.push_back(item);
    };

    It<T> begin()
    {
        return It<T>(vec_);
    }

    It<T> end()
    {
        return It<T>(vec_, vec_.size());
    }
};

int main()
{
  Vector<int> vec;
  vec.push_back(1);
  vec.push_back(2);
  vec.push_back(3);

  bool first = true;
  for (It<int> it = vec.begin(); it != vec.end(); ++it)
  {
      if (first) //modify container once while iterating
      {
          vec.push_back(4);
          first = false;
      }

      std::cout << *it << '\n'; //print it 
      (*it)++;                  //change it
  }

  for (It<int> it = vec.begin(); it != vec.end(); ++it)
  {
      std::cout << *it << '\n'; //should see changed value
  }
}
PoweredByRice
источник