package com.tree.rbtree;

/**
 * Java 語(yǔ)言: 紅黑樹(shù)
 *
 * @author huanmin
 */

public class RBTree<T extends Comparable<T>> {

    private RBTNode<T> mRoot;    // 根結(jié)點(diǎn)

    private static final boolean RED   = false;
    private static final boolean BLACK = true;

    public class RBTNode<T extends Comparable<T>> {
        boolean color;        // 顏色
        T key;                // 關(guān)鍵字(鍵值)
        RBTNode<T> left;    // 左孩子
        RBTNode<T> right;    // 右孩子
        RBTNode<T> parent;    // 父結(jié)點(diǎn)

        public RBTNode(T key, boolean color, RBTNode<T> parent, RBTNode<T> left, RBTNode<T> right) {
            this.key = key;
            this.color = color;
            this.parent = parent;
            this.left = left;
            this.right = right;
        }

        public T getKey() {
            return key;
        }

        @Override
        public String toString() {
            return ""+key+(this.color==RED?"(R)":"B");
        }
    }

    public RBTree() {
        mRoot=null;
    }

    private RBTNode<T> parentOf(RBTNode<T> node) {
        return node!=null ? node.parent : null;
    }
    private boolean colorOf(RBTNode<T> node) {
        return node!=null ? node.color : BLACK;
    }
    private boolean isRed(RBTNode<T> node) {
        return ((node!=null)&&(node.color==RED)) ? true : false;
    }
    private boolean isBlack(RBTNode<T> node) {
        return !isRed(node);
    }
    private void setBlack(RBTNode<T> node) {
        if (node!=null) {
            node.color = BLACK;
        }
    }
    private void setRed(RBTNode<T> node) {
        if (node!=null) {
            node.color = RED;
        }
    }
    private void setParent(RBTNode<T> node, RBTNode<T> parent) {
        if (node!=null) {
            node.parent = parent;
        }
    }
    private void setColor(RBTNode<T> node, boolean color) {
        if (node!=null) {
            node.color = color;
        }
    }

    /*
     * 前序遍歷"紅黑樹(shù)"
     */
    private void preOrder(RBTNode<T> tree) {
        if(tree != null) {
            System.out.print(tree.key+" ");
            preOrder(tree.left);
            preOrder(tree.right);
        }
    }

    public void preOrder() {
        preOrder(mRoot);
    }

    /*
     * 中序遍歷"紅黑樹(shù)"
     */
    private void inOrder(RBTNode<T> tree) {
        if(tree != null) {
            inOrder(tree.left);
            System.out.print(tree.key+" ");
            inOrder(tree.right);
        }
    }

    public void inOrder() {
        inOrder(mRoot);
    }


    /*
     * 后序遍歷"紅黑樹(shù)"
     */
    private void postOrder(RBTNode<T> tree) {
        if(tree != null)
        {
            postOrder(tree.left);
            postOrder(tree.right);
            System.out.print(tree.key+" ");
        }
    }

    public void postOrder() {
        postOrder(mRoot);
    }


    /*
     * (遞歸實(shí)現(xiàn))查找"紅黑樹(shù)x"中鍵值為key的節(jié)點(diǎn)
     */
    private RBTNode<T> search(RBTNode<T> x, T key) {
        if (x==null) {
            return x;
        }

        int cmp = key.compareTo(x.key);
        if (cmp < 0) {
            return search(x.left, key);
        } else if (cmp > 0) {
            return search(x.right, key);
        } else {
            return x;
        }
    }

    public RBTNode<T> search(T key) {
        return search(mRoot, key);
    }

    /*
     * (非遞歸實(shí)現(xiàn))查找"紅黑樹(shù)x"中鍵值為key的節(jié)點(diǎn)
     */
    private RBTNode<T> iterativeSearch(RBTNode<T> x, T key) {
        while (x!=null) {
            int cmp = key.compareTo(x.key);

            if (cmp < 0) {
                x = x.left;
            } else if (cmp > 0) {
                x = x.right;
            } else {
                return x;
            }
        }

        return x;
    }

