C语言数据结构(三) ----------------HRBTree

typedef struct __rb_tree_node_header {
	struct __rb_tree_node_header *left;       // 左孩子
	struct __rb_tree_node_header *right;      // 右孩子
	struct __rb_tree_node_header *parent;     // 父结点
	unsigned int color;            // 颜色 (READ BLACK)
} RBTreeNodeHeader;

// 红黑树的节点
typedef struct __rb_tree_node {
	RBTreeNodeHeader head;
} RBTreeNode;

typedef int (*rb_tree_compare_node) (RBTreeNodeHeader *head1,
	RBTreeNodeHeader *head2);

typedef RBTreeNode* (*rb_tree_alloc_node) ();
typedef void (*rb_tree_free_node) (RBTreeNodeHeader *head);
typedef char* (*rb_tree_get_nodeinfo) (RBTreeNodeHeader *head);

typedef struct rb_tree_root {
	RBTreeNode *node;
	rb_tree_compare_node cmp_func;
	rb_tree_alloc_node alloc_func;
	rb_tree_free_node free_func;
    rb_tree_get_nodeinfo get_nodeinfo_func;
} RBTreeRoot;

// 创建红黑树，返回"红黑树的根"！
RBTreeRoot* create_rbtree(rb_tree_compare_node cmp_func,
	rb_tree_alloc_node alloc_node_func,
	rb_tree_free_node free_node_func, rb_tree_get_nodeinfo get_info);
// 销毁红黑树
void destroy_rbtree(RBTreeRoot *root);

// 将结点插入到红黑树中。插入成功，返回0；失败返回-1。
int insert_rbtree(RBTreeRoot *root, RBTreeNodeHeader *node);

// 删除结点(key为节点的值)
void delete_rbtree(RBTreeRoot *root, RBTreeNodeHeader *node);

// (递归实现)查找"红黑树"中键值为key的节点。找到的话，返回0；否则，返回-1。
RBTreeNodeHeader *search_rbtree(RBTreeRoot *root, RBTreeNodeHeader *node);
// (非递归实现)查找"红黑树"中键值为key的节点。找到的话，返回0；否则，返回-1。
RBTreeNodeHeader *iterative_search_rbtree(RBTreeRoot *root, RBTreeNodeHeader *node);

RBTreeNodeHeader *minimum_rbtree(RBTreeRoot*root);
RBTreeNodeHeader *maximum_rbtree(RBTreeRoot *root);

// 打印红黑树
void print_rbtree(RBTreeRoot *root);

#define rb_parent(r)   ((r)->parent)
#define rb_color(r) ((r)->color)
#define rb_is_red(r)   ((r)->color==RED)
#define rb_is_black(r)  ((r)->color==BLACK)
#define rb_set_black(r)  do { (r)->color = BLACK; } while (0)
#define rb_set_red(r)  do { (r)->color = RED; } while (0)
#define rb_set_parent(r,p)  do { (r)->parent = (p); } while (0)
#define rb_set_color(r,c)  do { (r)->color = (c); } while (0)

/*
 * 创建红黑树，返回"红黑树的根"！
 */
RBTreeRoot * create_rbtree(rb_tree_compare_node cmp_fun,
	rb_tree_alloc_node alloc_func,
	rb_tree_free_node free_func, rb_tree_get_nodeinfo get_info)
{
    RBTreeRoot *root = malloc(sizeof(*root));
    root->cmp_func = cmp_fun;
    root->alloc_func = alloc_func;
    root->free_func = free_func;
    root->get_nodeinfo_func = get_info;
    root->node = NULL;
    return root;
}

/*
 * (递归实现)查找"红黑树x"中键值为key的节点
 */
static RBTreeNodeHeader* __rbtree_search(RBTreeNodeHeader *tree, RBTreeNodeHeader *header,
	rb_tree_compare_node fun)
{
	int ret = fun(tree, header);
	if (ret == 0)
		return tree;
	else if (ret > 0) {
		if (tree->left != NULL)
			return __rbtree_search(tree->left, header, fun);
		else
			return NULL;
	} else {
		if (tree->right != NULL)
			return __rbtree_search(tree->right, header, fun);
		else
			return NULL;
	}
}

