05 二分搜索树（BinarySearchTree）

import java.util.LinkedList;
import java.util.Queue;
import java.util.Stack;

/**
 * @author 阿遠
 * Date: 2019/4/30
 * Time: 15:23
 */
public class BinarySearchTree<E extends Comparable<E>> {

    // 内部类定义节点
    private class Node{
        public E e;  // 节点值
        public Node left, right; // 左右节点
        // 构造函数
        public Node(E e) {
            this.e = e;
            this.left = null;
            this.right = null;
        }
    }

    private Node root; // 根节点
    private int size;  // 深度

    public  BinarySearchTree() {
        root = null;
        size = 0;
    }

    public int size() {
        return size;
    }

    public boolean isEmpty() {
         return size == 0;
    }

    // 向二分搜索树中添加新的元素e
//    public void add(E e) {
//        if (root == null) {
//            root = new Node(e);
//            size ++;
//        } else {
//            add(root, e);
//        }
//    }
    // 代码优化
    public void add(E e) {
        root = add(root, e);
    }
    // 向跟为node的二分搜索树种插入元素E，递归算法
//    private void add(Node node, E e) {
//        // 插入结束的条件
//        if (e.equals(node.e)) { // 插入值与节点值相等
//            return;
//        } else if (e.compareTo(node.e) < 0 && node.left == null) {  // 插入值小于节点并且左子树为空
//            node.left = new Node(e);
//            size ++;
//            return;
//        } else if (e.compareTo(node.e) > 0 && node.right == null) { // 插入值大于节点并且右子树为空
//            node.right = new Node(e);
//            size ++;
//            return;
//        }
//        // 递归插入
//        if(e.compareTo(node.e) < 0) {
//            add(node.left , e);
//        } else {
//            add(node.right, e);
//        }
//    }
    // add(Node node, E e) 代码优化: 返回插入新节点后的二分搜索树的根
    private Node add(Node node, E e) {
        if (node == null) {
            size ++;
            return new Node(e);
        }
        if (e.compareTo(node.e) < 0) {
            node.left = add(node.left, e);
        } else if (e.compareTo(node.e) > 0) {
            node.right = add(node.right, e);
        }
        return node;
    }

    // 看二分搜索树中是否包含元素e
    public boolean contains(E e) {
        return contains(root, e);
    }
    private boolean contains(Node node, E e) {
        if (node == null) {
            return false;
        }
        // 结束条件
        if (e.compareTo(node.e) == 0) {
            return true;
        }else if (e.compareTo(node.e) < 0) {  // 没有结束就递归
            return contains(node.left, e);
        }else { //e.compareTo(node.e) > 0
            return contains(node.right, e);
        }
    }

    // 寻找二分搜索树的最小值
    public E minimum() {
        if (size == 0)
            throw new IllegalArgumentException("BinarySearchTree is Empty");
        return minimum(root).e;
    }
    private Node minimum(Node node) {
        if (node.left == null)
            return node;
        return minimum(node.left);
    }

    // 寻找二分搜索树的最大值
    public E maxmum() {
        if (size == 0)
            throw new IllegalArgumentException("BinarySearchTree is Empty");
        return maxmum(root).e;
    }
    private Node maxmum(Node node) {
        if (node.right == null)
            return node;
        return maxmum(node.right);
    }

    // 从二分搜索树中删除最小值所在节点，返回最小值
    public E removeMin() {
        E ret = minimum();
        removeMin(root);
        return ret;
    }
    // 删除掉以node为根的二分搜索树中的最小节点
    // 返回删除节点后新的二分搜索树的根
    private Node removeMin(Node node)  {
        if (node.left == null) {
            Node rightNode = node.right;
            node.right = null;
            size --;
            return rightNode;
        }
        node.left = removeMin(node.left);
        return node;
    }

    // 从二分搜索树中删除最大值所在节点，返回最大值
    public E removeMax() {
        E ret = maxmum();
        removeMax(root);
        return ret;
    }
    // 删除掉以node为根的二分搜索树中的最小节点
    // 返回删除节点后新的二分搜索树的根
    private Node removeMax(Node node)  {
        if (node.right == null) {
            Node leftNode = node.left;
            node.left = null;
            size --;
            return leftNode;
        }
        node.right = removeMax(node.right);
        return node;
    }