    public RBTNode<T> iterativeSearch(T key) {
        return iterativeSearch(mRoot, key);
    }

    /*
     * 查找最小結(jié)點(diǎn)：返回tree為根結(jié)點(diǎn)的紅黑樹(shù)的最小結(jié)點(diǎn)。
     */
    private RBTNode<T> minimum(RBTNode<T> tree) {
        if (tree == null) {
            return null;
        }

        while(tree.left != null) {
            tree = tree.left;
        }
        return tree;
    }

    public T minimum() {
        RBTNode<T> p = minimum(mRoot);
        if (p != null) {
            return p.key;
        }

        return null;
    }

    /*
     * 查找最大結(jié)點(diǎn)：返回tree為根結(jié)點(diǎn)的紅黑樹(shù)的最大結(jié)點(diǎn)。
     */
    private RBTNode<T> maximum(RBTNode<T> tree) {
        if (tree == null) {
            return null;
        }

        while(tree.right != null) {
            tree = tree.right;
        }
        return tree;
    }

    public T maximum() {
        RBTNode<T> p = maximum(mRoot);
        if (p != null) {
            return p.key;
        }

        return null;
    }

    /*
     * 找結(jié)點(diǎn)(x)的后繼結(jié)點(diǎn)。即，查找"紅黑樹(shù)中數(shù)據(jù)值大于該結(jié)點(diǎn)"的"最小結(jié)點(diǎn)"。
     */
    public RBTNode<T> successor(RBTNode<T> x) {
        // 如果x存在右孩子，則"x的后繼結(jié)點(diǎn)"為 "以其右孩子為根的子樹(shù)的最小結(jié)點(diǎn)"。
        if (x.right != null) {
            return minimum(x.right);
        }

        // 如果x沒(méi)有右孩子。則x有以下兩種可能：
        // (01) x是"一個(gè)左孩子"，則"x的后繼結(jié)點(diǎn)"為 "它的父結(jié)點(diǎn)"。
        // (02) x是"一個(gè)右孩子"，則查找"x的最低的父結(jié)點(diǎn)，并且該父結(jié)點(diǎn)要具有左孩子"，找到的這個(gè)"最低的父結(jié)點(diǎn)"就是"x的后繼結(jié)點(diǎn)"。
        RBTNode<T> y = x.parent;
        while ((y!=null) && (x==y.right)) {
            x = y;
            y = y.parent;
        }

        return y;
    }

    /*
     * 找結(jié)點(diǎn)(x)的前驅(qū)結(jié)點(diǎn)。即，查找"紅黑樹(shù)中數(shù)據(jù)值小于該結(jié)點(diǎn)"的"最大結(jié)點(diǎn)"。
     */
    public RBTNode<T> predecessor(RBTNode<T> x) {
        // 如果x存在左孩子，則"x的前驅(qū)結(jié)點(diǎn)"為 "以其左孩子為根的子樹(shù)的最大結(jié)點(diǎn)"。
        if (x.left != null) {
            return maximum(x.left);
        }

        // 如果x沒(méi)有左孩子。則x有以下兩種可能：
        // (01) x是"一個(gè)右孩子"，則"x的前驅(qū)結(jié)點(diǎn)"為 "它的父結(jié)點(diǎn)"。
        // (01) x是"一個(gè)左孩子"，則查找"x的最低的父結(jié)點(diǎn)，并且該父結(jié)點(diǎn)要具有右孩子"，找到的這個(gè)"最低的父結(jié)點(diǎn)"就是"x的前驅(qū)結(jié)點(diǎn)"。
        RBTNode<T> y = x.parent;
        while ((y!=null) && (x==y.left)) {
            x = y;
            y = y.parent;
        }

        return y;
    }

