C++：stl：list的常用接口及其模拟实现

本文主要介绍c++：stl中list常用接口的功能及使用方法，比较list与vector的区别，并对list的常用接口进行模拟实现。

目录

一、list的介绍和使用

1.list介绍

2.list使用

1.list的构造

2.list iterator的使用

3.list 容量相关

4.list元素访问

5.list修改

6.list的迭代器失效

二、list的模拟实现

1.list的节点类

2.list的迭代器类

1.正向迭代器

2.反向迭代器

3.list类

三、list和vector的对比

---

一、list的介绍和使用

1.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来说这可能是一个重要的因素)

2.list使用

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

1.list的构造

void test1()
{
    list<int> lt1;                         // 构造空的lt1
    list<int> lt2(4, 100);                 // lt2中放4个值为100的元素
    list<int> lt3(lt2.begin(), lt2.end());  //用lt2的[begin(), end()）左闭右开的区间构造lt3
    list<int> lt4(lt3);                    // 用lt3拷贝构造lt4
 
    // 以数组为迭代器区间构造l5
    int array[] = { 10,20,30,40 };
    list<int> lt5(array, array + sizeof(array) / sizeof(int));
 
    // 列表格式初始化C++11
    list<int> lt6{ 1,2,3,4,5 };
 
    // 用迭代器方式打印l5中的元素
    list<int>::iterator it = lt5.begin();
    while (it != lt5.end())
    {
        cout << *it << " ";
        ++it;
    }
    cout << endl;
    //10 20 30 40
    // C++11范围for的方式遍历
    for (auto& e : lt5)
        cout << e << " ";
    cout << endl;
    //10 20 30 40
}

2.list iterator的使用

此处可以将迭代器理解成一个指针，该指针指向list中的某个节点。

void test2()
{
    int array[] = { 1, 2, 3, 4, 5};
    list<int> lt(array, array + sizeof(array) / sizeof(array[0]));
    // 使用正向迭代器正向list中的元素
    // list::iterator it = l.begin();   // C++98中语法
    auto it = lt.begin();                     // C++11之后推荐写法
    while (it != lt.end())
    {
        cout << *it << " ";
        ++it;
    }
    cout << endl;//1 2 3 4 5 
 
    // 使用反向迭代器逆向打印list中的元素
    // list::reverse_iterator rit = l.rbegin();
    auto rit = lt.rbegin();
    while (rit != lt.rend())
    {
        cout << *rit << " ";
        ++rit;
    }
    cout << endl;//1 2 3 4 5
}

注意：

1. begin与end为正向迭代器，对迭代器执行++操作，迭代器向后移动

2. rbegin(end)与rend(begin)为反向迭代器，对迭代器执行++操作，迭代器向前移动

3.list 容量相关

void test3()
{
    int array[] = { 1, 2, 3, 4, 5 };
    list<int> lt(array, array + sizeof(array) / sizeof(array[0]));
    if (!lt.empty())
        cout << "false" << endl;//false
    cout<size() << endl;//5
}

4.list元素访问

void test4()
{
    int array[] = { 1, 2, 3, 4, 5 };
    list<int> lt(array, array + sizeof(array) / sizeof(array[0]));
    cout << lt.front() << endl;//1
    cout << lt.back() << endl;//5
}

5.list修改

void PrintList(const list<int>& lt)
{
    // 注意这里调用的是list的 begin() const，返回list的const_iterator对象
    for (list<int>::const_iterator it = lt.begin(); it != lt.end(); ++it)
    {
        cout << *it << " ";
        // *it = 10; 编译不通过
    }
 
    cout << endl;
}
 
// push_back/pop_back/push_front/pop_front
void test5()
{
    int array[] = { 1, 2, 3 };
    list<int> lt(array, array + sizeof(array) / sizeof(array[0]));
 
    // 在list的尾部插入4，头部插入0
    lt.push_back(4);
    lt.push_front(0);
    PrintList(lt);//0 1 2 3 4
 
    // 删除list尾部节点和头部节点
    lt.pop_back();
    lt.pop_front();
    PrintList(lt);//1 2 3
}

// insert /erase 
void test6()
{
    int array1[] = { 1, 2, 3 };
    list<int> lt(array1, array1 + sizeof(array1) / sizeof(array1[0]));
 
    // 获取链表中第二个节点
    auto pos = ++lt.begin();
    cout << *pos << endl;//2
 
    // 在pos前插入值为4的元素
    lt.insert(pos, 4);
    PrintList(lt);//1 4 2 3
 
    // 在pos前插入5个值为5的元素
    lt.insert(pos, 5, 5);
    PrintList(lt);//1 4 5 5 5 5 5 2 3
 
    // 在pos前插入[v.begin(), v.end)区间中的元素
    vector<int> v{ 7, 8, 9 };
    lt.insert(pos, v.begin(), v.end());
    PrintList(lt);//1 4 5 5 5 5 5 7 8 9 2 3
 
    // 删除pos位置上的元素
    lt.erase(pos);
    PrintList(lt);//1 4 5 5 5 5 5 7 8 9 3
 
    // 删除list中[begin, end)区间中的元素，即删除list中的所有元素
    lt.erase(lt.begin(), lt.end());
    PrintList(lt);//
}