    // 从二分搜索树中删除元素为e节点
    public void remove(E e) {
        remove(root, e);
    }
    private Node remove(Node node, E e) {
        if (node == null)  // 如果二分搜索树为空
            return null;
        if (e.compareTo(node.e) < 0) {
            node.left = remove(node.left,e);
            return node;
        } else if (e.compareTo(node.e) > 0) {
            node.right = remove(node.right, e);
            return node;
        }else {  // e == node.e
            // 待删除左子树为空的情况
            if (node.left == null) {
                Node rightNode = node.left;
                node.right = null;
                size --;
                return rightNode;
            }
            // 待删除右子树为空的情况
            if (node.right == null) {
                Node leftNode = node.left;
                node.left = null;
                size --;
                return leftNode;
            }
            // 待删除节点左右子树均不为空的情况
            // 找到比待删除节点大的最小节点，即将删除节点右子树的最小节点
            // 用这个节点顶替待删除节点的位置
            // 该方法的核心代码
            Node successor = minimum(node.right);  // 后继
            successor.right = removeMax(node.right);  // removeMax的作用是将node.right右子树的最小值删除
            successor.left = node.left;
            node.left = node.right = null;
            return successor;
        }
    }

    // 二分搜索树递归前序遍历
    public void preOrder() {
        preOrder(root);
    }
    private void preOrder(Node node) {
        // 递归终止条件
        if (node == null) {
            return;
        }
        // 对递归元素进行操作
        System.out.println(node.e);
        // 没有结束就递归
        preOrder(node.left);
        preOrder(node.right);
    }

    // 二叉搜索树的非递归前序遍历
    public void preOrderNR() {

        Stack<Node> stack = new Stack<>();
        stack.push(root);
        while (!stack.isEmpty()) {
            Node cur = stack.pop();
            System.out.println(cur.e);
            if (cur.right != null) {
                stack.push(cur.right);
            }
            if (cur.left != null) {
                stack.push(cur.left);
            }
        }
    }

    // 二分搜索树的中序遍历
    public void inOrder() {
        inOrder(root);
    }
    // 中序遍历以node为根的二分搜索树，递归算法  二分搜索树的中序遍历就是元素从小到大排序后的结果
    private void inOrder(Node node) {
        if (node == null) {
            return;
        }
        inOrder(node.left);
        System.out.println(node.e);
        inOrder(node.right);
    }

    // 二分搜索树的后序遍历
    public void postOrder() {
        postOrder(root);
    }
    // 后序遍历以node为根的二分搜索树，递归算法
    private void postOrder(Node node) {
        if (node == null) {
            return;
        }
        postOrder(node.left);
        postOrder(node.right);
        System.out.println(node.e);
    }

    // 前面实现的前中后三种遍历本质上都是深度优先的遍历，下面介绍层序遍历，以层为优先的遍历
    // 层序遍历:一层一层的遍历
    public void levelOrder() {
        Queue<Node> q = new LinkedList<>();  // Queue在java中是一个借口，需使用具体的类（LinkedList）进行实现
        q.add(root);
        while (!q.isEmpty()) {
            Node cur = q.remove();
            System.out.println(cur.e);

            if (cur.left != null)
                q.add(cur.left);
            if (cur.right != null)
                q.add(cur.right);
        }
    }

    @Override
    public String toString() {
        StringBuilder res = new StringBuilder();
        generateBSTString(root, 0, res);
        return res.toString();
    }
    // 生成以node为根节点，深度为depth的描述二叉树的字符串
    private void generateBSTString(Node node, int depth, StringBuilder res) {
        if (node == null) {
            res.append(generateDepthString(depth) + node.e + "null\n");
            return;
        }
        res.append(generateDepthString(depth) + node.e + "null\n");
        generateBSTString(node.left, depth + 1, res);
        generateBSTString(node.right, depth + 1, res);
    }

    private String generateDepthString(int depth) {
        StringBuilder res = new StringBuilder();
        for (int i = 0; i < depth; i ++) {
            res.append("--");
        }
        return res.toString();
    }
}