[C++]list类的模拟实现和相关函数的详解（正反向迭代器）

架构

首先由于自定义类不能和已有类重名，所以在自定义命名空间中进行list类的模拟

正向反向迭代器一般可以写成另外的头文件，引用一下即可，这里方便观察就不再额外写头文件

namespace aiyimu
{
	template<class T>
	struct ListNode//节点
	{};

	//template<class T>
	template<class T, class Ref, class Ptr>
	struct __list_iterator
	{
		typedef ListNode<T> Node;//节点
		typedef __list_iterator<T, Ref, Ptr> self;//需要返回自身的函数时使用

		//typedef __list_iterator<T> self;
		Node* _node;
	};
	
	//反向迭代器
	template <class Iterator, class Ref, class Ptr>
	class reverse_iterator
	{
		typedef reverse_iterator<Iterator, Ref, Ptr> self;
	public:
		//反向迭代器相关成员函数
	private:
		//成员变量
		Iterator _it;
	};

	//list类
	template<class T>
	class list
	{
		typedef ListNode<T> Node;
	public:
		// const和非const
		// 正向迭代器
		typedef __list_iterator<T, T&, T*> iterator;
		typedef __list_iterator<T, const T&, const T*> const_iterator;

		// 反向迭代器
		typedef reverse_iterator<const_iterator, const T&, const T*> const_reverse_iterator;
		typedef reverse_iterator<iterator, T&, T*> reverse_iterator;

		//成员函数

	private:
		//成员变量
		Node* _head;//哨兵位
	};
}

做一个简单解释：

1. 这里是链式链表，是一个个节点组成的，所以模拟实现也一样创建listNode的结构体（节点）
2. __list_iterator 是 list 中使用的迭代器，包含一个指向当前节点的指针 _node。同时定义了 self 别名，用于返回自身的函数时进行类型声明（比如–，++）
3. 迭代器：

---

• iterator：正向迭代器，是 __list_iterator<T, T&, T*> 的别名，用于遍历链表中的元素。
• const_iterator：常量正向迭代器，是 __list_iterator<T, const T&, const T*> 的别名，用于在常量对象上遍历链表中的元素。
• reverse_iterator：反向迭代器，是 reverse_iterator<const_iterator, const T&, const T*> 的别名，用于反向遍历链表中的元素。
• const_reverse_iterator：常量反向迭代器，是 reverse_iterator<iterator, T&, T*> 的别名，用于在常量对象上反向遍历链表中的元素。

代码实现

listNode

1. 节点的结构体：_next：指向链表中下一个节点的指针，初始值为nullptr。
   _prev：指向链表中上一个节点的指针，初始值为nullptr。
   _data：节点中保存的数据，类型为 T。
2. 以及一个构造函数，将listNode的变量初始化

template<class T>
struct ListNode//节点
{
	ListNode<T>* _next;
	ListNode<T>* _prev;
	T _data;

	ListNode(const T& data=T())
		:_next(nullptr)
		,_prev(nullptr)
		,_data(data)
	{}
};

正向迭代器

这里先写以下正向迭代器，后面默认成员函数会用上 and：

• Ref 表示引用类型，通常是节点值的引用
• Ptr 表示指针类型，通常是节点值的指针

框架

template<class T, class Ref, class Ptr>
struct __list_iterator
{
	typedef ListNode<T> Node;//节点
	typedef __list_iterator<T, Ref, Ptr> self;//需要返回自身的函数时使用

	Node* _node;//节点指针
	
	__list_iterator(Node* x)
		:_node(x)
	{}

	//迭代器赋值重载
};

迭代器函数重载

*（解引用）

//解引用
Ref operator*()
{
	return _node->_data;//直接返回该节点的_data
}

为什么返回Ref？

---

而返回引用类型后，operator*()返回的实际上是一个别名
它指向的是已有的节点值，并不需要额外的空间来存储该值。这样就可以有效地避免值拷贝，提高程序效率。

->（箭头指向）

1. 对于一个指针 p，p->x 等价于 (*p).x，其中 x 是指针所指向的对象的一个成员。这是因为指针解引用操作符 * 的优先级更低，所以需要使用括号把它和 x 组合起来形成一个表达式。
2. 在迭代器中，我们可以通过 _node 定位到链表中的某个节点，而节点中存储了元素的值。如果要对这个值进行访问：