RBTreeNodeHeader *rbtree_search(RBTreeRoot *root, RBTreeNodeHeader * key)
{
	if (root && root->node)
		return __rbtree_search(&root->node->head, key, root->cmp_func);
	else
		return NULL;
}

/*
 * (非递归实现)查找"红黑树x"中键值为key的节点
 */
static RBTreeNodeHeader *__iterative_search_rbtree(RBTreeNodeHeader *x,
	RBTreeNodeHeader *key, rb_tree_compare_node func)
{
	do {
		int ret;
		ret = func(x, key);
		if (ret == 0)
			return x;
		else if (ret > 0 && x->left != NULL)
			x = x->left;
		else if (ret < 0 && x->right != NULL)
			x = x->right;
		else
			return NULL;
	} while (1);

	return NULL;
}

RBTreeNodeHeader *iterative_rbtree_search(RBTreeRoot *root, RBTreeNodeHeader *key)
{
	if (root && root->node)
		return __iterative_search_rbtree(&root->node->head, key, root->cmp_func);
	else
		return NULL;
}

/*
 * 查找最小结点：返回tree为根结点的红黑树的最小结点。
 */
static RBTreeNodeHeader *__minimum_rbtree(RBTreeNodeHeader *head)
{
    while(head->left != NULL)
        head = head->left;
    return head;
}

RBTreeNodeHeader *minimum_rbtree(RBTreeRoot *root)
{
	if (!root || !root->node)
		return NULL;
	RBTreeNodeHeader *node = __minimum_rbtree(&root->node->head);
	return node;
}

/*
 * 查找最大结点：返回tree为根结点的红黑树的最大结点。
 */
static RBTreeNodeHeader *__maximum_rbtree(RBTreeNodeHeader *head)
{
    while(head->right != NULL)
        head = head->right;
    return head;
}

RBTreeNodeHeader *maximum_rbtree(RBTreeRoot *root)
{
	if (!root || !root->node)
		return NULL;
	RBTreeNodeHeader *node = __maximum_rbtree(&root->node->head);
	return node;
}

/*
 * 找结点(x)的后继结点。即，查找"红黑树中数据值大于该结点"的"最小结点"。
 */
RBTreeNodeHeader* rbtree_successor(RBTreeNodeHeader *x)
{
    // 如果x存在右孩子，则"x的后继结点"为 "以其右孩子为根的子树的最小结点"。
    if (x->right != NULL)
        return __minimum_rbtree(x->right);

    // 如果x没有右孩子。则x有以下两种可能：
    // (01) x是"一个左孩子"，则"x的后继结点"为 "它的父结点"。
    // (02) x是"一个右孩子"，则查找"x的最低的父结点，并且该父结点要具有左孩子"，找到的这个"最低的父结点"就是"x的后继结点"。
    RBTreeNodeHeader *y = x->parent;
    while ((y != NULL) && (x == y->right))
    {
        x = y;
        y = y->parent;
    }

    return y;
}

/*
 * 找结点(x)的前驱结点。即，查找"红黑树中数据值小于该结点"的"最大结点"。
 */
RBTreeNodeHeader* rbtree_predecessor(RBTreeNodeHeader *x)
{
    // 如果x存在左孩子，则"x的前驱结点"为 "以其左孩子为根的子树的最大结点"。
    if (x->left != NULL)
        return __maximum_rbtree(x->left);

    // 如果x没有左孩子。则x有以下两种可能：
    // (01) x是"一个右孩子"，则"x的前驱结点"为 "它的父结点"。
    // (01) x是"一个左孩子"，则查找"x的最低的父结点，并且该父结点要具有右孩子"，找到的这个"最低的父结点"就是"x的前驱结点"。
    RBTreeNodeHeader * y = x->parent;
    while ((y != NULL) && (x == y->left))
    {
        x = y;
        y = y->parent;
    }

    return y;
}