    /*
     * 對(duì)紅黑樹(shù)的節(jié)點(diǎn)(x)進(jìn)行左旋轉(zhuǎn)
     *
     * 左旋示意圖(對(duì)節(jié)點(diǎn)x進(jìn)行左旋)：
     *      px                              px
     *     /                               /
     *    x                               y
     *   /  \      --(左旋)-.           / \                #
     *  lx   y                          x  ry
     *     /   \                       /  \
     *    ly   ry                     lx  ly
     *
     *
     */
    private void leftRotate(RBTNode<T> x) {
        // 設(shè)置x的右孩子為y
        RBTNode<T> y = x.right;

        // 將 “y的左孩子” 設(shè)為 “x的右孩子”；
        // 如果y的左孩子非空，將 “x” 設(shè)為 “y的左孩子的父親”
        x.right = y.left;
        if (y.left != null) {
            y.left.parent = x;
        }

        // 將 “x的父親” 設(shè)為 “y的父親”
        y.parent = x.parent;

        if (x.parent == null) {
            this.mRoot = y;            // 如果 “x的父親” 是空節(jié)點(diǎn)，則將y設(shè)為根節(jié)點(diǎn)
        } else {
            if (x.parent.left == x) {
                x.parent.left = y;    // 如果 x是它父節(jié)點(diǎn)的左孩子，則將y設(shè)為“x的父節(jié)點(diǎn)的左孩子”
            } else {
                x.parent.right = y;    // 如果 x是它父節(jié)點(diǎn)的左孩子，則將y設(shè)為“x的父節(jié)點(diǎn)的左孩子”
            }
        }

        // 將 “x” 設(shè)為 “y的左孩子”
        y.left = x;
        // 將 “x的父節(jié)點(diǎn)” 設(shè)為 “y”
        x.parent = y;
    }

    /*
     * 對(duì)紅黑樹(shù)的節(jié)點(diǎn)(y)進(jìn)行右旋轉(zhuǎn)
     *
     * 右旋示意圖(對(duì)節(jié)點(diǎn)y進(jìn)行左旋)：
     *            py                               py
     *           /                                /
     *          y                                x
     *         /  \      --(右旋)-.            /  \                     #
     *        x   ry                           lx   y
     *       / \                                   / \                   #
     *      lx  rx                                rx  ry
     *
     */
    private void rightRotate(RBTNode<T> y) {
        // 設(shè)置x是當(dāng)前節(jié)點(diǎn)的左孩子。
        RBTNode<T> x = y.left;

        // 將 “x的右孩子” 設(shè)為 “y的左孩子”；
        // 如果"x的右孩子"不為空的話，將 “y” 設(shè)為 “x的右孩子的父親”
        y.left = x.right;
        if (x.right != null) {
            x.right.parent = y;
        }

        // 將 “y的父親” 設(shè)為 “x的父親”
        x.parent = y.parent;

        if (y.parent == null) {
            this.mRoot = x;            // 如果 “y的父親” 是空節(jié)點(diǎn)，則將x設(shè)為根節(jié)點(diǎn)
        } else {
            if (y == y.parent.right) {
                y.parent.right = x;    // 如果 y是它父節(jié)點(diǎn)的右孩子，則將x設(shè)為“y的父節(jié)點(diǎn)的右孩子”
            } else {
                y.parent.left = x;    // (y是它父節(jié)點(diǎn)的左孩子) 將x設(shè)為“x的父節(jié)點(diǎn)的左孩子”
            }
        }

        // 將 “y” 設(shè)為 “x的右孩子”
        x.right = y;

        // 將 “y的父節(jié)點(diǎn)” 設(shè)為 “x”
        y.parent = x;
    }

