[C++] STL_list常用接口的模拟实现

你的名字 2023-10-15 15:21 40阅读 0赞

![在这里插入图片描述][c2988b85a35c457f8a299bf3846fe491.gif_pic_center]

#### 文章目录 ####

*  1、list的介绍与使用
 *   *  1.1 list的介绍
     *  1.2 list的使用
 *  2、list迭代器
 *  3、list的构造
 *  4、list常用接口的实现
 *   *  4.1 list capacity
     *  4.2 插入删除、交换、清理
     *   *  4.2.1 insert任意位置插入
         *  4.2.2 push\_front头插
         *  4.2.3 push\_back尾插
         *  4.2.4 erase任意位置删除
         *  4.2.5 pop\_front头删
         *  4.2.6 pop\_back尾删
         *  4.2.7 swap()
         *  4.2.8 clear
 *  5、list迭代器失效问题
 *  6、list与vector对比

## 1、list的介绍与使用 ##

### 1.1 list的介绍 ###

[list文档介绍][list]

> 1.  list是可以在常数范围内在任意位置进行插入和删除的序列式容器，并且该容器可以前后双向迭代。
> 2.  list的底层是双向链表结构，双向链表中每个元素存储在互不相关的独立节点中，在节点中通过指针指向其前一个元素和后一个元素。
> 3.  list与forward\_list非常相似：最主要的不同在于forward\_list是单链表，只能朝前迭代，已让其更简单效。
> 4.  与其他的序列式容器相比(array，vector，deque)，list通常在任意位置进行插入、移除元素的执行效率更好。
> 5.  与其他序列式容器相比，list和forward\_list最大的缺陷是不支持任意位置的随机访问，比如：要访问list的第6个元素，必须从已知的位置(比如头部或者尾部)迭代到该位置，在这段位置上迭代需要线性的时间开销；list还需要一些额外的空间，以保存每个节点的相关联信息(对于存储类型较小元素的大list来说这可能是一个重要的因素)

### 1.2 list的使用 ###

list中的接口比较多，此处类似，只需要掌握如何正确的使用，然后再去深入研究背后的原理，已达到可扩展的能力。

## 2、list迭代器 ##

此处，我们可暂时**将迭代器理解成一个指针，该指针指向list中的某个节点。**  
list我们都知道，它不是连续的空间，是我们将下一个位置的地址保存起来，通过地址走到下一个，因此我们需要重载一些运算符。  
后移的++（前置后置）  
前移的 --（前置后置）  
解引用的\*，->  
相等判断的 ==，!=

这里我们为list节点创建一个类，后面直接使用这个类就可以了，再写一个缺省的构造函数，为后面开节点提供便利。

// List的节点类
    template<class T>
    struct ListNode
    {
        
        ListNode(const T& val = T())
            :_pPre(nullptr)
            ,_pNext(nullptr)
            ,_val(val)
        {
        }
    
        ListNode<T>* _pPre;
        ListNode<T>* _pNext;
        T _val;
    };
    
    
    //List的迭代器类
    template<class T, class Ref, class Ptr>
    class ListIterator
    {
        
        typedef ListNode<T>* PNode;
        typedef ListIterator<T, Ref, Ptr> Self;
    public:
        ListIterator(PNode pNode = nullptr)
            :_pNode(pNode)
        {
        }
    
        ListIterator(const Self& l)
        {
        
            _pNode = l._pNode;
        }
    
        T& operator*()
        {
        
            return _pNode->_val;
        }
    
        T* operator->()
        {
        
            return &_pNode->_val;
        }
    
        Self& operator++()
        {
        
            _pNode = _pNode->_pNext;
            return *this;
        }
    
        Self& operator++(int)
        {
        
            Self tmp(*this);
            _pNode = _pNode->_pNext;
    
            return tmp;
        }
    
        Self& operator--()
        {
        
            _pNode = _pNode->_pPre;
            return *this;
        }
    
        Self& operator--(int)
        {
        
            Self tmp(*this);
            _pNode = _pNode->_pPre;
    
            return tmp;
        }
    
        bool operator!=(const Self& l)
        {
        
            return _pNode != l._pNode;
        }
    
        bool operator==(const Self& l)
        {
        
            return _pNode == l._pNode;
        }
    
    //private:
        PNode _pNode;
    };

## 3、list的构造 ##