一种方式是通过 *_node 访问该值，即取出节点指针所指向的节点，并解引用获取节点值。

另一种方式就是使用箭头操作符 ->，直接从节点指针中访问节点值，即 _node->_data。

3. &_node->_data 就是取出指向节点的指针 _node 所指向的节点中存储的值，并返回指向该值的指针。

Ptr operator->()
{
	return &_node->_data;
}

++ – != ==

这部分逻辑上并不难点，就不过多赘述

// ++it
self& operator++()
{
	//前置++将_node到后一位 返回自己即可
	_node = _node->_next;
	return *this;
}

// it++
self operator++(int)
{
	//后置++需要返回++前的自己，所以先拷贝构造一份自己，++后再返回tmp
	self tmp(*this);
	_node = _node->_next;
	return tmp;
}

// --it
self& operator--()
{
	_node = _node->_prev;
	return *this;
}

// it--
self operator--(int)
{
	__list_iterator<T> tmp(*this);
	_node = _node->_prev;
	return tmp;
}

//bool类型直接返回相应表达式判断
bool operator!=(const self& it) const
{
	return _node != it._node;
}

bool operator==(const self& it) const
{
	return _node == it._node;
}

++，–操作都是返回自身，这里使用self类型

反向迭代器

ps：反向迭代器这里是将近最后才进行实现的，在实现过程还是先写list的默认成员函数和操作函数好些；

• 反向迭代器和正向迭代器的差别就是方向相反，在实现++,–的重载时进行相反的操作即可（++时迭代器向前走）

框架

template <class Iterator, class Ref, class Ptr>
class reverse_iterator
{
	typedef reverse_iterator<Iterator, Ref, Ptr> self;
public:
	//反向迭代器相关成员函数
	reverse_iterator(Iterator it)
		:_it(it)
	{}
private:
	//成员变量
	Iterator _it;
};

先简单看一段c++反向迭代器的源码：

由此可以看出这里的源码实现中rend()对应begin()的位置，rbegin()对应end()

而源码中的解引用是取前一位，也是为了将指针对应，其实不是必需的，但这里按照源码的方式写：

*（解引用）

1. 由于每次*取的是前一位，所以当rbegin走到倒数第二位时（即正向第二个节点）就停下，但此时在倒数第二位已经把最后一位取出来，所以遍历不会出现问题
2. 其余的部分疑问在正向迭代器中解答

//解引用
Ref operator*()
{
	Iterator prev = _it;
	return *--prev;	//返回上一位
}

->（箭头指向）

Ptr operator->()
{
	return &operator*();
}

++ – != ==

这里的实现和正向迭代器恰好相反即可

// ++it
self& operator++()
{
	--_it;
	return *this;
}

self& operator--()
{
	++_it;
	return *this;
}

bool operator!= (const self& rit) const
{
	return _it != rit._it;
}

++，–操作都是返回自身，这里使用self类型

list

默认成员函数

构造函数

无参构造

1. 创建哨兵位头节点，让其自己指向自己

list()
{
	_head = new Node();
	_head->_next = _head;
	_head->_prev = _head;
}

带参构造（初始化）

1. 给链表传入n个值为val的T类型参数
2. 插入过程用for循环遍历直接push_back()（尾插函数，后面实现）即可

list(int n, const T& val = T())
{
	_head = new Node();
	_head->_next = _head;
	_head->_prev = _head;
	for (int i = 0; i < n; ++i)
	{
		push_back(val);
	}
}

利用迭代器构造

1. 和前者相差不大，就是传入参数是迭代器类型，这里
   用模板参数InputIterator，因为不能确定传入的迭代器类型
2. 插入过程利用传入的迭代器，当first!=last就继续

template<class InputIterator>
list(InputIterator first, InputIterator last)
{
	_head = new Node();
	_head->_next = _head;
	_head->_prev = _head;
	while (first != last)
	{
		push_back(*first);
		++first;
	}
}

拷贝构造

常规拷贝