/*
 * (递归实现)查找"红黑树x"中键值为key的节点
 */
static RBTreeNodeHeader* __rbtree_search_lesser(RBTreeNodeHeader *tree, RBTreeNodeHeader *header,
	rb_tree_compare_node fun)
{
	int ret = fun(tree, header);
	if (ret == 0)
		return tree;
	else if (ret > 0) {
		if (tree->left != NULL) {
			return __rbtree_search_lesser(tree->left, header, fun);
        } else {
			return rbtree_predecessor(tree);
        }
	} else {
		if (tree->right != NULL) {
			return __rbtree_search_lesser(tree->right, header, fun);
        } else {

			return tree;
        }
	}
}

RBTreeNodeHeader *rbtree_search_lesser(RBTreeRoot *root, RBTreeNodeHeader * key)
{
	if (root && root->node)
		return __rbtree_search_lesser(&root->node->head, key, root->cmp_func);
	else
		return NULL;
}

/*
 * 对红黑树的节点(x)进行左旋转
 *
 * 左旋示意图(对节点x进行左旋)：
 *      px                              px
 *     /                               /
 *    x                               y
 *   /  \      --(左旋)-->           / \                #
 *  lx   y                          x  ry
 *     /   \                       /  \
 *    ly   ry                     lx  ly
 *
 *
 */
static void rbtree_left_rotate(RBTreeRoot *root, RBTreeNodeHeader *x)
{
    //这里需要假定 x不会为叶子节点
    // 设置x的右孩子为y
    RBTreeNodeHeader *y = x->right;
    // 将 “y的左孩子” 设为 “x的右孩子”；
    // 如果y的左孩子非空，将 “x” 设为 “y的左孩子的父亲”
    x->right = y->left;
    if (y->left != NULL)
        y->left->parent = x;

    // 将 “x的父亲” 设为 “y的父亲”
    y->parent = x->parent;

    if (x->parent == NULL)
    {
        //tree = y;            // 如果 “x的父亲” 是空节点，则将y设为根节点
        root->node = rb_entry(y, RBTreeNode, head);            // 如果 “x的父亲” 是空节点，则将y设为根节点
    }
    else
    {
        if (x->parent->left == x)
            x->parent->left = y;    // 如果 x是它父节点的左孩子，则将y设为“x的父节点的左孩子”
        else
            x->parent->right = y;    // 如果 x是它父节点的左孩子，则将y设为“x的父节点的左孩子”
    }

    // 将 “x” 设为 “y的左孩子”
    y->left = x;
    // 将 “x的父节点” 设为 “y”
    x->parent = y;
}

/*
 * 对红黑树的节点(y)进行右旋转
 *
 * 右旋示意图(对节点y进行右旋)：
 *            py                               py
 *           /                                /
 *          y                                x
 *         /  \      --(右旋)-->            /  \                     #
 *        x   ry                           lx   y
 *       / \                                   / \                   #
 *      lx  rx                                rx  ry
 *
 */
static void rbtree_right_rotate(RBTreeRoot *root, RBTreeNodeHeader *y)
{
    // 设置x是当前节点的左孩子。
    RBTreeNodeHeader *x = y->left;
    // 将 “x的右孩子” 设为 “y的左孩子”；
    // 如果"x的右孩子"不为空的话，将 “y” 设为 “x的右孩子的父亲”
    y->left = x->right;
    if (x->right != NULL)
        x->right->parent = y;

    // 将 “y的父亲” 设为 “x的父亲”
    x->parent = y->parent;

    if (y->parent == NULL)
    {
        //tree = x;            // 如果 “y的父亲” 是空节点，则将x设为根节点
        root->node = rb_entry(x, RBTreeNode, head);            // 如果 “y的父亲” 是空节点，则将x设为根节点
    }
    else
    {
        if (y == y->parent->right)
            y->parent->right = x;    // 如果 y是它父节点的右孩子，则将x设为“y的父节点的右孩子”
        else
            y->parent->left = x;    // (y是它父节点的左孩子) 将x设为“x的父节点的左孩子”
    }

    // 将 “y” 设为 “x的右孩子”
    x->right = y;

    // 将 “y的父节点” 设为 “x”
    y->parent = x;
}