<table> 
 <thead> 
  <tr> 
   <th>构造函数（<a href="https://cplusplus.com/reference/list/list/list/" rel="nofollow">constructor</a>）</th> 
   <th>接口说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>list (size_type n, const value_type&amp; val = value_type())</td> 
   <td>构造的list中包含n个值为val的元素</td> 
  </tr> 
  <tr> 
   <td>list()</td> 
   <td>构造空的list</td> 
  </tr> 
  <tr> 
   <td>list(const list&amp; x)</td> 
   <td>拷贝构造函数</td> 
  </tr> 
  <tr> 
   <td>list(InputIterator first, InputIterator last)</td> 
   <td>用[first, last)区间中的元素构造list</td> 
  </tr> 
 </tbody> 
</table>

构造我们已经写了太多了，对于这些接口直接秒杀。  
**空参构造list：**

list()
    {
        
        _pHead = new Node;
        _pHead->_pNext = _pHead;
        _pHead->_pPre = _pHead;
    }

**拷贝构造list：**

list(const list<T>& l)
    {
        
        _pHead = new Node;
        _pHead->_pNext = _pHead;
        _pHead->_pPre = _pHead;
    
        for (auto e : l)
        {
        
            push_back(e);
        }
    }

**n个值为val的构造：**

list(int n, const T& value = T())
    {
        
        _pHead = new Node;
        _pHead->_pNext = _pHead;
        _pHead->_pPre = _pHead;
        
        for (int i = 0; i < n; i++)
        {
        
            push_back(value);
        }
    }

**迭代器区间构造：**

template <class Iterator>
    list(Iterator first, Iterator last)
    {
        
        CreateHead();
        while (first != last)
        {
        
            push_back(*first);
            ++first;
        }
    }

## 4、list常用接口的实现 ##

我们实现的是双向带头循环的list，因此结构为：  
![在这里插入图片描述][ef054a81b46e4f11a58e8b3c4f38e18b.png]

我们先将得到**头尾的接口**实现一下：

iterator begin()
    {
        
        return _pHead->_pNext;
    }
    iterator end()
    {
        
        return _pHead;
    }
    const_iterator begin() const
    {
        
        return _pHead->_pNext;
    }
    const_iterator end() const
    {
        
        return _pHead;
    }

### 4.1 list capacity ###

<table> 
 <thead> 
  <tr> 
   <th>函数声明</th> 
   <th>接口说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><a href="https://cplusplus.com/reference/list/list/empty/" rel="nofollow">empty</a></td> 
   <td>检测list是否为空，是返回true，否则返回false</td> 
  </tr> 
  <tr> 
   <td><a href="https://cplusplus.com/reference/list/list/size/" rel="nofollow">size</a></td> 
   <td>返回list中有效节点的个数</td> 
  </tr> 
 </tbody> 
</table>

这里两个接口都比较简单，我们直接秒杀。

size_t size() const
    {
        
        int count = 0;
    
        const_iterator it = begin();
        while (it != end())
        {
        
            ++count;
            ++it;
        }
        return count;
    }
    bool empty() const
    {
        
        return _pHead == _pHead->_pNext;
    }

### 4.2 插入删除、交换、清理 ###

<table> 
 <thead> 
  <tr> 
   <th>函数声明</th> 
   <th>接口说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><a href="https://cplusplus.com/reference/list/list/push_front/" rel="nofollow">push_front</a></td> 
   <td>在list首元素前插入值为val的元素</td> 
  </tr> 
  <tr> 
   <td><a href="https://cplusplus.com/reference/list/list/pop_front/" rel="nofollow">pop_front</a></td> 
   <td>删除list中第一个元素</td> 
  </tr> 
  <tr> 
   <td><a href="https://cplusplus.com/reference/list/list/push_back/" rel="nofollow">push_back</a></td> 
   <td>在list尾部插入值为val的元素</td> 
  </tr> 
  <tr> 
   <td><a href="https://cplusplus.com/reference/list/list/pop_back/" rel="nofollow">pop_back</a></td> 
   <td>删除list中最后一个元素</td> 
  </tr> 
  <tr> 
   <td><a href="https://cplusplus.com/reference/list/list/insert/" rel="nofollow">insert</a></td> 
   <td>在list position 位置中插入值为val的元素</td> 
  </tr> 
  <tr> 
   <td><a href="https://cplusplus.com/reference/list/list/erase/" rel="nofollow">erase</a></td> 
   <td>删除list position位置的元素</td> 
  </tr> 
  <tr> 
   <td><a href="https://cplusplus.com/reference/list/list/swap/" rel="nofollow">swap</a></td> 
   <td>交换两个list中的元素</td> 
  </tr> 
  <tr> 
   <td><a href="https://cplusplus.com/reference/list/list/clear/" rel="nofollow">clear</a></td> 
   <td>清空list中的有效元素</td> 
  </tr> 
 </tbody> 
