package com.boco.common.util;


import java.math.BigDecimal;

/**
 * 由於Java的簡單型別不能夠精確的對浮點數進行運算， <br>這個工具類提供精確的浮點數運算，包括加減乘除和四捨五入。
 * @author lb
 */
public final class Arith {
    // 預設除法運算精度
    private static final int DEF_DIV_SCALE = 2;
    
    // 這個類不能例項化
    private Arith() {
    }
    
    /**
     * 提供精確的加法運算。
     * 
     * @param v1 被加數
     * @param v2 加數
     * @return 兩個引數的和
     */
    public static double add(double v1, double v2) {
        BigDecimal b1 = new BigDecimal(Double.toString(v1));
        BigDecimal b2 = new BigDecimal(Double.toString(v2));
        return b1.add(b2).doubleValue();
    }
    
    /**
     * 提供精確的減法運算。
     * 
     * @param v1 被減數
     * @param v2 減數
     * @return 兩個引數的差
     */
    public static double sub(double v1, double v2) {
        BigDecimal b1 = new BigDecimal(Double.toString(v1));
        BigDecimal b2 = new BigDecimal(Double.toString(v2));
        return b1.subtract(b2).doubleValue();
    }
    
    /**
     * 提供精確的減法運算。
     * 
     * @param v1 被減數
     * @param v2 減數
     * @return 兩個引數的差
     */
    public static double sub(Number v1, Number v2) {
        BigDecimal b1 = new BigDecimal(v1.toString());
        BigDecimal b2 = new BigDecimal(v2.toString());
        return b1.subtract(b2).doubleValue();
    }
    
    /**
     * 提供精確的乘法運算。
     * 
     * @param v1 被乘數
     * @param v2 乘數
     * @return 兩個引數的積
     */
    public static double mul(double v1, double v2) {
        BigDecimal b1 = new BigDecimal(Double.toString(v1));
        BigDecimal b2 = new BigDecimal(Double.toString(v2));
        return b1.multiply(b2).doubleValue();
    }
    
    /**
     * 提供（相對）精確的除法運算，當發生除不盡的情況時， 精確到小數點以後10位，以後的數字四捨五入。
     * 
     * @param v1 被除數
     * @param v2 除數
     * @return 兩個引數的商
     */
    public static double div(double v1, double v2) {
        return div(v1, v2, DEF_DIV_SCALE);
    }
    
    /**
     * 提供（相對）精確的除法運算。 當發生除不盡的情況時，由scale引數指定精度，以後的數字四捨五入。
     * 
     * @param v1 被除數
     * @param v2 除數
     * @param scale 表示表示需要精確到小數點以後幾位。
     * @return 兩個引數的商
     */
    public static double div(double v1, double v2, int scale) {
        if (scale < 0) {
            throw new IllegalArgumentException("The scale must be a positive integer or zero");
        }
        BigDecimal b1 = new BigDecimal(Double.toString(v1));
        BigDecimal b2 = new BigDecimal(Double.toString(v2));
        return b1.divide(b2, scale, BigDecimal.ROUND_HALF_UP).doubleValue();
    }
    
    /**
     * 提供（相對）精確的除法運算。 當發生除不盡的情況時，由scale引數指定精度，由roundingMode引數指定運算模式。
     * 
     * @param v1 被除數
     * @param v2 除數
     * @param scale 表示表示需要精確到小數點以後幾位。
     * @param roundingMode 可以取BigDecimal中的ROUND_UP、ROUND_DOWN、ROUND_CEILING、ROUND_FLOOR、ROUND_HALF_UP、ROUND_HALF_DOWN、ROUND_HALF_EVEN
     * @return 兩個引數的商
     */
    public static double div(double v1, double v2, int scale, int roundingMode) {
        if (scale < 0) {
            throw new IllegalArgumentException("The scale must be a positive integer or zero");
        }
        if (roundingMode < 0) {
            throw new IllegalArgumentException("The scale must be a positive integer or zero");
        }
        BigDecimal b1 = new BigDecimal(Double.toString(v1));
        BigDecimal b2 = new BigDecimal(Double.toString(v2));
        return b1.divide(b2, scale, roundingMode).doubleValue();
    }
    
    /**
     * 提供精確的小數位四捨五入處理。
     * 
     * @param v 需要四捨五入的數字
     * @param scale 小數點後保留幾位
     * @return 四捨五入後的結果
     */
    public static double round(double v, int scale) {
        if (scale < 0) {
            throw new IllegalArgumentException("The scale must be a positive integer or zero");
        }
        BigDecimal b = new BigDecimal(Double.toString(v));
        BigDecimal one = new BigDecimal("1");
        return b.divide(one, scale, BigDecimal.ROUND_HALF_UP).doubleValue();
    }
}