// resize/swap/clear
void test7()
{
    // 用数组来构造list
    int array1[] = { 1, 2, 3 };
    list<int> lt1(array1, array1 + sizeof(array1) / sizeof(array1[0]));
    PrintList(lt1);//1 2 3
 
    // 交换l1和l2中的元素
    list<int> lt2;
    lt1.swap(lt2);
    PrintList(lt1);//
    PrintList(lt2);//1 2 3
 
    // 将l2中的元素清空
    lt2.clear();
    cout << lt2.size() << endl;//0
}

list中还有一些操作，需要用到时可参阅list的文档说明。

6.list的迭代器失效

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

void TestListIterator1()
{
    int array[] = { 1, 2, 3, 4, 5, 6, 7, 8, 9, 0 };
    list<int> lt(array, array + sizeof(array) / sizeof(array[0]));
    auto it = lt.begin();
    while (it != lt.end())
    {
        // erase()函数执行后，it所指向的节点已被删除，
        // 因此it无效，在下一次使用it时，必须先给其赋值
            lt.erase(it);
        ++it;
    }
}
// 改正
void TestListIterator2()
{
    int array[] = { 1, 2, 3, 4, 5, 6, 7, 8, 9, 0 };
    list<int> lt(array, array + sizeof(array) / sizeof(array[0]));
    auto it = lt.begin();
    while (it != lt.end())
    {
        lt.erase(it++); // it = l.erase(it);
    }
}

二、list的模拟实现

1.list的节点类

 template<class T>
 struct ListNode
 {
     ListNode(const T& val = T())
         :_prev(nullptr)
         , _next(nullptr)
         , _val(val)
     {}
     ListNode* _prev;
     ListNode* _next;
     T _val;
 };

2.list的迭代器类

1.正向迭代器

迭代器有两种实现方式，具体应根据容器底层数据结构实现：

1. 原生态指针，比如：vector

2. 将原生态指针进行封装，因迭代器使用形式与指针完全相同，因此在自定义的类中必须实现以下方法：

        1. 指针可以解引用，迭代器的类中必须重载operator*()

        2. 指针可以通过->访问其所指空间成员，迭代器类中必须重载oprator->()

        3. 指针可以++向后移动，迭代器类中必须重载operator++()与operator++(int)

        至于operator--()/operator--(int)释放需要重载，根据具体的结构来抉择，双向链表可以向前移动，所以需要重载，如果是forward_list就不需要重载--

        4. 迭代器需要进行是否相等的比较，因此还需要重载operator==()与operator!=()

template<class T, class Ref, class Ptr>
//Ref和Ptr分布表示 T& 和 T* 或者const T& 和const T*
class ListIterator
{
    typedef ListNode Node;
    typedef ListIterator Self;
    // Ref 和 Ptr 类型需要重定义下，实现反向迭代器时需要用到
public:
    typedef Ref Ref;
    typedef Ptr Ptr;
public:
    Node* _node;
 
    // 构造
    ListIterator(Node* node = nullptr)
        : _node(node)
    {}
 
    // 具有指针类似行为
    Ref operator*()
    {
        return _node->_val;
    }
    Ptr operator->()
    {
        return &(operator*());
    }
 
    // 迭代器移动
    Self& operator++()
    {
        _node = _node->_next;
        return *this;
    }
    Self operator++(int)
    {
        Self temp(*this);
        _node = _node->_next;
        return temp;
    }
    Self& operator--()
    {
        _node = _node->_prev;
        return *this;
    }
    Self operator--(int)
    {
        Self temp(*this);
        _node = _node->_prev;
        return temp;
    }
 
    // 迭代器比较
    bool operator!=(const Self& l)const
    {
        return _node != l._node;
    }
 
    bool operator==(const Self& l)const
    {
        return _node != l._node;
    }
};

2.反向迭代器

通过前面例子知道，反向迭代器的++就是正向迭代器的--，反向迭代器的--就是正向迭代器的++，因此反向迭代器的实现可以借助正向迭代器，即：反向迭代器内部可以包含一个正向迭代器，对正向迭代器的接口进行包装即可。

template<class Iterator>
class ReverseListIterator
{
    // 注意：此处typename的作用是明确告诉编译器，Ref是Iterator类中的一个类型，而不是静态成员变量
    // 否则编译器编译时就不知道Ref是Iterator中的类型还是静态成员变量
    // 因为静态成员变量也是按照类名::静态成员变量名的方式访问的
public:
    typedef typename Iterator::Ref Ref;
    typedef typename Iterator::Ptr Ptr;
    typedef ReverseListIterator Self;
public:
    Iterator _it;
 
    // 构造
    ReverseListIterator(Iterator it)
        : _it(it)
    {}
 
    // 具有指针类似行为
    Ref operator*()
    {
        Iterator temp(_it);
        --temp;
        return *temp;
    }
 