    /*
     * 紅黑樹(shù)插入修正函數(shù)
     *
     * 在向紅黑樹(shù)中插入節(jié)點(diǎn)之后(失去平衡)，再調(diào)用該函數(shù)；
     * 目的是將它重新塑造成一顆紅黑樹(shù)。
     *
     * 參數(shù)說(shuō)明：
     *     node 插入的結(jié)點(diǎn)        // 對(duì)應(yīng)《算法導(dǎo)論》中的z
     */
    private void insertFixUp(RBTNode<T> node) {
        RBTNode<T> parent, gparent;

        // 若“父節(jié)點(diǎn)存在，并且父節(jié)點(diǎn)的顏色是紅色”
        while (((parent = parentOf(node))!=null) && isRed(parent)) {
            gparent = parentOf(parent);

            //若“父節(jié)點(diǎn)”是“祖父節(jié)點(diǎn)的左孩子”
            if (parent == gparent.left) {
                // Case 1條件：叔叔節(jié)點(diǎn)是紅色
                RBTNode<T> uncle = gparent.right;
                if ((uncle!=null) && isRed(uncle)) {
                    setBlack(uncle);
                    setBlack(parent);
                    setRed(gparent);
                    node = gparent;
                    continue;
                }

                // Case 2條件：叔叔是黑色，且當(dāng)前節(jié)點(diǎn)是右孩子
                if (parent.right == node) {
                    RBTNode<T> tmp;
                    leftRotate(parent);
                    tmp = parent;
                    parent = node;
                    node = tmp;
                }

                // Case 3條件：叔叔是黑色，且當(dāng)前節(jié)點(diǎn)是左孩子。
                setBlack(parent);
                setRed(gparent);
                rightRotate(gparent);
            } else {    //若“z的父節(jié)點(diǎn)”是“z的祖父節(jié)點(diǎn)的右孩子”
                // Case 1條件：叔叔節(jié)點(diǎn)是紅色
                RBTNode<T> uncle = gparent.left;
                if ((uncle!=null) && isRed(uncle)) {
                    setBlack(uncle);
                    setBlack(parent);
                    setRed(gparent);
                    node = gparent;
                    continue;
                }

                // Case 2條件：叔叔是黑色，且當(dāng)前節(jié)點(diǎn)是左孩子
                if (parent.left == node) {
                    RBTNode<T> tmp;
                    rightRotate(parent);
                    tmp = parent;
                    parent = node;
                    node = tmp;
                }

                // Case 3條件：叔叔是黑色，且當(dāng)前節(jié)點(diǎn)是右孩子。
                setBlack(parent);
                setRed(gparent);
                leftRotate(gparent);
            }
        }

        // 將根節(jié)點(diǎn)設(shè)為黑色
        setBlack(this.mRoot);
    }

    /*
     * 將結(jié)點(diǎn)插入到紅黑樹(shù)中
     *
     * 參數(shù)說(shuō)明：
     *     node 插入的結(jié)點(diǎn)        // 對(duì)應(yīng)《算法導(dǎo)論》中的node
     */
    private void insert(RBTNode<T> node) {
        int cmp;
        RBTNode<T> y = null;
        RBTNode<T> x = this.mRoot;

        // 1. 將紅黑樹(shù)當(dāng)作一顆二叉查找樹(shù)，將節(jié)點(diǎn)添加到二叉查找樹(shù)中。
        while (x != null) {
            y = x;
            cmp = node.key.compareTo(x.key);
            if (cmp < 0) {
                x = x.left;
            } else {
                x = x.right;
            }
        }

        node.parent = y;
        if (y!=null) {
            cmp = node.key.compareTo(y.key);
            if (cmp < 0) {
                y.left = node;
            } else {
                y.right = node;
            }
        } else {
            this.mRoot = node;
        }

        // 2. 設(shè)置節(jié)點(diǎn)的顏色為紅色
        node.color = RED;

        // 3. 將它重新修正為一顆二叉查找樹(shù)
        insertFixUp(node);
    }

    /*
     * 新建結(jié)點(diǎn)(key)，并將其插入到紅黑樹(shù)中
     *
     * 參數(shù)說(shuō)明：
     *     key 插入結(jié)點(diǎn)的鍵值
     */
    public void insert(T key) {
        RBTNode<T> node=new RBTNode<T>(key,BLACK,null,null,null);

        // 如果新建結(jié)點(diǎn)失敗，則返回。
        if (node != null) {
            insert(node);
        }
    }


