STL学习——List篇

• 简介

  List与Vector不同，它不使用连续空间，而是每次插入或删除一个元素，就配置或释放一个元素空间。故list对空间的使用精准，不浪费任何空间。list对任何位置的元素插入或删除，常数时间完成。

  List与Vector的使用，视元素的多少，元素的构造复杂度，元素存取行为的特性而定。

• List节点

  List本身与List节点不同，List是一个双向的链表。其节点信息如下：

  struct _List_node_base {
    _List_node_base* _M_next;    // 前向指针
    _List_node_base* _M_prev;    // 后向指针
  };
  // List节点
  template <class _Tp>
  struct _List_node : public _List_node_base {
    _Tp _M_data;
  };
  

• List的迭代器

  因List不使用连续的存储空间，故不能像vector一样，使用普通指针作为迭代器。list迭代器必须有能力指向list节点，并能力进行正确的递增，递减，取值，成员存取等操作。STL中的list是一个双向列表，故迭代器需就有前移，后移能力，故使用Bidirectional Iterator。List的重要性质：插入操作，接合操作都不会造成原有list迭代器失效。List**删除操作中，只有“指向被删除元素”的那个迭代器失效**，其他迭代器不受任何影响。

  template<class _Tp, class _Ref, class _Ptr>
  struct _List_iterator : public _List_iterator_base {
    typedef _List_iterator<_Tp,_Tp&,_Tp*>             iterator;
    typedef _List_iterator<_Tp,const _Tp&,const _Tp*> const_iterator;
    typedef _List_iterator<_Tp,_Ref,_Ptr>             _Self;
  
    typedef _Tp value_type;
    typedef _Ptr pointer;
    typedef _Ref reference;
    typedef _List_node<_Tp> _Node;     // 迭代器内部当然要有一个普通指针，指向list的节点
    // 构造函数
    _List_iterator(_Node* __x) : _List_iterator_base(__x) {}
    _List_iterator() {}
    _List_iterator(const iterator& __x) : _List_iterator_base(__x._M_node) {}
    // 以下对迭代器取值（dereference），取得是节点的数据值
    reference operator*() const { return ((_Node*) _M_node)->_M_data; }
  
  #ifndef __SGI_STL_NO_ARROW_OPERATOR
    // 以下是迭代器的成员存取（member access）运算子的标准做法
    pointer operator->() const { return &(operator*()); }
  #endif /* __SGI_STL_NO_ARROW_OPERATOR */
    // 对迭代器累加1，就是前进一个节点
    _Self& operator++() {
      this->_M_incr();
      return *this;
    }
    _Self operator++(int) {
      _Self __tmp = *this;
      this->_M_incr();
      return __tmp;
    }
    // 对迭代器减1，就是后退一个节点
    _Self& operator--() {
      this->_M_decr();
      return *this;
    }
    _Self operator--(int) {
      _Self __tmp = *this;
      this->_M_decr();
      return __tmp;
    }
  };
  

• List数据结构

  List不仅是一个双向链表，还是一个环状双向链表。故只需要一个指针，便可以完整表现整个链表。对于前闭后开区间，需要让指针node执行刻意置于尾端的一个空白节点，成为last迭代器。

  // 插入一个节点，作为头节点
    void push_front(const _Tp& __x) { insert(begin(), __x); }
    void push_front() {insert(begin());}
    // 插入一个节点，作为尾节点
    void push_back(const _Tp& __x) { insert(end(), __x); }
    void push_back() {insert(end());}
  // 移除头节点
    void pop_front() { erase(begin()); }
    // 移除尾节点
    void pop_back() {
      iterator __tmp = end();
      erase(--__tmp);
    }
  // 前向操作
    iterator begin()             { return (_Node*)(_M_node->_M_next); }
    const_iterator begin() const { return (_Node*)(_M_node->_M_next); }
    // 后向操作
    iterator end()             { return _M_node; }
    const_iterator end() const { return _M_node; }
  
    reverse_iterator rbegin()
      { return reverse_iterator(end()); }
    const_reverse_iterator rbegin() const
      { return const_reverse_iterator(end()); }
  
    reverse_iterator rend()
      { return reverse_iterator(begin()); }
    const_reverse_iterator rend() const
      { return const_reverse_iterator(begin()); }
  
    // 产生一个空链表
    bool empty() const { return _M_node->_M_next == _M_node; }
    size_type size() const {
      size_type __result = 0;
      distance(begin(), end(), __result);
      return __result;
    }
    size_type max_size() const { return size_type(-1); }
  
    // 取头节点的内容（元素值）
    reference front() { return *begin(); }
    const_reference () const { return *begin(); }
    // 取尾节点的内容（元素值）
    reference back() { return *(--end()); }
    const_reference back() const { return *(--end()); }
  

