STL — list


本文原创

list 的数据结构为双向循环链表, 插入删除非常方便,研究 STL 中 list 的实现对熟悉指针操作大有裨益。

list 的结点结构如下,基类负责链接链表,派生类存储元素数据:

struct _List_node_base
{
    _List_node_base* _M_next;
    _List_node_base* _M_prev;
};

template <class _Tp>
struct _List_node : public _List_node_base
{
    _Tp _M_data;
};

list 专门定义了适用于自身结构的迭代器:

struct _List_iterator_base
{
    typedef size_t                     size_type;
    typedef ptrdiff_t                  difference_type;
    typedef bidirectional_iterator_tag iterator_category;

    _List_node_base* _M_node; // 封装了结点的基类指针

    _List_iterator_base(_List_node_base* __x) : _M_node(__x) {}
    _List_iterator_base() {}

    void _M_incr() { _M_node = _M_node->_M_next; } // 后移
    void _M_decr() { _M_node = _M_node->_M_prev; } // 前移

    bool operator==(const _List_iterator_base& __x) const
    {
        return _M_node == __x._M_node;
    }
    bool operator!=(const _List_iterator_base& __x) const
    {
        return _M_node != __x._M_node;
    }
};

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_iterator(_Node* __x) : _List_iterator_base(__x) {}
  _List_iterator() {}
  _List_iterator(const iterator& __x) : _List_iterator_base(__x._M_node) {}

  reference operator*() const { return ((_Node*) _M_node)->_M_data; }
  pointer operator->() const { return &(operator*()); }

  _Self& operator++() // 效率较高
  {
    this->_M_incr();
    return *this;
  }
  _Self operator++(int) // 两次额外赋值,效率较低
  {
    _Self __tmp = *this;
    this->_M_incr();
    return __tmp;
  }
  _Self& operator--() // 效率较高
  {
    this->_M_decr();
    return *this;
  }
  _Self operator--(int) // 两次额外赋值,效率较低
  {
    _Self __tmp = *this;
    this->_M_decr();
    return __tmp;
  }
};

与 vector 相同,list 也将内存管理交由基类实现:

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(); // clear() 调用后实际上仍保留有一个结点
        _M_put_node(_M_node); // 释放此结点
    }

    void clear()
    {
        _List_node<_Tp>* __cur = (_List_node<_Tp>*) _M_node->_M_next;
        while (__cur != _M_node) // 当 __cur 回到起点时,终点刚好被析构释放
        {
            _List_node<_Tp>* __tmp = __cur;
            __cur = (_List_node<_Tp>*) __cur->_M_next; // 后移
            _Destroy(&__tmp->_M_data); // 先调用存储对象的析构函数
            _M_put_node(__tmp);        // 释放结点
        }
        _M_node->_M_next = _M_node;    // 指向自身
        _M_node->_M_prev = _M_node;    // 指向自身
    }

protected:
    typedef simple_alloc<_List_node<_Tp>, _Alloc> _Alloc_type; // 使用 simple_alloc
    _List_node<_Tp>* _M_get_node() { return _Alloc_type::allocate(1); }
    void _M_put_node(_List_node<_Tp>* __p) { _Alloc_type::deallocate(__p, 1); } 

protected:
    _List_node<_Tp>* _M_node; // 作为 end() 指向的结点
};

list 定义如下,为节省篇幅,代码中省略了使用默认值的重载成员函数版本:

template <class _Tp, class _Alloc = alloc >
class list : protected _List_base<_Tp, _Alloc>
{
  __STL_CLASS_REQUIRES(_Tp, _Assignable);
  typedef _List_base<_Tp, _Alloc> _Base;

protected:
  typedef void* _Void_pointer;

public:      
  typedef _Tp value_type;
  typedef value_type* pointer;
  typedef const value_type* const_pointer;
  typedef value_type& reference;
  typedef const value_type& const_reference;
  typedef _List_node<_Tp> _Node;
  typedef size_t size_type;
  typedef ptrdiff_t difference_type;

  typedef typename _Base::allocator_type allocator_type;
  allocator_type get_allocator() const { return _Base::get_allocator(); }

public:
  typedef _List_iterator<_Tp, _Tp&, _Tp*>             iterator;
  typedef _List_iterator<_Tp, const _Tp&, const _Tp*> const_iterator;
  typedef reverse_iterator<iterator>                  reverse_iterator;
  typedef reverse_iterator<const_iterator>            const_reverse_iterator;

protected:
#ifdef __STL_HAS_NAMESPACES
  using _Base::_M_node;
  using _Base::_M_put_node;
  using _Base::_M_get_node;
#endif /* __STL_HAS_NAMESPACES */

protected:
  _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;
  }