    /*
     * 紅黑樹(shù)刪除修正函數(shù)
     *
     * 在從紅黑樹(shù)中刪除插入節(jié)點(diǎn)之后(紅黑樹(shù)失去平衡)，再調(diào)用該函數(shù)；
     * 目的是將它重新塑造成一顆紅黑樹(shù)。
     *
     * 參數(shù)說(shuō)明：
     *     node 待修正的節(jié)點(diǎn)
     */
    private void removeFixUp(RBTNode<T> node, RBTNode<T> parent) {
        RBTNode<T> other;

        while ((node==null || isBlack(node)) && (node != this.mRoot)) {
            if (parent.left == node) {
                other = parent.right;
                if (isRed(other)) {
                    // Case 1: x的兄弟w是紅色的
                    setBlack(other);
                    setRed(parent);
                    leftRotate(parent);
                    other = parent.right;
                }

                if ((other.left==null || isBlack(other.left)) &&
                        (other.right==null || isBlack(other.right))) {
                    // Case 2: x的兄弟w是黑色，且w的倆個(gè)孩子也都是黑色的
                    setRed(other);
                    node = parent;
                    parent = parentOf(node);
                } else {

                    if (other.right==null || isBlack(other.right)) {
                        // Case 3: x的兄弟w是黑色的，并且w的左孩子是紅色，右孩子為黑色。
                        setBlack(other.left);
                        setRed(other);
                        rightRotate(other);
                        other = parent.right;
                    }
                    // Case 4: x的兄弟w是黑色的；并且w的右孩子是紅色的，左孩子任意顏色。
                    setColor(other, colorOf(parent));
                    setBlack(parent);
                    setBlack(other.right);
                    leftRotate(parent);
                    node = this.mRoot;
                    break;
                }
            } else {

                other = parent.left;
                if (isRed(other)) {
                    // Case 1: x的兄弟w是紅色的
                    setBlack(other);
                    setRed(parent);
                    rightRotate(parent);
                    other = parent.left;
                }

                if ((other.left==null || isBlack(other.left)) &&
                        (other.right==null || isBlack(other.right))) {
                    // Case 2: x的兄弟w是黑色，且w的倆個(gè)孩子也都是黑色的
                    setRed(other);
                    node = parent;
                    parent = parentOf(node);
                } else {

                    if (other.left==null || isBlack(other.left)) {
                        // Case 3: x的兄弟w是黑色的，并且w的左孩子是紅色，右孩子為黑色。
                        setBlack(other.right);
                        setRed(other);
                        leftRotate(other);
                        other = parent.left;
                    }

                    // Case 4: x的兄弟w是黑色的；并且w的右孩子是紅色的，左孩子任意顏色。
                    setColor(other, colorOf(parent));
                    setBlack(parent);
                    setBlack(other.left);
                    rightRotate(parent);
                    node = this.mRoot;
                    break;
                }
            }
        }

        if (node!=null) {
            setBlack(node);
        }
    }