• List构造与内存管理

  List使用alloc作为空间配置器，并使用list_node_allocator来方便节点大小的配置单位。其中的list_node_allocator(n)表示配置n个节点空间。其中的get_node()，put_node()，create_node()，destory_node()分别表示配置，释放，构造，销毁一个节点。

  template <class _Tp, class _Alloc>
  class _List_base
  {
  public:
    typedef _Alloc allocator_type;
    // 配置一个节点并传回
    allocator_type get_allocator() const { return allocator_type(); }
  
    _List_base(const allocator_type&) {
      _M_node = _M_get_node();
      _M_node->_M_next = _M_node;
      _M_node->_M_prev = _M_node;
    }
    ~_List_base() {
      clear();
      _M_put_node(_M_node);
    }
  
    void clear();
  
  protected:
    // 专属之空间配置器，每次配置一个节点大小
    typedef simple_alloc<_List_node<_Tp>, _Alloc> _Alloc_type;
    // 配置一个节点并传回
    _List_node<_Tp>* _M_get_node() { return _Alloc_type::allocate(1); }
    // 释放一个节点
    void _M_put_node(_List_node<_Tp>* __p) { _Alloc_type::deallocate(__p, 1); }
    // 产生（配置并构造）一个节点，带有元素值
    _Node* _M_create_node(const _Tp& __x)
    {
      _Node* __p = _M_get_node();
      __STL_TRY {
        _Construct(&__p->_M_data, __x);    // 全局函数，构造/析构基本工具
      }
      __STL_UNWIND(_M_put_node(__p));
      return __p;
    }
  
  protected:
    _List_node<_Tp>* _M_node;
  };
  