    Ptr operator->()
    {
        return &(operator*());
    }
 
    // 迭代器移动
    Self& operator++()
    {
        --_it;
        return *this;
    }
 
    Self operator++(int)
    {
        Self temp(*this);
        --_it;
        return temp;
    }
 
    Self& operator--()
    {
        ++_it;
        return *this;
    }
 
    Self operator--(int)
    {
        Self temp(*this);
        ++_it;
        return temp;
    }
 
    // 迭代器比较
    bool operator!=(const Self& l)const
    {
        return _it != l._it;
    }
 
    bool operator==(const Self& l)const
    {
        return _it != l._it;
    }
};

3.list类

template<class T>
class list
{
	typedef ListNode Node;
 
public:
	// 正向迭代器
	typedef ListIterator iterator;
	typedef ListIteratorconst T&, const T&> const_iterator;
 
	// 反向迭代器
	typedef ReverseListIterator reverse_iterator;
	typedef ReverseListIterator const_reverse_iterator;
public:
 
	// List的构造
	list()
	{
		CreateHead();
	}
 
	list(int n, const T& value = T())
	{
		CreateHead();
		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;
		}
	}
 
	list(const list& l)
	{
		CreateHead();
 
		// 用l中的元素构造临时的temp,然后与当前对象交换
		list temp(l.begin(), l.end());
		this->swap(temp);
	}
 
	list& operator=(list l)
	{
		this->swap(l);
		return *this;
	}
 
	~list()
	{
		clear();
		delete _head;
		_head = nullptr;
	}
 
	// List的迭代器
	iterator begin()
	{
		return iterator(_head->_next);
	}
 
	iterator end()
	{
		return iterator(_head);
	}
 
	const_iterator begin()const
	{
		return const_iterator(_head->_next);
	}
 
	const_iterator end()const
	{
		return const_iterator(_head);
	}
 
	reverse_iterator rbegin()
	{
		return reverse_iterator(end());
	}
 
	reverse_iterator rend()
	{
		return reverse_iterator(begin());
	}
 
	const_reverse_iterator rbegin()const
	{
		return const_reverse_iterator(end());
	}
 
	const_reverse_iterator rend()const
	{
		return const_reverse_iterator(begin());
	}
 
	// List的容量相关
	size_t size()const
	{
		Node* cur = _head->_next;
		size_t count = 0;
		while (cur != _head)
		{
			count++;
			cur = cur->_next;
		}
 
		return count;
	}
 
	bool empty()const
	{
		return _head->_next == _head;
	}
 
	void resize(size_t newsize, const T& data = T())
	{
		size_t oldsize = size();
		if (newsize <= oldsize)
		{
			// 有效元素个数减少到newsize
			while (newsize < oldsize)
			{
				pop_back();
				oldsize--;
			}
		}
		else
		{
			while (oldsize < newsize)
			{
				push_back(data);
				oldsize++;
			}
		}
	}
	// List的元素访问操作
	// 注意：List不支持operator[]
	T& front()
	{
		return _head->_next->_val;
	}
 
	const T& front()const
	{
		return _head->_next->_val;
	}
 
	T& back()
	{
		return _head->_prev->_val;
	}
 
	const T& back()const
	{
		return _head->_prev->_val;
	}
 
	// List的插入和删除
	void push_back(const T& val)
	{
		insert(end(), val);
	}
 
	void pop_back()
	{
		erase(--end());
	}
 
	void push_front(const T& val)
	{
		insert(begin(), val);
	}
 
	void pop_front()
	{
		erase(begin());
	}
 
	// 在pos位置前插入值为val的节点
	iterator insert(iterator pos, const T& val)
	{
		Node* pNewNode = new Node(val);
		Node* pCur = pos._node;
		// 先将新节点插入
		pNewNode->_prev = pCur->_prev;
		pNewNode->_next = pCur;
		pNewNode->_prev->_next = pNewNode;
		pCur->_prev = pNewNode;
		return iterator(pNewNode);
	}
 
	// 删除pos位置的节点，返回该节点的下一个位置
	iterator erase(iterator pos)
	{
		// 找到待删除的节点
		Node* pDel = pos._node;
		Node* pRet = pDel->_next;
 
		// 将该节点从链表中拆下来并删除
		pDel->_prev->_next = pDel->_next;
		pDel->_next->_prev = pDel->_prev;
		delete pDel;
 
		return iterator(pRet);
	}
 
	void clear()
	{
		Node* cur = _head->_next;
 
		// 采用头删除删除
		while (cur != _head)
		{
			_head->_next = cur->_next;
			delete cur;
			cur = _head->_next;
		}
 
		_head->_next = _head->_prev = _head;
	}
 
	void swap(bite::list& l)
	{
		std::swap(_head, l._head);
	}
 
private:
	void CreateHead()
	{
		_head = new Node;
		_head->_prev = _head;
		_head->_next = _head;
	}
private:
	Node* _head;
};

三、list和vector的对比

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