封装红黑树实现map和set

前言：

        之前我们学习了set与map容器的如何使用，红黑树的实现。接下来我们来看看如何通过封装红黑树，实现我们自己的set与map
相关文章：oi！让我来给你唠唠咋实现红黑树☝️-CSDN博客
                超详细介绍map（multimap）的使用_mapster的map用法-CSDN博客
                超详细介绍set（multiset）的使用（C++）-CSDN博客

源码及框架分析 

        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 treelink_type header;
};
template <class Value>
struct __rb_tree_node : public __rb_tree_node_base
{typedef __rb_tree_nodValue value_field;
};

       通过下图对框架的分析，我们可以看到源码中rb_tree用了⼀个巧妙的泛型思想实现，rb_tree是实 现key的搜索场景，还是key/value的搜索场景不是直接写死的，而是由第二个模板参数Value决定 _rb_tree_node中存储的数据类型。
        set实例化rb_tree时第⼆个模板参数给的是key，map实例化rb_tree时第⼆个模板参数给的是 pair，这样⼀颗红黑树既可以实现key搜索场景的set，也可以实现key/value搜索场景的map
        要注意⼀下，源码里面模板参数是用T代表value，而内部写的value_type不是我们我们日常 key/value场景中说的value，源码中的value_type反而是红黑树结点中存储的真实的数据的类型。
        rb_tree第二个模板参数Value已经控制了红黑树结点中存储的数据类型，为什么还要传第⼀个模板参数Key呢？尤其是set，两个模板参数是一样的，这是很多同学这时的⼀个疑问。要注意的是对于map和set，find/erase时的函数参数都是Key，所以第⼀个模板参数是传给find/erase等函数做形参的类型的。对于set而言两个参数是一样的，但是对于map而言就完全不⼀样了，map、insert的是pair对象，但是find和ease的是Key对象。

模拟实现map和set 

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

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

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

           其次因为RBTree实现了泛型不知道T参数导致是K，还是pair，那么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 hyc
{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 hyc
{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;}
}

支持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_OPERATORpointer 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实现思路分析

         1. 迭代器实现框架：与list迭代器思路一致，用类型封装结点指针，通过重载运算符实现类似指针的访问行为。

        2. operator++实现难点：map和set迭代器按中序遍历（左子树->根结点->右子树），begin()返回中序第一个结点迭代器，其核心逻辑是考虑当前中序局部要访问的下一个结点：
         若当前结点右子树不为空，下一个结点是右子树的最左结点。 
         若当前结点右子树为空，需沿祖先路径向上找：当前结点是父结点左孩子时，下一个结点是父结点；当前结点是父结点右孩子时，继续往上找，直到找到孩子是父结点左孩子的祖先。

        3. end()表示：可用nullptr充当end，STL红黑树用哨兵位头结点作为end()，二者差别不大，--end()时若结点为空，特殊处理让迭代器结点指向最右结点。

        4. operator--实现：与++思路类似，逻辑相反，访问顺序为右子树->根结点->左子树。

        5. set和map迭代器修改权限：set迭代器不支持修改，将第二个模板参数改成const K；map迭代器不支持修改key但可修改value，将第二个模板参数pair的第一个参数改成const K。

map支持[] 

        map要支持[]主要需要修改insert返回值支持，修改RBtree中的insert返回值为 pair<Iterator,bool> Insert (const T& data)

map和set实现

