C++中封装红黑树模拟实现map和set
目录
1.源码及框架分析
2.封装红黑树模拟实现map和set
2.1实现出泛型的红黑树框架
2.1.1红黑树的节点结构
2.1.2map和set中的仿函数 -- 用于取出Key
2.1.3泛型红黑树的Insert()
2.2红黑树中迭代器的实现
2.3map中operator[]()的实现
2.4参考代码
2.4.1MySet.h
2.4.2MyMap.h
2.4.3RBTree.h
2.4.4测试代码test.cpp
1.源码及框架分析
SGI-STL30版本源代码，map和set的源代码在map/set/stl_map.h/stl_set.h/set_tree.h等几个头文件中。
1.通过上图对框架的分析，我们可以看到源码中rb_tree用了一个巧妙的泛型思想实现，rb_tree是实现key的搜索场景还是key/value的搜索场景不是直接写死的，而是由第二个模板参数Value决定_rb_tree_node中存储的数据类型。
2.set实例化rb_tree时第二个模板参数给的是key，map实例化rb_tree时第二个模板参数给的是pair<const key, T>，这样一棵红黑树既可以实现set，也可以实现map。
3.要注意一下，源码里面模板参数是用T代表value，⽽内部写的value_type不是我们我们⽇常key/value场景中说的value，源码中的value_type反⽽是红⿊树结点中存储的真实的数据的类型。
4.rb_tree第⼆个模板参数Value已经控制了红⿊树结点中存储的数据类型，为什么还要传第⼀个模板参数Key呢？尤其是set，两个模板参数是⼀样的。要注意的是对于map和set，find/erase时的函数参数都是Key，所以第⼀个模板参数是传给find/erase等函数做形参的类型的。对于set⽽⾔两个参数是⼀样的，但是对于map⽽⾔就完全不⼀样了，map insert的是pair对象，但是find和ease的是Key对象。
2.封装红黑树模拟实现map和set
2.1实现出泛型的红黑树框架
这⾥相⽐源码调整⼀下，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，再进⾏⽐较。
2.1.1红黑树的节点结构
//红黑树节点结构
//这里的T代表的是红黑树节点里面存储的数据类型
//红黑树的节点只存储数据和对应数据的指针，所有只需要一个模板参数来表示存储的数据类型即可
//对于set来说是key
//对于map来说是pair
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)
{}
};2.1.2map和set中的仿函数 -- 用于取出Key
//MyMap.h中的仿函数
struct MapKeyOfT
{
//返回pair中的first作为map的Key
const K& operator()(const pair<K, V>& kv)
{
return kv.first;
}
};
//MySet.h中的仿函数
struct SetKeyOfT
{
//返回Key作为set的Key
const K& operator()(const K& key)
{
return key;
}
};2.1.3泛型红黑树的Insert()
在Insert()的实现中要进行Key大小的比较，对于set来说直接可以使用key比较，对于map来说，需要把pair中的first取出来作为key进行比较，所以在红黑树的模板中引入一个模板参数KeyOfT，用于接收上层map或者set传来的仿函数，使用仿函数在红黑树中提取出Key进行比较。
pair<Iterator, bool> Insert(const T& data)
{
//如果为空树，插入的节点作为根
if (_root == nullptr)
{
_root = new Node(data);
_root->_col = BLACK; //根必须为黑色
return {Iterator(_root, _root), true};
}
KeyOfT kot; //这里创建一个仿函数对象，用于取出对于数据结构的key值用作下列的比较
//找到空位置
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 { 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;
//父亲是红色，出现连续红色节点，需要进行处理
//1.叔叔在右边
//1.1 叔叔存在且为红色 -- 父亲和叔叔变为黑色，爷爷变为红色继续向上处理
//1.2 叔叔不存在或者叔叔为黑
//1.2.1 插入在父亲节点左边 -- 爷爷节点进行右单旋，且父亲节点变黑，爷爷节点变红
//1.2.2 插入在父亲节点右边 -- 父亲节点左旋爷爷节点右旋，且当前节点变黑，爷爷节点变红
//2.叔叔在左边
while (parent && parent->_col == RED) //判断parent是否存在是为了处理向上处理到根的情况
{
Node* grandfather = parent->_parent;
if (parent == grandfather->_left)
{
//叔叔在右边
// g
//p u
Node* uncle = grandfather->_right;
if (uncle && uncle->_col == RED) //叔叔节点存在且为红色
{
//变色
parent->_col = uncle->_col = BLACK;
grandfather->_col = RED;
//继续往上处理
cur = grandfather;
parent = cur->_parent;
}
else //uncle节点不存在或者存在且为黑
{
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 //叔叔不存在或者存在且为黑
{
if (cur == parent->_right)
{
// g
// u p
// c
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 { Iterator(newnode, _root), true };
}2.2红黑树中迭代器的实现
1.iterator实现的大框架跟list的iterator思路是⼀致的，⽤⼀个类型封装结点的指针，再通过重载运算符实现迭代器像指针⼀样访问的行为。可以参考：C++中list类的使用及模拟实现中迭代器的实现。
2.难点是operator++和operator--的实现。map和set的迭代器⾛的是中序遍历，左⼦树->根结点->右⼦树，那么begin()会返回中序第⼀个结点的iterator也就是最左节点的迭代器。
3.迭代器++的核⼼逻辑是只考虑当前中序局部要访问的下⼀个结点。(1)迭代器++时，如果it指向的结点的右⼦树不为空，代表当前结点已经访问完了，要访问下⼀个结点是右⼦树中序的第⼀个节点，所以直接找右⼦树的最左结点即可。(2)迭代器++时，如果it指向的结点的右⼦树为空，代表当前结点已经访问完了且当前结点所在的⼦树也访问完了，要访问的下⼀个结点在当前结点的祖先⾥⾯，所以要沿着当前结点到根的祖先路径向上找。直到找到一个祖先节点，该祖先节点的左子节点也是祖先节点，则该祖先节点就是中序要访问的下⼀个结点。
4.⽤nullptr去充当end()。迭代器为end()时进行operator--()操作，空指针不能进行--操作，特殊处理⼀下，让迭代器结点指向最右结点，找最右节点时要从根节点开始找，所以迭代器这里要引入一个根节点的成员变量。
5.迭代器--的实现跟++的思路完全类似，逻辑正好反过来即可，访问顺序是右⼦树->根结点->左⼦树。
6.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。
//红黑树迭代器结构
//T表示迭代器指向的节点存储的数据类型
//Ref和Ptr表示数据类型的引用和指针
//引入Ref和Ptr可以用一个模板实现普通迭代器和const迭代器
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) //用于operator--()中处理end()情况
{}
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()时特殊处理，走到中序最后一个节点，整棵树的最右结点
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;
}
};2.3map中operator[]()的实现
insert()返回一个pair对象，pair对象的第一个值是一个指向插入节点的迭代器，第二个值表示是否插入成功。如果插入成功，则第一个值指向新插入节点的迭代器；如果插入失败，第一个值指向map中等于key值的节点的迭代器。
operator[]返回insert()返回值pair对象的first的second，即返回map中存储的pair的second。
V& operator[] (const K& key)
{
pair<iterator, bool> ret = insert({ key, V() });
return ret.first->second;
}2.4参考代码
2.4.1MySet.h
#pragma once
#include "RBTree.h"
namespace xiaoc
{
template<class K>
class set
{
//仿函数 -- 用于取出Key值
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;
};
}2.4.2MyMap.h
#pragma once
#include "RBTree.h"
namespace xiaoc
{
template<class K, class V>
class map
{
//仿函数 -- 用于取出Key值
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({ key, V() });
return ret.first->second;
}
private:
RBTree<K, pair<const K, V>, MapKeyOfT> _t;
};
}2.4.3RBTree.h
#pragma once
//枚举表示颜色
enum Colour
{
RED,
BLACK
};
//红黑树节点结构
//这里的T代表的是红黑树节点里面存储的数据类型
// 红黑树的节点存储数据和指针，所有只需要一个模板参数来表示存储的数据类型即可
//对于set来说是key
//对于map来说是pair
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)
{}
};
//红黑树迭代器结构
//T表示迭代器指向的节点存储的数据类型
//Ref和Ptr表示数据类型的引用和指针
//引入Ref和Ptr可以用一个模板实现普通迭代器和const迭代器
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) //用于operator--()中处理end()情况
{}
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()时特殊处理，走到中序最后一个节点，整棵树的最右结点
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;
}
};
//红黑树结构
//这里的红黑树实现成一个泛型用于封装map和set
//K表示key的类型
//T表示存储的数据的类型
//KeyOfT用于接收上层map和set中传过来的仿函数
//用上层map和set中的仿函数取出对应的Key
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(const RBTree& t)
{
_root = Copy(t._root);
}
//赋值运算符重载
RBTree& operator=(const RBTree t)
{
swap(_root, t._root);
return *this;
}
//析构函数
~RBTree()
{
Destroy(_root);
_root = nullptr;
}
pair<Iterator, bool> Insert(const T& data)
{
//如果为空树，插入的节点作为根
if (_root == nullptr)
{
_root = new Node(data);
_root->_col = BLACK; //根必须为黑色
return {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 { 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;
//父亲是红色，出现连续红色节点，需要进行处理
//1.叔叔在右边
//1.1 叔叔存在且为红色 -- 父亲和叔叔变为黑色，爷爷变为红色继续向上处理
//1.2 叔叔不存在或者叔叔为黑
//1.2.1 插入在父亲节点左边 -- 爷爷节点进行右单旋，且父亲节点变黑，爷爷节点变红
//1.2.2 插入在父亲节点右边 -- 父亲节点左旋爷爷节点右旋，且当前节点变黑，爷爷节点变红
//2.叔叔在左边
while (parent && parent->_col == RED) //判断parent是否存在是为了处理向上处理到根的情况
{
Node* grandfather = parent->_parent;
if (parent == grandfather->_left)
{
//叔叔在右边
// g
//p u
Node* uncle = grandfather->_right;
if (uncle && uncle->_col == RED) //叔叔节点存在且为红色
{
//变色
parent->_col = uncle->_col = BLACK;
grandfather->_col = RED;
//继续往上处理
cur = grandfather;
parent = cur->_parent;
}
else //uncle节点不存在或者存在且为黑
{
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 //叔叔不存在或者存在且为黑
{
if (cur == parent->_right)
{
// g
// u p
// c
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 { Iterator(newnode, _root), true };
}
void InOrder()
{
_InOrder(_root);
cout << endl;
}
int Height()
{
return _Height(_root);
}
int Size()
{
return _Size(_root);
}
Iterator Find(const K& key)
{
Node* cur = _root;
KeyOfT kot;
while (cur)
{
if (kot(cur->_data) < key)
{
cur = cur->_right;
}
else if (kot(cur->_data) > key)
{
cur = cur->_left;
}
else
{
return Iterator(cur, _root);
}
}
return Iterator(nullptr, _root);
}
private:
void RotateR(Node* parent)
{
Node* subL = parent->_left;
Node* subLR = subL->_right;
parent->_left = subLR;
if (subLR)
subLR->_parent = parent;
Node* pParent = parent->_parent;
subL->_right = parent;
parent->_parent = subL;
if (parent == _root)
{
_root = subL;
subL->_parent = nullptr;
}
else
{
if (pParent->_left == parent)
{
pParent->_left = subL;
}
else
{
pParent->_right = subL;
}
subL->_parent = pParent;
}
}
void RotateL(Node* parent)
{
Node* subR = parent->_right;
Node* subRL = subR->_left;
parent->_right = subRL;
if (subRL)
subRL->_parent = parent;
Node* pParent = parent->_parent;
subR->_left = parent;
parent->_parent = subR;
if (pParent == nullptr)
{
_root = subR;
subR->_parent = nullptr;
}
else
{
if (pParent->_left == parent)
{
pParent->_left = subR;
}
else
{
pParent->_right = subR;
}
subR->_parent = pParent;
}
}
void Destroy(Node* root)
{
if (root == nullptr)
return;
Destroy(root->_left);
Destroy(root->_right);
delete root;
}
Node* Copy(Node* root)
{
if (root == nullptr)
return nullptr;
Node* newRoot = new Node(root->data);
newRoot->_left = Copy(root->_left);
newRoot->_right = Copy(root->_right);
}
int _Height(Node* root)
{
if (root == nullptr)
return 0;
int leftHeight = _Height(root->_left);
int rightHeight = _Height(root->_right);
return leftHeight > rightHeight ? leftHeight + 1 : rightHeight + 1;
}
int _Size(Node* root)
{
if (root == nullptr)
return 0;
return _Size(root->_left) + _Size(root->_right) + 1;
}
Node* _root = nullptr;
};2.4.4测试代码test.cpp
#define _CRT_SECURE_NO_WARNINGS
#include <iostream>
#include <vector>
#include <string>
using namespace std;
#include "MySet.h"
#include "MyMap.h"
namespace xiaoc
{
void set_print(const set<int>& s)
{
set<int>::const_iterator it = s.end();
while (it != s.begin())
{
--it;
// 不⽀持修改
//*it += 2;
cout << *it << " ";
}
cout << endl;
}
void myset_test()
{
vector<int> v = { 4,2,10,6,27,19,24,6 };
set<int> s;
for (auto& e : v)
{
s.insert(e);
}
for (auto e : s)
{
cout << e << " ";
}
cout << endl;
set_print(s);
s.find(4);
}
void mymap_test()
{
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;
}
}
int main()
{
xiaoc::myset_test();
//xiaoc::mymap_test();
return 0;
}