• List元素操作

  List的操作主要包括push_front()，push_back()，erase()，pop_front()，pop_back()，clear()，remove()，unique()，splice()，merge()，reverse()，sort()等。具体见下面源码分析。

  // 清除所有节点（整个链表）
  template <class _Tp, class _Alloc>
  void
  _List_base<_Tp,_Alloc>::clear()
  {
    _List_node<_Tp>* __cur = (_List_node<_Tp>*) _M_node->_M_next;
    while (__cur != _M_node) {                     // 遍历每一个节点
      _List_node<_Tp>* __tmp = __cur;
      __cur = (_List_node<_Tp>*) __cur->_M_next;
      _Destroy(&__tmp->_M_data);                   // 销毁（析构并释放）一个节点
      _M_put_node(__tmp);
    }
    // 回复node原始状态
    _M_node->_M_next = _M_node;
    _M_node->_M_prev = _M_node;
  }
  
  // 在迭代器position所指位置插入一个节点，内容为x
    iterator insert(iterator __position, const _Tp& __x) {
      _Node* __tmp = _M_create_node(__x);            // 产生一个节点（设妥内容为x）
      // 调整双向指针，将tmp插入进入
      __tmp->_M_next = __position._M_node;
      __tmp->_M_prev = __position._M_node->_M_prev;
      __position._M_node->_M_prev->_M_next = __tmp;
      __position._M_node->_M_prev = __tmp;
      return __tmp;
    }
   void insert(iterator __pos, size_type __n, const _Tp& __x)
      { _M_fill_insert(__pos, __n, __x); }
    void _M_fill_insert(iterator __pos, size_type __n, const _Tp& __x);
    // 插入一个节点，作为头节点
    void push_front(const _Tp& __x) { insert(begin(), __x); }
    void push_front() {insert(begin());}
    // 插入一个节点，作为尾节点
    void push_back(const _Tp& __x) { insert(end(), __x); }
    void push_back() {insert(end());}
    // 移除迭代器position所指节点
    iterator erase(iterator __position) {
      _List_node_base* __next_node = __position._M_node->_M_next;
      _List_node_base* __prev_node = __position._M_node->_M_prev;
      _Node* __n = (_Node*) __position._M_node;
      __prev_node->_M_next = __next_node;
      __next_node->_M_prev = __prev_node;
      _Destroy(&__n->_M_data);
      _M_put_node(__n);
      return iterator((_Node*) __next_node);
    }
    iterator erase(iterator __first, iterator __last);
    // 清除所有节点（整个链表）
    void clear() { _Base::clear(); }
  // 将[first,lat）内的所有元素移动到position之前
    void transfer(iterator __position, iterator __first, iterator __last) {
      if (__position != __last) {
        // Remove [first, last) from its old position.
        __last._M_node->_M_prev->_M_next     = __position._M_node;
        __first._M_node->_M_prev->_M_next    = __last._M_node;
        __position._M_node->_M_prev->_M_next = __first._M_node; 
  
        // Splice [first, last) into its new position.
        _List_node_base* __tmp      = __position._M_node->_M_prev;
        __position._M_node->_M_prev = __last._M_node->_M_prev;
        __last._M_node->_M_prev     = __first._M_node->_M_prev;
        __first._M_node->_M_prev    = __tmp;
      }
    }
  
  public:
    // 将x接合于position所指位置之前，x必须有不同于*this
    void splice(iterator __position, list& __x) {
      if (!__x.empty())
        this->transfer(__position, __x.begin(), __x.end());
    }
    // 将i所指元素接合于position所指位置之前。position和i可指向同一个list
    void splice(iterator __position, list&, iterator __i) {
      iterator __j = __i;
      ++__j;
      if (__position == __i || __position == __j) return;
      this->transfer(__position, __i, __j);
    }
    // 将[first,last)内的所有元素接合于position所指位置之前
    // position和[first,last)可指向同一个list
    // 但position不能位于[first,last)之内
    void splice(iterator __position, list&, iterator __first, iterator __last) {
      if (__first != __last)
        this->transfer(__position, __first, __last);
    }
  // 将数值value之所有元素移除
  template <class _Tp, class _Alloc>
  void list<_Tp, _Alloc>::remove(const _Tp& __value)
  {
    iterator __first = begin();
    iterator __last = end();
    while (__first != __last) {                      // 遍历每一个节点
      iterator __next = __first;
      ++__next;
      if (*__first == __value) erase(__first);       // 找到就移除
      __first = __next;
    }
  }
  // 移除数值相同的连续元素。注意，只有“连续而相同的元素”，才会被移除剩一个
  template <class _Tp, class _Alloc>
  void list<_Tp, _Alloc>::unique()
  {
    iterator __first = begin();
    iterator __last = end();
    if (__first == __last) return;                   // 空链表，什么都不必做
    iterator __next = __first;
    while (++__next != __last) {                     // 遍历每一个节点
      if (*__first == *__next)                       // 如果在此区段中有相同的元素
        erase(__next);                               // 移除之
      else
        __first = __next;                            // 调整指针
      __next = __first;                              // 修正区段范围
    }
  }
  // merge()将x合并到*this身上。两个lists的内容都必须先经过递增排序
  template <class _Tp, class _Alloc>
  void list<_Tp, _Alloc>::merge(list<_Tp, _Alloc>& __x)
  {
    iterator __first1 = begin();
    iterator __last1 = end();
    iterator __first2 = __x.begin();
    iterator __last2 = __x.end();
    // 注意：前提是，两个lists都已经递增排序
    while (__first1 != __last1 && __first2 != __last2)
      if (*__first2 < *__first1) {
        iterator __next = __first2;
        transfer(__first1, __first2, ++__next);
        __first2 = __next;
      }
      else
        ++__first1;
    if (__first2 != __last2) transfer(__last1, __first2, __last2);
  }
  // 将list进行逆置
  inline void __List_base_reverse(_List_node_base* __p)
  {
    _List_node_base* __tmp = __p;
    do {
      __STD::swap(__tmp->_M_next, __tmp->_M_prev);
      __tmp = __tmp->_M_prev;     // Old next node is now prev.
    } while (__tmp != __p);
  }
  // reverse()将*this的内容逆向重置
  template <class _Tp, class _Alloc>
  inline void list<_Tp, _Alloc>::reverse()
  {
    __List_base_reverse(this->_M_node);
  }
  // list不能使用STL算法sort()，必须使用自己的sort()函数
  // 因为STL算法sort()只接受RandomAccesssIterator
  // 本函数采用quick sort实现
  template <class _Tp, class _Alloc>
  void list<_Tp, _Alloc>::sort()
  {
    // Do nothing if the list has length 0 or 1.
    // 以下判断，如果是空链表，或仅有一个元素，就不进行任何操作
    // 使用size()==0||size()==1来判断，虽然也可以，但是比较慢
    if (_M_node->_M_next != _M_node && _M_node->_M_next->_M_next != _M_node) {
      // 一些新的lists，作为中介数据存放区
      list<_Tp, _Alloc> __carry;
      list<_Tp, _Alloc> __counter[64];
      int __fill = 0;
      while (!empty()) {
        __carry.splice(__carry.begin(), *this, begin());
        int __i = 0;
        while(__i < __fill && !__counter[__i].empty()) {
          __counter[__i].merge(__carry);
          __carry.swap(__counter[__i++]);
        }
        __carry.swap(__counter[__i]);
        if (__i == __fill) ++__fill;
      } 
  
      for (int __i = 1; __i < __fill; ++__i)
        __counter[__i].merge(__counter[__i-1]);
      swap(__counter[__fill-1]);
    }
  }
  

• 参考文献

  STL源码剖析——侯捷

  STL源码