/*
 * 红黑树插入修正函数
 *
 * 在向红黑树中插入节点之后(失去平衡)，再调用该函数；
 * 目的是将它重新塑造成一颗红黑树。
 *
 * 参数说明：
 *     root 红黑树的根
 *     node 插入的结点        // 对应《算法导论》中的z
 */
static void rbtree_insert_fixup(RBTreeRoot *root, RBTreeNodeHeader *node)
{
    RBTreeNodeHeader *parent, *gparent;

    // 若“父节点存在，并且父节点的颜色是红色”
    while ((parent = rb_parent(node)) && rb_is_red(parent))
    {
        gparent = rb_parent(parent);

        //若“父节点”是“祖父节点的左孩子”
        if (parent == gparent->left)
        {
            // Case 1条件：叔叔节点是红色
            {
                RBTreeNodeHeader *uncle = gparent->right;
                if (uncle && rb_is_red(uncle))
                {
                    rb_set_black(uncle);
                    rb_set_black(parent);
                    rb_set_red(gparent);
                    node = gparent;
                    continue;
                }
            }

            // Case 2条件：叔叔是黑色，且当前节点是右孩子
            if (parent->right == node)
            {
                RBTreeNodeHeader *tmp;
                rbtree_left_rotate(root, parent);
                tmp = parent;
                parent = node;
                node = tmp;
            }

            // Case 3条件：叔叔是黑色，且当前节点是左孩子。
            rb_set_black(parent);
            rb_set_red(gparent);
            rbtree_right_rotate(root, gparent);
        }
        else//若“z的父节点”是“z的祖父节点的右孩子”
        {
            // Case 1条件：叔叔节点是红色
            {
                RBTreeNodeHeader *uncle = gparent->left;
                if (uncle && rb_is_red(uncle))
                {
                    rb_set_black(uncle);
                    rb_set_black(parent);
                    rb_set_red(gparent);
                    node = gparent;
                    continue;
                }
            }

            // Case 2条件：叔叔是黑色，且当前节点是左孩子
            if (parent->left == node)
            {
                RBTreeNodeHeader *tmp;
                rbtree_right_rotate(root, parent);
                tmp = parent;
                parent = node;
                node = tmp;
            }

            // Case 3条件：叔叔是黑色，且当前节点是右孩子。
            rb_set_black(parent);
            rb_set_red(gparent);
            rbtree_left_rotate(root, gparent);
        }
    }

    // 将根节点设为黑色
    rb_set_black(&root->node->head);
}

/*
 * 添加节点：将节点(node)插入到红黑树中
 *
 * 参数说明：
 *     root 红黑树的根
 *     node 插入的结点        // 对应《算法导论》中的z
 */
static void insert_rbtree_node(RBTreeRoot *root, RBTreeNodeHeader *node)
{
    RBTreeNodeHeader *y = NULL;
    RBTreeNode *root_entry = root->node;

    RBTreeNodeHeader *x = root_entry == NULL ? NULL : &root_entry->head;
    // 1. 将红黑树当作一颗二叉查找树，将节点添加到二叉查找树中。
    while (x != NULL)
    {
        y = x;
        if (root->cmp_func(x, node) > 0)
            x = x->left;
        else
            x = x->right;
    }
    rb_parent(node) = y;

    if (y != NULL)
    {
	int comp_ret = root->cmp_func(y, node);
        if (comp_ret > 0)
            y->left = node;                // 情况2：若“node所包含的值” < “y所包含的值”，则将node设为“y的左孩子”
        else
            y->right = node;            // 情况3：(“node所包含的值” >= “y所包含的值”)将node设为“y的右孩子”
    }
    else
    {
        root->node = rb_entry(node, RBTreeNode, head);                // 情况1：若y是空节点，则将node设为根
    }

    // 2. 设置节点的颜色为红色
    node->color = RED;
    // 3. 将它重新修正为一颗二叉查找树
    rbtree_insert_fixup(root, node);
}