    /*
     * 刪除結(jié)點(diǎn)(node)，并返回被刪除的結(jié)點(diǎn)
     *
     * 參數(shù)說(shuō)明：
     *     node 刪除的結(jié)點(diǎn)
     */
    private void 
    remove(RBTNode<T> node) {
        RBTNode<T> child, parent;
        boolean color;

        // 被刪除節(jié)點(diǎn)的"左右孩子都不為空"的情況。
        if ( (node.left!=null) && (node.right!=null) ) {
            // 被刪節(jié)點(diǎn)的后繼節(jié)點(diǎn)。(稱為"取代節(jié)點(diǎn)")
            // 用它來(lái)取代"被刪節(jié)點(diǎn)"的位置，然后再將"被刪節(jié)點(diǎn)"去掉。
            RBTNode<T> replace = node;

            // 獲取后繼節(jié)點(diǎn)
            replace = replace.right;
            while (replace.left != null) {
                replace = replace.left;
            }

            // "node節(jié)點(diǎn)"不是根節(jié)點(diǎn)(只有根節(jié)點(diǎn)不存在父節(jié)點(diǎn))
            if (parentOf(node)!=null) {
                if (parentOf(node).left == node) {
                    parentOf(node).left = replace;
                } else {
                    parentOf(node).right = replace;
                }
            } else {
                // "node節(jié)點(diǎn)"是根節(jié)點(diǎn)，更新根節(jié)點(diǎn)。
                this.mRoot = replace;
            }

            // child是"取代節(jié)點(diǎn)"的右孩子，也是需要"調(diào)整的節(jié)點(diǎn)"。
            // "取代節(jié)點(diǎn)"肯定不存在左孩子！因?yàn)樗且粋€(gè)后繼節(jié)點(diǎn)。
            child = replace.right;
            parent = parentOf(replace);
            // 保存"取代節(jié)點(diǎn)"的顏色
            color = colorOf(replace);

            // "被刪除節(jié)點(diǎn)"是"它的后繼節(jié)點(diǎn)的父節(jié)點(diǎn)"
            if (parent == node) {
                parent = replace;
            } else {
                // child不為空
                if (child!=null) {
                    setParent(child, parent);
                }
                parent.left = child;

                replace.right = node.right;
                setParent(node.right, replace);
            }

            replace.parent = node.parent;
            replace.color = node.color;
            replace.left = node.left;
            node.left.parent = replace;

            if (color == BLACK) {
                removeFixUp(child, parent);
            }

            node = null;
            return ;
        }

        if (node.left !=null) {
            child = node.left;
        } else {
            child = node.right;
        }

        parent = node.parent;
        // 保存"取代節(jié)點(diǎn)"的顏色
        color = node.color;

        if (child!=null) {
            child.parent = parent;
        }

        // "node節(jié)點(diǎn)"不是根節(jié)點(diǎn)
        if (parent!=null) {
            if (parent.left == node) {
                parent.left = child;
            } else {
                parent.right = child;
            }
        } else {
            this.mRoot = child;
        }

        if (color == BLACK) {
            removeFixUp(child, parent);
        }
        node = null;
    }

    /*
     * 刪除結(jié)點(diǎn)(z)，并返回被刪除的結(jié)點(diǎn)
     *
     * 參數(shù)說(shuō)明：
     *     tree 紅黑樹(shù)的根結(jié)點(diǎn)
     *     z 刪除的結(jié)點(diǎn)
     */
    public void remove(T key) {
        RBTNode<T> node;

        if ((node = search(mRoot, key)) != null) {
            remove(node);
        }
    }

    /*
     * 銷(xiāo)毀紅黑樹(shù)
     */
    private void destroy(RBTNode<T> tree) {
        if (tree==null) {
            return ;
        }

        if (tree.left != null) {
            destroy(tree.left);
        }
        if (tree.right != null) {
            destroy(tree.right);
        }

        tree=null;
    }

    public void clear() {
        destroy(mRoot);
        mRoot = null;
    }

    /*
     * 打印"紅黑樹(shù)"
     *
     * key        -- 節(jié)點(diǎn)的鍵值
     * direction  --  0，表示該節(jié)點(diǎn)是根節(jié)點(diǎn);
     *               -1，表示該節(jié)點(diǎn)是它的父結(jié)點(diǎn)的左孩子;
     *                1，表示該節(jié)點(diǎn)是它的父結(jié)點(diǎn)的右孩子。
     */
    private void print(RBTNode<T> tree, T key, int direction) {

        if(tree != null) {

            if(direction==0)    // tree是根節(jié)點(diǎn)
            {
                System.out.printf("%2d(B) is root\n", tree.key);
            } else                // tree是分支節(jié)點(diǎn)
            {
                System.out.printf("%2d(%s) is %2d's %6s child\n", tree.key, isRed(tree)?"R":"B", key, direction==1?"right" : "left");
            }

            print(tree.left, tree.key, -1);
            print(tree.right,tree.key,  1);
        }
    }

    public void print() {
        if (mRoot != null) {
            print(mRoot, mRoot.key, 0);
        }
    }
}