</table>

#### 4.2.1 insert任意位置插入 ####

![在这里插入图片描述][d2e96ffe13214765a1bca402b3d83989.png]

**思路：**  
1、我们先new一个节点newnode，并赋值为x（这里就会去调用list节点类里面的构造函数）；  
2、记下pos位置前一个节点prev，将newnode, prev, pos三个节点连接起来；  
3、返回newnode的迭代器。  
![在这里插入图片描述][c477bac2c4f543c8a1f9cb8ec0adcf61.png]

**代码实现：**

// 在pos位置前插入值为val的节点
    iterator insert(iterator pos, const T& val)
    {
        
        PNode cur = pos._pNode;
        PNode prev = cur->_pPre;
    
        PNode newnode = new Node(val);
        prev->_pNext = newnode;
        newnode->_pPre = prev;
        newnode->_pNext = cur;
        cur->_pPre = newnode;
    
        return newnode;
    }

#### 4.2.2 push\_front头插 ####

![在这里插入图片描述][96db7815de554780a45a2460c3b29c94.png]

对于头插来说，我们直接复用插入的代码就可以。  
头插就是在链表的头部插入一个元素，因此就是 insert(begin(), x);

void push_front(const T& val) {
         insert(begin(), val); }

#### 4.2.3 push\_back尾插 ####

![在这里插入图片描述][474250564c2240e19d9a4d12532834c6.png]

对于尾插也是一样的，直接复用insert代码。  
因为我们list是双向带头循环链表，尾插 insert(end(), x) 直接在尾部前插入即可。end()返回的就是头结点，头结点是哨兵位节点，因此在end()前插就是尾插。

void push_back(const T& val) {
         insert(end(), val); }

#### 4.2.4 erase任意位置删除 ####

![在这里插入图片描述][3adb03a3b5a14ab38ba57f706e59fb2c.png]

**思路：**  
1、分别记下pos前后位置的节点，prev，next；  
2、将prev与next连接起来，释放pos位置节点；  
3、饭后pos下一个位置的节点。

// 删除pos位置的节点，返回该节点的下一个位置
    iterator erase(iterator pos)
    {
        
        PNode cur = pos._pNode;
        PNode prev = cur->_pPre;
        PNode next = cur->_pNext;
    
        delete cur;
        prev->_pNext = next;
        next->_pPre = prev;
    
        return next;
    }

#### 4.2.5 pop\_front头删 ####

![在这里插入图片描述][6dff9cdaeea24ea0b01be999088b8471.png]

对于头删来说，我们直接复用erase代码就可以了。  
头删直接删除掉头部就可以了，erase(begin())。

void pop_front() {
         erase(begin()); }

#### 4.2.6 pop\_back尾删 ####

![在这里插入图片描述][019142dbc505461da500f2d56f410f5a.png]

尾删也是复用erase代码，就是删掉列表的最后一个节点，erase(–end())。

void pop_back() {
         erase(--end()); }

**这里为什么–end()，这里end()返回的是头结点，因为要删除尾结点，所以需要–end()，才是真正的尾结点。**

#### 4.2.7 swap() ####

![在这里插入图片描述][cc251fbc9d0a4e95929992b460df8e5f.png]

list的swap交换，只要交换两个链表的头结点就可以，因为是链式存储的，更换头指针即可。库中提供的交换直接复用就可以。

void swap(list<T>& l) {
         std::swap(_pHead, l._pHead); }

#### 4.2.8 clear ####

对于链表的clear，我们需要释放掉每一个有效节点，因此我们遍历一遍，并复用erase。

void clear()
    {
        
        iterator it = begin();
        while (it != end())
        {
        
            it = erase(it);
        }
    }

## 5、list迭代器失效问题 ##

> 前面说过，此处大家可将迭代器暂时理解成类似于指针，**迭代器失效即迭代器所指向的节点的无效，即该节点被删除了。因为list的底层结构为带头结点的双向循环链表，因此在list中进行插入时是不会导致list的迭代器失效的，只有在删除时才会失效，并且失效的只是指向被删除节点的迭代器，其他迭代器不会受到影响。**

int main()
    {
        
    	list<int> lt;
    	lt.push_back(1);
    	lt.push_back(2);
    	lt.push_back(3);
    	lt.push_back(4);
    	lt.push_back(5);
    
    	list<int>::iterator it = lt.begin();
    	while (it != lt.end())
    	{
        
    		//这里如果先删掉了，再去更新迭代器已经被失效影响了
    		lt.erase(it);
    		++it;
    	}
    
    	return 0;
    }