/*
 * 红黑树删除修正函数
 *
 * 在从红黑树中删除插入节点之后(红黑树失去平衡)，再调用该函数；
 * 目的是将它重新塑造成一颗红黑树。
 *
 * 参数说明：
 *     root 红黑树的根
 *     node 待修正的节点
 */
static void rbtree_delete_fixup(RBTreeRoot *root, RBTreeNodeHeader *node,
	RBTreeNodeHeader *parent)
{
    RBTreeNodeHeader *other;
    while ((!node || rb_is_black(node)) && node != &root->node->head)
    {
        if (parent->left == node) {
            other = parent->right;
            if (rb_is_red(other)) {
                // Case 1: x的兄弟w是红色的
                rb_set_black(other);
                rb_set_red(parent);
                rbtree_left_rotate(root, parent);
                other = parent->right;
            }
            if ((!other->left || rb_is_black(other->left)) &&
                (!other->right || rb_is_black(other->right))) {
                // Case 2: x的兄弟w是黑色，且w的俩个孩子也都是黑色的
                rb_set_red(other);
                node = parent;
                parent = rb_parent(node);
            } else {
                if (!other->right || rb_is_black(other->right))
                {
                    // Case 3: x的兄弟w是黑色的，并且w的左孩子是红色，右孩子为黑色。
                    rb_set_black(other->left);
                    rb_set_red(other);
                    rbtree_right_rotate(root, other);
                    other = parent->right;
                }
                // Case 4: x的兄弟w是黑色的；并且w的右孩子是红色的，左孩子任意颜色。
                rb_set_color(other, rb_color(parent));
                rb_set_black(parent);
                rb_set_black(other->right);
                rbtree_left_rotate(root, parent);
                node = &root->node->head;
                break;
            }
        }
        else
        {
            other = parent->left;
            if (rb_is_red(other)) {
                // Case 1: x的兄弟w是红色的
                rb_set_black(other);
                rb_set_red(parent);
                rbtree_right_rotate(root, parent);
                other = parent->left;
            }
            if ((!other->left || rb_is_black(other->left)) &&
                (!other->right || rb_is_black(other->right))) {
                // Case 2: x的兄弟w是黑色，且w的俩个孩子也都是黑色的
                rb_set_red(other);
                node = parent;
                parent = rb_parent(node);
            } else {
                if (!other->left || rb_is_black(other->left)) {
                    // Case 3: x的兄弟w是黑色的，并且w的左孩子是红色，右孩子为黑色。
                    rb_set_black(other->right);
                    rb_set_red(other);
                    rbtree_left_rotate(root, other);
                    other = parent->left;
                }
                // Case 4: x的兄弟w是黑色的；并且w的右孩子是红色的，左孩子任意颜色。
                rb_set_color(other, rb_color(parent));
                rb_set_black(parent);
                rb_set_black(other->left);
                rbtree_right_rotate(root, parent);
                node = &root->node->head;
                break;
            }
        }
    }
    if (node)
        rb_set_black(node);
}

/*
 * 删除结点
 *
 * 参数说明：
 *     tree 红黑树的根结点
 *     node 删除的结点
 */