public:
  explicit list(const allocator_type& __a = allocator_type()) : _Base(__a) {}

  iterator begin()             { return (_Node*)(_M_node->_M_next); }
  const_iterator begin() const { return (_Node*)(_M_node->_M_next); }
  iterator end()             { return _M_node; } // 可以看出最初的结点是 end() 哨兵
  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 // 线性时间,判断是否为空时调用 empty()
  {
    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 front() const { return *begin(); }
  reference back() { return *(--end()); }
  const_reference back() const { return *(--end()); }

  void swap(list<_Tp, _Alloc>& __x) { std::swap(_M_node, __x._M_node); }

  iterator insert(iterator __position, const _Tp& __x)
  {
    _Node* __tmp = _M_create_node(__x);  // 创建新结点
    __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; // 注意插入后 iterator 位置在链表中指向的绝对位置不后移
  }
  /* range insert */
  void insert(iterator __position, const _Tp* __first, const _Tp* __last)
  {
    for ( ; __first != __last; ++__first)
      insert(__position, *__first);
  }
  void insert(iterator __position, const_iterator __first, const_iterator __last)
  {
    for ( ; __first != __last; ++__first)
      insert(__position, *__first);
  }

  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)
  {
    for ( ; __n > 0; --__n)
      insert(__position, __x);
  }
  /* 都是调用 insert */
  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()); }

  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)
  {
    while (__first != __last)
      erase(__first++); // 后缀自增,从而 erase 的区间为前闭后开
    return __last;
  }
  void clear() { _Base::clear(); }

  void resize(size_type __new_size, const _Tp& __x);

  void pop_front() { erase(begin()); }
  void pop_back() // 可看出 pop_back() 的开销比 pop_front() 稍大
  {
    iterator __tmp = end();
    erase(--__tmp);
  }

  list(size_type __n, const _Tp& __value,
       const allocator_type& __a = allocator_type()) : _Base(__a)
  { insert(begin(), __n, __value); }
  list(const _Tp* __first, const _Tp* __last,
       const allocator_type& __a = allocator_type()) : _Base(__a)
  { this->insert(begin(), __first, __last); }
  list(const_iterator __first, const_iterator __last,
       const allocator_type& __a = allocator_type()) : _Base(__a)
  { this->insert(begin(), __first, __last); }

  list(const list<_Tp, _Alloc>& __x) : _Base(__x.get_allocator())
  { insert(begin(), __x.begin(), __x.end()); }

  ~list() {}

  list<_Tp, _Alloc>& operator=(const list<_Tp, _Alloc>& __x);

public:
  // assign(), a generalized assignment member function.  Two versions: one that
  // takes a count, and one that takes a range. The range version is a member
  // template, so we dispatch on whether or not the type is an integer.
  void assign(size_type __n, const _Tp& __val) { _M_fill_assign(__n, __val); }
  void _M_fill_assign(size_type __n, const _Tp& __val);

protected:
  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:
  void splice(iterator __position, list& __x)
  {
    if (!__x.empty()) 
      this->transfer(__position, __x.begin(), __x.end());
  }
  void splice(iterator __position, list&, iterator __i)
  {
    iterator __j = __i;
    ++__j;
    if (__position == __i || __position == __j) return;
    this->transfer(__position, __i, __j);
  }
  void splice(iterator __position, list&, iterator __first, iterator __last)
  {
    if (__first != __last) 
      this->transfer(__position, __first, __last);
  }
  void remove(const _Tp& __value);
  void unique();
  void merge(list& __x);
  void reverse();
  void sort();
};

一些类外定义的成员函数:

template <class _Tp, class _Alloc>
void list<_Tp, _Alloc>::resize(size_type __new_size, const _Tp& __x)
{
  iterator __i = begin();
  size_type __len = 0;
  for ( ; __i != end() && __len < __new_size; ++__i, ++__len)
    ;
  if (__len == __new_size)
    erase(__i, end());
  else // __i == end()
    insert(end(), __new_size - __len, __x);
}

template <class _Tp, class _Alloc>
list<_Tp, _Alloc>& list<_Tp, _Alloc>::operator=(const list<_Tp, _Alloc>& __x)
{
  if (this != &__x) // 避免自我赋值
  {
    iterator __first1 = begin();
    iterator __last1 = end();
    const_iterator __first2 = __x.begin();
    const_iterator __last2 = __x.end();
    while (__first1 != __last1 && __first2 != __last2) 
      *__first1++ = *__first2++;
    if (__first2 == __last2) // 去除被赋 list 后面多余的结点
      erase(__first1, __last1);
    else // 被赋 list 结点数目不够,往后插入
      insert(__last1, __first2, __last2);
  }
  return *this;
}

template <class _Tp, class _Alloc>
void list<_Tp, _Alloc>::_M_fill_assign(size_type __n, const _Tp& __val)
{
  iterator __i = begin();
  for ( ; __i != end() && __n > 0; ++__i, --__n)
    *__i = __val;
  if (__n > 0)
    insert(end(), __n, __val);
  else
    erase(__i, end());
}

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;
  }
}

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();
  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);
}

template <class _Tp, class _Alloc>
void list<_Tp, _Alloc>::sort()
{
  // Do nothing if the list has length 0 or 1.
  if (_M_node->_M_next != _M_node && _M_node->_M_next->_M_next != _M_node)
  {
    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]);
  }
}

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);
}

template <class _Tp, class _Alloc>
inline void list<_Tp, _Alloc>::reverse() 
{
  __List_base_reverse(this->_M_node);
}

未完待续……

Leave a comment

邮箱地址不会被公开。 必填项已用*标注