![在这里插入图片描述][d35e1c90df9d4cd7805b8b3eac1d4fa1.png]

改正：

## 6、list与vector对比 ##

vector与list都是STL中非常重要的序列式容器，由于两个容器的底层结构不同，导致其特性以及应用场景不同，其主要不同如下：

<table> 
 <thead> 
  <tr> 
   <th></th> 
   <th><strong>vector</strong></th> 
   <th>list</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><strong>底 层 结 构</strong></td> 
   <td><strong>动态顺序表，一段连续空间</strong></td> 
   <td><strong>带头结点的双向循环链表</strong></td> 
  </tr> 
  <tr> 
   <td><strong>随 机 访 问</strong></td> 
   <td><strong>支持随机访问，访问某个元素效率O(1)</strong></td> 
   <td><strong>不支持随机访问，访问某个元素效率O(N)</strong></td> 
  </tr> 
  <tr> 
   <td><strong>插 入 和 删 除</strong></td> 
   <td><strong>任意位置插入和删除效率低，需要搬移元素，时间复杂度为O(N)，插入时有可能需要增容，增容：开辟新空间，拷贝元素，释放旧空间，导致效率更低</strong></td> 
   <td><strong>任意位置插入和删除效率高，不需要搬移元素，时间复杂度为O(1)</strong></td> 
  </tr> 
  <tr> 
   <td><strong>空 间 利 用 率</strong></td> 
   <td><strong>底层为连续空间，不容易造成内存碎片，空间利用率高，缓存利用率高</strong></td> 
   <td><strong>底层节点动态开辟，小节点容易造成内存碎片，空间利用率低，缓存利用率低</strong></td> 
  </tr> 
  <tr> 
   <td><strong>迭 代 器</strong></td> 
   <td><strong>原生态指针</strong></td> 
   <td><strong>对原生态指针(节点指针)进行封装</strong></td> 
  </tr> 
  <tr> 
   <td><strong>迭 代 器 失 效</strong></td> 
   <td><strong>在插入元素时，要给所有的迭代器重新赋值，因为插入元素有可能会导致重新扩容，致使原来迭代器失效，删除时，当前迭代器需要重新赋值否则会失效</strong></td> 
   <td><strong>插入元素不会导致迭代器失效，删除元素时，只会导致当前迭代器失效，其他迭代器不受影响</strong></td> 
  </tr> 
  <tr> 
   <td><strong>使 用 场 景</strong></td> 
   <td><strong>需要高效存储，支持随机访问，不关心插入删除效率</strong></td> 
   <td><strong>大量插入和删除操作，不关心随机访问</strong></td> 
  </tr> 
 </tbody> 
</table>

[c2988b85a35c457f8a299bf3846fe491.gif_pic_center]: https://img-blog.csdnimg.cn/c2988b85a35c457f8a299bf3846fe491.gif#pic_center
[list]: https://cplusplus.com/reference/list/list/?kw=list
[ef054a81b46e4f11a58e8b3c4f38e18b.png]: https://img-blog.csdnimg.cn/ef054a81b46e4f11a58e8b3c4f38e18b.png
[d2e96ffe13214765a1bca402b3d83989.png]: https://img-blog.csdnimg.cn/d2e96ffe13214765a1bca402b3d83989.png
[c477bac2c4f543c8a1f9cb8ec0adcf61.png]: https://img-blog.csdnimg.cn/c477bac2c4f543c8a1f9cb8ec0adcf61.png
[96db7815de554780a45a2460c3b29c94.png]: https://img-blog.csdnimg.cn/96db7815de554780a45a2460c3b29c94.png
[474250564c2240e19d9a4d12532834c6.png]: https://img-blog.csdnimg.cn/474250564c2240e19d9a4d12532834c6.png
[3adb03a3b5a14ab38ba57f706e59fb2c.png]: https://img-blog.csdnimg.cn/3adb03a3b5a14ab38ba57f706e59fb2c.png
[6dff9cdaeea24ea0b01be999088b8471.png]: https://img-blog.csdnimg.cn/6dff9cdaeea24ea0b01be999088b8471.png
[019142dbc505461da500f2d56f410f5a.png]: https://img-blog.csdnimg.cn/019142dbc505461da500f2d56f410f5a.png
[cc251fbc9d0a4e95929992b460df8e5f.png]: https://img-blog.csdnimg.cn/cc251fbc9d0a4e95929992b460df8e5f.png
[d35e1c90df9d4cd7805b8b3eac1d4fa1.png]: https://img-blog.csdnimg.cn/d35e1c90df9d4cd7805b8b3eac1d4fa1.png