void rbtree_delete(RBTreeRoot *root, RBTreeNodeHeader *node)
{
    RBTreeNodeHeader *child, *parent;

    int color;
    // 被删除节点的"左右孩子都不为空"的情况。
    if ((node->left != NULL) && (node->right != NULL) ) {
        // 被删节点的后继节点。(称为"取代节点")
        // 用它来取代"被删节点"的位置，然后再将"被删节点"去掉。
        RBTreeNodeHeader *replace = node;
        // 获取后继节点
        replace = replace->right;
        while (replace->left != NULL)
            replace = replace->left;

        // "node节点"不是根节点(只有根节点不存在父节点)
        if (rb_parent(node))
        {
            if (rb_parent(node)->left == node)
                rb_parent(node)->left = replace;
            else
                rb_parent(node)->right = replace;
        }
        else
            // "node节点"是根节点，更新根节点。
            root->node = rb_entry(replace, RBTreeNode, head);

        // child是"取代节点"的右孩子，也是需要"调整的节点"。
        // "取代节点"肯定不存在左孩子！因为它是一个后继节点。
        child = replace->right;
        parent = rb_parent(replace);
        // 保存"取代节点"的颜色
        color = rb_color(replace);

        // "被删除节点"是"它的后继节点的父节点"
        if (parent == node)
        {
            parent = replace;
        }
        else
        {
            // child不为空
            if (child)
                rb_set_parent(child, parent);
            parent->left = child;

            replace->right = node->right;
            rb_set_parent(node->right, replace);
        }

        replace->parent = node->parent;
        replace->color = node->color;
        replace->left = node->left;
        node->left->parent = replace;

        if (color == BLACK)
            rbtree_delete_fixup(root, child, parent);
	if (root->free_func)
		root->free_func(node);
        return ;
    }

    if (node->left !=NULL)
        child = node->left;
    else
        child = node->right;

    parent = node->parent;
    // 保存"取代节点"的颜色
    color = node->color;

    if (child)
        child->parent = parent;

    // "node节点"不是根节点
    if (parent)
    {
        if (parent->left == node)
            parent->left = child;
        else
            parent->right = child;
    }
    else
        root->node = rb_entry(child, RBTreeNode, head);

    if (color == BLACK)
        rbtree_delete_fixup(root, child, parent);
    if (root->free_func)
	    root->free_func(node);
}

/*
 * 销毁红黑树
 */
static void rbtree_destroy(RBTreeNodeHeader *tree, rb_tree_free_node free_func)
{
	if (tree == NULL)
		return;
	if (tree->left != NULL)
		rbtree_destroy(tree->left, free_func);
	if (tree->right != NULL)
		rbtree_destroy(tree->right, free_func);

	RBTreeNode *tree_entry = rb_entry(tree, RBTreeNode, head);
	if (free_func)
        free_func(&tree_entry->head);
}

void destroy_rbtree(RBTreeRoot *root)
{
    if (root != NULL && root->node != NULL)
        rbtree_destroy(&root->node->head, root->free_func);
    free(root);
}


/*
 * 打印"红黑树"
 *
 * tree       -- 红黑树的节点
 * key        -- 节点的键值
 * direction  --  0，表示该节点是根节点;
 *               -1，表示该节点是它的父结点的左孩子;
 *                1，表示该节点是它的父结点的右孩子。
 */
static void rbtree_print(RBTreeNodeHeader *tree, char* parent_info, int direction, rb_tree_get_nodeinfo get_node_info)
{
    if(tree != NULL)
    {
	RBTreeNode *entry = rb_entry(tree, RBTreeNode, head);
        if(direction==0)    // tree是根节点
            printf("%s(B) is root\n", parent_info);
        else                // tree是分支节点
            printf("%2d(%s) is %2d's %6s child\n",
	    	get_node_info(tree), rb_is_red(tree)? "R" : "B", parent_info,
		direction == 1 ? "right" : "left");

        rbtree_print(tree->left, get_node_info(tree), -1, get_node_info);
        rbtree_print(tree->right, get_node_info(tree),  1, get_node_info);
    }
}

void print_rbtree(RBTreeRoot *root)
{
    if (root != NULL && root->node != NULL) {
        rbtree_print(&root->node->head, root->get_nodeinfo_func(&root->node->head), 0, root->get_nodeinfo_func);
    }
}