1. 首先进行哨兵位的创建链接，然后通过迭代器构造 定义临时列表 tmp 存储lt的内容
2. 用std::swap交换两个哨兵位，完成拷贝构造

list(const list<T>& lt)
{
	_head = new Node();
	_head->_next = _head;
	_head->_prev = _head;

	list<T> tmp(lt.begin(), lt.end());
	std::swap(_head, tmp._head);
}

赋值重载

• list<T> lt：为传入的新容器副本，使用值传递方式传入
• std::swap(_head, lt._head)：将当前对象和副本对象的头节点指针交换，即将当前对象中原有的元素全部释放，再拷贝副本对象中的所有元素到当前对象中。实现了深拷贝操作。

list<T>& operator=(list<T> lt)
{
	std::swap(_head, lt._head);
	return *this;
}

析构

1. 析构函数用于清理资源，首先将list 的所有元素销毁
2. 然后删除哨兵位再置空

~list()
{
	clear();	//清除list的所有元素

	delete _head;
	_head = nullptr;
}

正向迭代器函数

begin() && end()

1. begin和end函数主要用于使用迭代器时找到相应节点位置，分别为链表头和尾的位置。
2. 同样进行const类和非const类两种写法

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

部分操作函数

push_back()

1. push_back()尾插函数，难点并不在此，创建节点之后更改链接关系即可
2. 这里画个简图（链表是双向的，这里的箭头只是简要表示多个节点）

void push_back(const T& x)
{
	Node* tail = _head->_prev;
	Node* newnode = new Node(x);

	//建立链接关系
	tail->_next = newnode;
	newnode->_prev = tail;
	newnode->_next = _head;
	_head->_prev = newnode;
}

clear()

1. 清空链表元素的函数：
2. 用迭代器遍历链表，每次删除节点（这里需要每次创建一个临时del，因为如果直接删除it，就找不到下一个节点）

void clear()
{
	iterator it = begin();、
	//遍历删除
	while (it != end())
	{
		iterator del = it++;
		delete del._node;
	}
	
	//将哨兵位指针指向自己
	_head->_next = _head;
	_head->_prev = _head;
}

list_print()

1. 打印链表：传入的参数为const类型，所以使用的迭代器也是const类
2. 迭代器遍历链表，打印即可

//打印链表
void print_list(const list<int>& lt)
{
	list<int>::const_iterator it = lt.begin();
	while (it != lt.end())
	{
		cout << *it << endl;
		++it;
	}
	cout << endl;
}

insert()

1. insert()向任意位置插入节点：
2. 保存pos位置的节点（要插入的位置）和pos前一位置的节点，并创建新节点
3. 更改指针链接关系，这里作简图
4. 返回迭代器类型用于 获取到新插入节点的指针，并将其作为迭代器返回，使用户能够方便地继续对容器进行操作

iterator insert(iterator pos, const T& x)
{
	Node* cur = pos._node;//pos当前位置
	Node* prev = cur->_prev;//pos前一位置
	Node* newnode = new Node(x);//创建节点

	//链接关系
	prev->_next = newnode;
	newnode->_prev = prev;
	
	newnode->_next = cur;
	cur->_prev = newnode;

	return iterator(newnode);//返回新插入的节点
}

写完insert后可以对push_back进行简化并写出其余的插入：

push_back()（简化）

• 尾插直接调用insert()函数在end()位插入x即可

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

push_front()

• push_front()同理，头插直接调用insert()函数在begin()位插入x即可

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

erase()

1. 和insert()相同道理，注意删除的位置不能为end()
2. 保存pos前一位后一位，释放pos指向的空间，将pos前一位和后一位连接

iterator erase(iterator pos)
{
	assert(pos != end());//不能删除哨兵位

	Node* prev = pos._node->_prev;// pos的前一位
	Node* next = pos._node->_next;// pos的后一位

	delete pos._node;//删除该位置节点
	//链接关系
	prev->_next = next;
	next->_prev = prev;

	return iterator(next);//返回此时pos的位置即next
}

此时可以调用erase()写出头删尾删：

pop_back()

• 需要注意end()返回的是哨兵位，而--end()即_head->prev，即尾部节点

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

pop_front()

• 删除begin()位节点即可（即_head->next）

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