系统性学习C++-第十八讲-封装红黑树实现myset与mymap

系统性学习C++-第十八讲-封装红黑树实现myset与mymap

• [1. 源码及框架分析](#1. 源码及框架分析)
• [2. 模拟实现map和set](#2. 模拟实现map和set)
• • [2.1 实现出复用红黑树的框架，并支持 insert](#2.1 实现出复用红黑树的框架，并支持 insert)
  • [2.2 支持 iterator 的实现](#2.2 支持 iterator 的实现)
  • [2.3 map支持 [ ]](#2.3 map支持 [ ])
  • [2.4 bit::map 和 bit::set 代码实现](#2.4 bit::map 和 bit::set 代码实现)

1. 源码及框架分析

SGI-STL30 版本源代码，map 和 set 的源代码在 map / set / stl_map.h / stl_set.h / stl_tree.h 等⼏个头⽂件中。

map和set的实现结构框架核⼼部分截取出来如下：

// set
#ifndef __SGI_STL_INTERNAL_TREE_H
#include <stl_tree.h>
#endif
#include <stl_set.h>
#include <stl_multiset.h>
// map
#ifndef __SGI_STL_INTERNAL_TREE_H
#include <stl_tree.h>
#endif
#include <stl_map.h>
#include <stl_multimap.h>
// stl_set.h
template <class Key, class Compare = less<Key>, class Alloc = alloc>
class set {
public:
	// typedefs:
	typedef Key key_type;
	typedef Key value_type;
private:
	typedef rb_tree<key_type, value_type,
	identity<value_type>, key_compare, Alloc> rep_type;
	rep_type t; // red-black tree representing set
};

// stl_map.h
template <class Key, class T, class Compare = less<Key>, class Alloc = alloc>
class map {
public:
	// typedefs:
	typedef Key key_type;
	typedef T mapped_type;
	typedef pair<const Key, T> value_type;
private:
	typedef rb_tree<key_type, value_type,
	select1st<value_type>, key_compare, Alloc> rep_type;
	rep_type t; // red-black tree representing map
};

// stl_tree.h
struct __rb_tree_node_base
{
	typedef __rb_tree_color_type color_type;
	typedef __rb_tree_node_base* base_ptr;
	color_type color;
	base_ptr parent;
	base_ptr left;
	base_ptr right;
};

// stl_tree.h
template <class Key, class Value, class KeyOfValue, class Compare, class Alloc
= alloc>
class rb_tree {
protected:
	typedef void* void_pointer;
	typedef __rb_tree_node_base* base_ptr;
	typedef __rb_tree_node<Value> rb_tree_node;
	typedef rb_tree_node* link_type;
	typedef Key key_type;
	typedef Value value_type;
public:
	// insert⽤的是第⼆个模板参数左形参
	pair<iterator,bool> insert_unique(const value_type& x);
	// erase和find⽤第⼀个模板参数做形参
	size_type erase(const key_type& x);
	iterator find(const key_type& x);
protected:
	size_type node_count; // keeps track of size of tree
	link_type header;
};

template <class Value>
struct __rb_tree_node : public __rb_tree_node_base
{
	typedef __rb_tree_node<Value>* link_type;
	Value value_field;
};

2. 模拟实现map和set

2.1 实现出复用红黑树的框架，并支持 insert

• 参考源码框架，map 和 set 复⽤之前我们实现的红黑树。

• 我们这里相比源码调整⼀下，key 参数就用 K ，value 参数就用 V ，红⿊树中的数据类型，我们使用 T 。

• 其次因为RBTree 实现了泛型不知道 T 参数到底是 K ，还是 pair<K, V> ，那么 insert 内部进⾏插入逻辑比较时，就没办法进行比较，因为 pair 的默认支持的是 key 和 value 一起参与比较，我们需要时的任何时候只比较 key ，所以我们在 map 和 set 层分别实现⼀个 MapKeyOfT 和 SetKeyOfT 的仿函数传给 RBTree 的 KeyOfT ，然后 RBTree 中通过 KeyOfT 仿函数取出 T 类型对象中的 key ，再进⾏⽐较，具体细节参考如下代码实现。

// 源码中pair⽀持的<重载实现
template <class T1, class T2>
bool operator< (const pair<T1,T2>& lhs, const pair<T1,T2>& rhs)
	{ return lhs.first<rhs.first || (!(rhs.first<lhs.first) &&
	lhs.second<rhs.second); }

// Mymap.h
namespace Code_map
{
	template<class K, class V>
	class map
	{
		struct MapKeyOfT
		{
			const K& operator()(const pair<K, V>& kv)
			{
				return kv.first;
			}
		};
	public:
		bool insert(const pair<K, V>& kv)
		{
			return _t.Insert(kv);
		}
	private:
		RBTree<K, pair<K, V>, MapKeyOfT> _t;
	};
}

// Myset.h
namespace Code_set
{
	template<class K>
	class set
	{
		struct SetKeyOfT
		{
			const K& operator()(const K& key)
			{
				return key;
			}
		};
	public:
		bool insert(const K& key)
		{
			return _t.Insert(key);
		}
	private:
		RBTree<K, K, SetKeyOfT> _t;
	};
}

// RBTree.h
enum Colour
{
	RED,
	BLACK
};

template<class T>
struct RBTreeNode
{
	T _data;
	RBTreeNode<T>* _left;
	RBTreeNode<T>* _right;
	RBTreeNode<T>* _parent;
	Colour _col;
	RBTreeNode(const T& data)
		: _data(data)
		, _left(nullptr)
		, _right(nullptr)
		, _parent(nullptr)
	{}
};

// 实现步骤：
// 1、实现红⿊树
// 2、封装map和set框架，解决KeyOfT
// 3、iterator
// 4、const_iterator
// 5、key不⽀持修改的问题
// 6、operator[]

template<class K, class T, class KeyOfT>
class RBTree
{
private:
	typedef RBTreeNode<T> Node;
	Node* _root = nullptr;

public:
	bool Insert(const T& data)
	{
		if (_root == nullptr)
		{
			_root = new Node(data);
			_root->_col = BLACK;
			return true;
		}
		
		KeyOfT kot;
		Node* parent = nullptr;
		Node* cur = _root;
		while (cur)
		{
			if (kot(cur->_data) < kot(data))
			{
				parent = cur;
				cur = cur->_right;
			}
			else if (kot(cur->_data) > kot(data))
			{
				parent = cur;
				cur = cur->_left;
			}
			else
			{
				return false;
			}
		}
		cur = new Node(data);
		Node* newnode = cur;
		// 新增结点。颜⾊给红⾊
		cur->_col = RED;
		if (kot(parent->_data) < kot(data))
		{
			parent->_right = cur;
		}
		else
		{
			parent->_left = cur;
		}
		cur->_parent = parent;
		//...
		return true;
	}
};

2.2 支持 iterator 的实现

iterator 核心源代码

struct __rb_tree_base_iterator
{
	typedef __rb_tree_node_base::base_ptr base_ptr;
	base_ptr node;
	void increment()
	{
		if (node->right != 0) 
		{
			node = node->right;
			while (node->left != 0)
				node = node->left;
		}
		else 
		{
			base_ptr y = node->parent;
			while (node == y->right) 
				{
					node = y;
					y = y->parent;
				}
			if (node->right != y)
				node = y;
		}
};

void decrement()
{
	if (node->color == __rb_tree_red &&
		node->parent->parent == node)
			node = node->right;
	else if (node->left != 0) {
		base_ptr y = node->left;
		while (y->right != 0)
			y = y->right;
			node = y;
		}
	else {
			base_ptr y = node->parent;
			while (node == y->left) {
				node = y;
				y = y->parent;
			}
			node = y;
		}
	}
};

template <class Value, class Ref, class Ptr>
struct __rb_tree_iterator : public __rb_tree_base_iterator
{
	typedef Value value_type;
	typedef Ref reference;
	typedef Ptr pointer;
	typedef __rb_tree_iterator<Value, Value&, Value*> iterator;
	__rb_tree_iterator() {}
	__rb_tree_iterator(link_type x) { node = x; }
	__rb_tree_iterator(const iterator& it) { node = it.node; }
	reference operator*() const { return link_type(node)->value_field; }
	#ifndef __SGI_STL_NO_ARROW_OPERATOR
	pointer operator->() const { return &(operator*()); }
	#endif /* __SGI_STL_NO_ARROW_OPERATOR */
	self& operator++() { increment(); return *this; }
	self& operator--() { decrement(); return *this; }
	inline bool operator==(const __rb_tree_base_iterator& x,
						   const __rb_tree_base_iterator& y) {
		return x.node == y.node;
	}

	inline bool operator!=(const __rb_tree_base_iterator& x,
					  	   const __rb_tree_base_iterator& y) {
		return x.node != y.node:
	}

iterator 实现思路分析

• iterator 实现的大框架跟 list 的 iterator 思路是一致，用一个类型封装结点的指针，再通过重载运算符实现，迭代器像指针⼀样访问的。

• 这里的难点是 operator++ 和 operator-- 的实现。之前使用部分，我们分析了，map 和 set 的迭代器走的是中序遍历，左子树 -> 根结点 -> 右子树，那么 begin() 会返回中序第一个结点的 iterator 也就是 10 所在结点的迭代器。

• 迭代器 ++ 的核心逻辑就是不看全局，只看局部，只考虑当前中序局部要访问的下一个结点。

• 迭代器 ++ 时，如果 it 指向的结点的右子树不为空，代表当前结点已经访问完了，要访问下一个结点是右子树的中序第一个，一棵树中序第一个是最左结点，所以直接找右子树的最左结点即可。

• 迭代器 ++ 时，如果 it 指向的结点的右子树空，代表当前结点已经访问完了且当前结点所在的子树也访问完了，要访问的下⼀个结点在当前结点的祖先里面，所以要沿着当前结点到根的祖先路径向上找。

• 如果当前结点是父亲的左，根据中序 左子树 -> 根结点 -> 右子树 ，那么下⼀个访问的结点就是当前结点的父亲；如下图：it 指向 25 ，25 右为空，25 是 30 的左，所以下一个访问的结点就是 30 。

• 如果当前结点是父亲的右，根据中序 左子树 -> 根结点 -> 右子树 ，当前当前结点所在的子树访问完了，当前结点所在父亲的子树也访问完了，那么下一个访问的需要继续往根的祖先中去找，直到找到孩⼦是父亲左的那个祖先就是中序要问题的下⼀个结点。

  如下图：it 指向 15 ，15 右为空，15 是 10 的右，15 所在子树话访问完了，10 所在子树也访问完了，继续往上找，10 是 18 的左，那么下一个访问的结点就是 18 。

• end() 如何表示呢？如下图：当 it 指向 50 时，++it 时，50 是 40 的右，40 是 30 的右，30 是 18 的右，18到根没有父亲，没有找到孩⼦是父亲左的那个祖先，这是父亲为空了，那我们就把 it 中的结点指针置为 nullptr ，我们用 nullptr 去充当end 。需要注意的是stl 源码中，红黑树增加了⼀个哨兵位头结点作为 end() ，这哨兵位头结点和根互为父亲，左指向最左结点，右指向最右结点。相比我们用 nullptr 作为 end() ，差别不大，他能实现的，我们也能实现。只是 --end() 判断到结点时空，特殊处理⼀下，让迭代器结点指向最右结点。具体参考迭代器 -- 实现。

• 迭代器 -- 的实现跟 ++ 的思路完全类似，逻辑正好反过来即可，因为他访问顺序是右子树 -> 根结点 -> 左子树，具体参考下面代码实现。

• set 的 iterator 也不支持修改，我们把 set 的第二个模板参数改成 const K 即可， RBTree<K,const K, SetKeyOfT> _t;

• map 的 iterator 不支持修改 key 但是可以修改 value ，我们把 map 的第二个模板参数 pair 的第一个参数改成 const K 即可， RBTree<K, pair<const K, V>, MapKeyOfT> _t;

• ⽀持完整的迭代器还有很多细节需要修改，具体参考下面题的代码

2.3 map支持 [ ]

• map 要支持 [] 主要需要修改 insert 返回值支持，修改 RBtree 中的 insert 返回值为
  pair<Iterator, bool> Insert(const T& data)
• 有了 insert 支持 [] 实现就很简单了，具体参考下面代码实现

2.4 bit::map 和 bit::set 代码实现

// Myset.h
#include"RBTree.h"
namespace Code_set
{
	template<class K>
	class set
	{
		struct SetKeyOfT
		{
			const K& operator()(const K& key)
			{
				return key;
			}
		};
	public:
		typedef typename RBTree<K, const K, SetKeyOfT>::Iterator iterator;
		typedef typename RBTree<K, const K, SetKeyOfT>::ConstIterator const_iterator;
		iterator begin()
		{	
			return _t.Begin();
		}
		iterator end()
		{
			return _t.End();
		}
		const_iterator begin() const
		{
			return _t.Begin();
		}
		const_iterator end() const
		{
			return _t.End();
		}
		pair<iterator, bool> insert(const K& key)
		{
			return _t.Insert(key);
		}
		iterator find(const K& key)
		{
			return _t.Find(key);
		}
	private:
		RBTree<K, const K, SetKeyOfT> _t;
};

void Print(const set<int>& s)
{
	set<int>::const_iterator it = s.end();
	while (it != s.begin())
	{
		--it;
		// 不⽀持修改
		//*it += 2;
		cout << *it << " ";
	}
	cout << endl;
}

void test_set()
{
	set<int> s;
	int a[] = { 4, 2, 6, 1, 3, 5, 15, 7, 16, 14 };
	for (auto e : a)
	{
		s.insert(e);
	}
	for (auto e : s)
	{
		cout << e << " ";
	}
	cout << endl;
	Print(s);
	}
}

// Mymap.h
#include"RBTree.h"
namespace Code_RBTree
{
	template<class K, class V>
	class map
	{
		struct MapKeyOfT
		{
			const K& operator()(const pair<K, V>& kv)
			{
				return kv.first;
			}
		};
		public:
			typedef typename RBTree<K, pair<const K, V>, MapKeyOfT>::Iterator iterator;
			typedef typename RBTree<K, pair<const K, V>, MapKeyOfT>::ConstIterator const_iterator;
			iterator begin()
			{
				return _t.Begin();
			}
			iterator end()
			{
				return _t.End();
			}
			const_iterator begin() const
			{
				return _t.Begin();
			}
			const_iterator end() const
			{
				return _t.End();
			}
			pair<iterator, bool> insert(const pair<K, V>& kv)
			{
				return _t.Insert(kv);
			}
			iterator find(const K& key)
			{
				return _t.Find(key);
			}
			V& operator[](const K& key)
			{
				pair<iterator, bool> ret = insert(make_pair(key, V()));
				return ret.first->second;
			}
		private:
			RBTree<K, pair<const K, V>, MapKeyOfT> _t;
	};
	void test_map()
	{
		map<string, string> dict;
		dict.insert({ "sort", "排序" });
		dict.insert({ "left", "左边" });
		dict.insert({ "right", "右边" });
		dict["left"] = "左边，剩余";
		dict["insert"] = "插⼊";
		dict["string"];
		map<string, string>::iterator it = dict.begin();
		while (it != dict.end())
		{
			// 不能修改first，可以修改second
			//it->first += 'x';
			it->second += 'x';
			cout << it->first << ":" << it->second << endl;
			++it;
		}
		cout << endl;
	}
}

// RBtree.h
enum Colour
{
	RED,
	BLACK
};

template<class T>
struct RBTreeNode
{
	T _data;
	RBTreeNode<T>* _left;
	RBTreeNode<T>* _right;
	RBTreeNode<T>* _parent;
	Colour _col;
	RBTreeNode(const T& data)
		: _data(data)
		, _left(nullptr)
		, _right(nullptr)
		, _parent(nullptr)
	{}
};

template<class T, class Ref, class Ptr>
struct RBTreeIterator
{
	typedef RBTreeNode<T> Node;
	typedef RBTreeIterator<T, Ref, Ptr> Self;
	Node* _node;
	Node* _root;
	RBTreeIterator(Node* node, Node* root)
		:_node(node)
		,_root(root)
	{}
	Self& operator++()
	{
		if (_node->_right)
		{
			// 右不为空，右⼦树最左结点就是中序第---个
			Node* leftMost = _node->_right;
			while (leftMost->_left)
			{
				leftMost = leftMost->_left;
			}
			_node = leftMost;
		}
		else
		{
			// 孩⼦是⽗亲左的那个祖先
			Node* cur = _node;
			Node* parent = cur->_parent;
			while (parent && cur == parent->_right)
			{
				cur = parent;
				parent = cur->_parent;
			}
			_node = parent;
		}
		return *this;
	}
	
	Self& operator--()
	{
		if (_node == nullptr) // end()
		{
			// --end()，特殊处理，⾛到中序最后---个结点，整棵树的最右结点
			Node* rightMost = _root;
			while (rightMost && rightMost->_right)
			{
				rightMost = rightMost->_right;
			}
			_node = rightMost;
		}
		else if (_node->_left)
		{
			// 左⼦树不为空，中序左⼦树最后---个
			Node* rightMost = _node->_left;
			while (rightMost->_right)
			{
				rightMost = rightMost->_right;
			}
			_node = rightMost;
		}
		else
		{
			// 孩⼦是⽗亲右的那个祖先
			Node* cur = _node;
			Node* parent = cur->_parent;
			while (parent && cur == parent->_left)
			{
				cur = parent;
				parent = cur->_parent;
			}
			
			_node = parent;
		}
		return *this;
	}
	
	Ref operator*()
	{
		return _node->_data;
	}

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

	bool operator!= (const Self& s) const
	{
		return _node != s._node;
	}

	bool operator== (const Self& s) const
	{
		return _node == s._node;
	}
};

template<class K, class T, class KeyOfT>
class RBTree
{
	typedef RBTreeNode<T> Node;
public:
	typedef RBTreeIterator<T, T&, T*> Iterator;
	typedef RBTreeIterator<T, const T&, const T*> ConstIterator;
	Iterator Begin()
	{
		Node* leftMost = _root;
		while (leftMost && leftMost->_left)
		{
			leftMost = leftMost->_left;
		}
		return Iterator(leftMost, _root);
	}

	Iterator End()
	{
		return Iterator(nullptr, _root);
	}
	
	ConstIterator Begin() const
	{
		Node* leftMost = _root;
		while (leftMost && leftMost->_left)
		{
			leftMost = leftMost->_left;
		}
		return ConstIterator(leftMost, _root);
	}

	ConstIterator End() const
	{
		return ConstIterator(nullptr, _root);
	}
	
	RBTree() = default;
	~RBTree()
	{	
		Destroy(_root);
		_root = nullptr;
	}
	pair<Iterator, bool> Insert(const T& data)
	{
		if (_root == nullptr)
		{
			_root = new Node(data);
			_root->_col = BLACK;
			return make_pair(Iterator(_root, _root), true);
		}
		KeyOfT kot;
		Node* parent = nullptr;
		Node* cur = _root;
		while (cur)
		{
			if (kot(cur->_data) < kot(data))
			{
				parent = cur;
				cur = cur->_right;
			}
			else if (kot(cur->_data) > kot(data))
			{
				parent = cur;
				cur = cur->_left;
			}
			else
			{
				return make_pair(Iterator(cur, _root), false);
			}
		}
		cur = new Node(data);
		Node* newnode = cur;
		// 新增结点。颜⾊红⾊给红⾊
		cur->_col = RED;
		if (kot(parent->_data) < kot(data))
		{
			parent->_right = cur;
		}
		else
		{
			parent->_left = cur;
		}
		cur->_parent = parent;
		while (parent && parent->_col == RED)
		{
			Node* grandfather = parent->_parent;
			// 	  g
			// p 	 u
			if (parent == grandfather->_left)
			{
				Node* uncle = grandfather->_right;
				if (uncle && uncle->_col == RED)
				{
					// u存在且为红 -》变⾊再继续往上处理
					parent->_col = uncle->_col = BLACK;
					grandfather->_col = RED;
					cur = grandfather;
					parent = cur->_parent;
				}
				else
				{
					// u存在且为⿊或不存在 -》旋转+变⾊
					if (cur == parent->_left)
					{
						//     g
						//  p     u
						//c
						//单旋
						RotateR(grandfather);
						parent->_col = BLACK;
						grandfather->_col = RED;
					}
					else
					{
						// 	  g
						// p 	 u
						// 	  c
						//双旋
						RotateL(parent);
						RotateR(grandfather);
						cur->_col = BLACK;
						grandfather->_col = RED;
					}
					break;
				}
			}
			else
			{
				// 	  g
				// u 	 p
				Node* uncle = grandfather->_left;
				// 叔叔存在且为红，-》变⾊即可
				if (uncle && uncle->_col == RED)
				{
					parent->_col = uncle->_col = BLACK;
					grandfather->_col = RED;
					// 继续往上处理
					cur = grandfather;
					parent = cur->_parent;
				}
				else // 叔叔不存在，或者存在且为⿊
				{
					// 情况⼆：叔叔不存在或者存在且为⿊
					// 旋转+变⾊
					//      g	
					// 	 u     p
					// c
					if (cur == parent->_right)
					{
						RotateL(grandfather);
						parent->_col = BLACK;
						grandfather->_col = RED;
					}
					else
					{
						// 			   g
						// 	   u 	p
						// 	c
						RotateR(parent);
						RotateL(grandfather);
						cur->_col = BLACK;
						grandfather->_col = RED;
					}
					break;
				}
			}
		}
		_root->_col = BLACK;
		return make_pair(Iterator(newnode, _root), true);
	}
	
	Iterator Find(const K& key)
	{
		Node* cur = _root;
		while (cur)
		{
			if (cur->_kv.first < key)
			{
				cur = cur->_right;
			}
			else if (cur->_kv.first > key)
			{
				cur = cur->_left;
			}
			else
			{
				return Iterator(cur, _root);
			}
		}
		return End();
	}
private:
	void RotateL(Node* parent)
	{
		Node* subR = parent->_right;
		Node* subRL = subR->_left;
		parent->_right = subRL;
		if (subRL)
			subRL->_parent = parent;
		Node* parentParent = parent->_parent;
		subR->_left = parent;
		parent->_parent = subR;
		if (parentParent == nullptr)
		{
			_root = subR;
			subR->_parent = nullptr;
		}
		else
		{
			if (parent == parentParent->_left)
			{
				parentParent->_left = subR;
			}
			else
			{
				parentParent->_right = subR;
			}
			subR->_parent = parentParent;
		}
	}
	
	void RotateR(Node* parent)
	{
		Node* subL = parent->_left;
		Node* subLR = subL->_right;
		parent->_left = subLR;
		if (subLR)
			subLR->_parent = parent;
		Node* parentParent = parent->_parent;
		subL->_right = parent;
		parent->_parent = subL;
		if (parentParent == nullptr)
		{
			_root = subL;
			subL->_parent = nullptr;
		}
		else
		{
			if (parent == parentParent->_left)
			{
				parentParent->_left = subL;
			}
			else
			{
				parentParent->_right = subL;
			}
			subL->_parent = parentParent;
		}
	}

	void Destroy(Node* root)
	{
		if (root == nullptr)
			return;
		Destroy(root->_left);
		Destroy(root->_right);
		delete root;
	}

private:
	Node* _root = nullptr;
};