//myMap.h
#include"RBTree.h"namespace hyc
{template<class K,class V>class map{struct MapKeyOfT{//operatorconst K& operator()(const pair<K,V>& a){return a.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>& key){return _t.Insert(key);}V& operator[](const K& key){ pair<iterator, bool> ret = insert({ key,V() });return ret.first->second;}RBTree<K, pair<const K,V>, MapKeyOfT> _t;};
}//mySet.h
#include"RBTree.h"namespace hyc
{template<class K>class set{struct SetKeyOfT{const K& operator()(const K& a){return a;}};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);}RBTree<K,const K, SetKeyOfT> _t;};
}//RBTree.h
#include<iostream>
using namespace std;
//红黑树：二叉搜索树+4条红黑树规则
// 1.红黑树所有节点有且只有两种颜色：红、黑
// 2.红黑树的根必须为黑色
// 3.红色节点的孩子必须为黑色
// 4.对于任意一个节点，从这个节点开始到NULL节点的黑色节点数量都是一样的// 枚举值表⽰颜⾊ 
enum Colour
{RED,BLACK,
};// 这里我们默认按key/value结构实现 
template<class T>
struct RBTreeNode
{// 这⾥更新控制平衡也要加⼊parent指针 T _kv;RBTreeNode<T>* _left;RBTreeNode<T>* _right;RBTreeNode<T>* _parent;Colour _col;RBTreeNode(const T& kv)//const?:_kv(kv), _left(nullptr), _right(nullptr), _parent(nullptr),_col(RED){}
};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++(){//如果右不为null，找右树的最左节点if(_node->_right){Node* cur = _node->_right;while (cur->_left){cur = cur->_left;}_node = cur;}else//右为空，则去找孩子是父亲左边的祖先{Node* cur = _node;Node* parent = cur->_parent;while (parent && parent->_right== cur){cur = parent;parent = parent->_parent;}_node = parent;}return *this;}//与++的逻辑相反Self& operator--(){//当为end()时，返回最右节点if (_node == nullptr){Node* cur = _root;while (cur &&cur->_right){cur = cur->_right;}_node = cur;}//如果左子树不为空,则去找左子树的最右节点else if (_node->_left){Node* cur = _node->_left;while (cur->_right){cur = cur->_right;}_node = cur;}else//如果左子树为空, 则去找孩子是父亲右的祖先{Node* cur = _node;Node* parent = cur->_parent;while(parent&&parent->_left==cur){cur = parent;parent = parent->_parent;}_node = parent;}return *this;}// 完善下面两个操作，让迭代器可以像指针一样操作T& operator*(){return _node->_kv;}T* operator->()//返回指针{return &_node->_kv;}// 完善下面两个操作，让迭代器能够支持比较bool operator!=(const Self& s)const{return _node != s._node;}bool operator==(const Self& s)const{return _node == s._node;}
};template<class K, class V,class KetOfT>
class RBTree
{//typedef RBTreeNode<V> Node;using Node = RBTreeNode<V>;
public:typedef RBTreeIterator<V, V&, V*> Iterator;typedef RBTreeIterator<V, const V&, const V*> ConstIterator;Iterator Begin(){Node* cur = _root;while (cur && cur->_left){cur = cur->_left;}return Iterator(cur,_root);//调用构造函数}Iterator End(){return Iterator(nullptr, _root);}ConstIterator Begin() const{Node* cur = _root;while (cur && cur->_left){cur = cur->_left;}return ConstIterator(cur, _root);//调用构造函数}ConstIterator End() const{return ConstIterator(nullptr, _root);}KetOfT kot;Node* Find(const K& key){Node* cur = _root;while (cur){if (cur->_kv < key){cur = cur->_right;}else if (cur->_kv > key){cur = cur->_left;}else{return cur;}}return nullptr;}pair<Iterator,bool> Insert(const V& kv){Node* cur = _root;Node* parent = cur;if (!cur)//如果是空树{_root = new Node(kv);_root->_col = BLACK;//return pair<Iterator, bool>(Iterator(_root, _root), true);return  { Iterator(_root, _root), true };}while(cur){if (kot(cur->_kv) > kot(kv)){parent = cur;cur = parent->_left;}else if (kot(cur->_kv) < kot(kv)){parent = cur;cur = parent->_right;}else{return  { Iterator(cur, _root), false };}}cur = new Node(kv);if (kot(parent->_kv) > kot(kv))parent->_left = cur;elseparent->_right = cur;//连接至上一层cur->_parent = parent;Node* newNode = cur;//判断是否满足条件while (parent&&parent->_col == RED){Node* pparent = parent->_parent;//先讨论parent在左边的情况if (pparent->_left == parent){Node* uncle = pparent->_right;//uncle存在且为红 -> 变色if (uncle && uncle->_col == RED){parent->_col = uncle->_col = BLACK;pparent->_col = RED;cur = pparent;parent = cur->_parent;}else{//单旋+变色if (parent->_left == cur){RotateR(pparent);pparent->_col = RED;parent->_col = BLACK;break;}//双旋+变色else{RotateL(parent);RotateR(pparent);pparent->_col = RED;cur->_col = BLACK;break;}}}else//再讨论parent在右边的情况{Node* uncle = pparent->_left;//uncle存在且为红 -> 变色if (uncle && uncle->_col == RED){parent->_col = uncle->_col = BLACK;pparent->_col = RED;cur = pparent;parent = cur->_parent;}else{//单旋+变色if (parent->_right == cur){RotateL(pparent);parent->_col = BLACK;pparent->_col = RED;break;}else//双旋+变色{RotateR(parent);RotateL(pparent);cur->_col = BLACK;pparent->_col = RED;break;}}}_root->_col = BLACK;}return  { Iterator(newNode, _root), true};}//右单旋void RotateR(Node* parent){Node* pparent = parent->_parent;Node* subL = parent->_left;Node* subLR = subL->_right;if(subLR)subLR->_parent = parent;parent->_left = subLR;subL->_right = parent;parent->_parent = subL;if (!pparent){_root = subL;subL->_parent = nullptr;}else{if (pparent->_left == parent){subL->_parent = pparent;pparent->_left = subL;}else{subL->_parent = pparent;pparent->_right = subL;}}}//左单旋void RotateL(Node* parent){Node* pparent = parent->_parent;Node* subR = parent->_right;Node* subRL = subR->_left;parent->_right = subRL;if (subRL)subRL->_parent = parent;subR->_left = parent;parent->_parent = subR;if(!pparent){_root = subR;subR->_parent = nullptr;}else{if (pparent->_left == parent){pparent->_left = subR;subR->_parent = pparent;}else{pparent->_right = subR;subR->_parent = pparent;}}}private:Node* _root = nullptr;
};