import utils.ScoreUtil;

/**
 * 相关与回归
 * @description 利用相关与回归原理计算二变量[自变量和因变量]数据的最佳拟合线，
 *     并通过最佳拟合线[y=a+bx]来挖掘二变量[自变量和因变量]数据之间的关系，从而通过自变量的值预测估计因变量的值。
 *     应用场景：例如，通过天气状态预测演唱会到场的人数；或者通过光照时长来估计植物的生长情况。
 *     局限性：只能根据已有的数据信息进行估计，不一定适用于数据限制意外的范围。
 *        例如，现有2000年到2010年的数据信息，就不能预测估计2010年以后的数据。
 * @author candymoon
 * @2015-8-13下午4:19:57
 */
public class CorrelationAndRegression {
    /**
     * 求变量值的平均值(公式：平均值=总和/总数)
     * @param varData 变量数据值
     * @param fraDigits 结果保留位数
     * @return 平均值
     */
    public static double calculateAvgValue(double[] varData,int fraDigits){
        double avgValue = 0;
        int  len = varData.length;//数组长度
        for (int i = 0; i < varData.length; i++) {
            avgValue += varData[i];
        }
        //计算均值
        avgValue = avgValue/len;
        //并将结果保留3位小数（四舍五入）
        String avgValue_String = ScoreUtil.getFractionDigits(avgValue, fraDigits);
        avgValue = Double.valueOf(avgValue_String);
        return avgValue;
    } 
    /**
     * 计算最佳拟合线(y=a+bx)的斜率b
     * @description 最佳拟合线(y=a+bx)的斜率b的计算公式为：b=∑((x-xAvg)(y-yAvg))/∑(x-xAvg)²
     * ,其中x为自变量，xAvg为自变量均值，y为因变量，yAvg为因变量均值。
     * @param twoVarData 二变量数据
     * @param fraDigits 结果保留位数
     * @return 斜率
     */
    public static double calculateSlope(double[][] twoVarData,int fraDigits){
        double slope = 0;//斜率
        double iVarAvg = 0;//自变量均值
        double dVarAvg = 0;//因变量均值
        //计算自变量均值和因变量均值
        iVarAvg = calculateAvgValue(twoVarData[0],fraDigits);
        dVarAvg = calculateAvgValue(twoVarData[1],fraDigits);
        int iVarLen = twoVarData[0].length;
        double numerator = 0;//分子 
        double denominator = 0;//分母
        //计算公式的分子和分母
        for (int i = 0; i < iVarLen; i++) {
            double x = twoVarData[0][i];
            double y = twoVarData[1][i];
            numerator += (x-iVarAvg)*(y-dVarAvg);
            denominator += (x-iVarAvg)*(x-iVarAvg);
        }
        //计算斜率
        slope = numerator/denominator;
        //并将结果保留几位小数（四舍五入）
        String slope_String = ScoreUtil.getFractionDigits(slope, fraDigits);
        slope = Double.valueOf(slope_String);
        return slope;
    }
    /**
     * 计算最佳拟合线(y=a+bx)的切距a
     * @description 因为最佳拟合线要经过点(自变量均值，因变量均值),所以其计算公式为：
     *              a=dVarAvg-b*iVarAvg
     * @param slope 斜率
     * @param iVarAvg 自变量
     * @param dVarAvg 因变量
     * @param fraDigits 结果保留位数
     * @return 切距
     */
    public static double calculateTangentDistance(double slope,double iVarAvg,double dVarAvg,int fraDigits){
        double tanDis = 0;//切距
        //计算切距
        tanDis = dVarAvg-(slope*iVarAvg);
        //并将结果保留3位小数（四舍五入）
        String tanDis_String = ScoreUtil.getFractionDigits(tanDis, fraDigits);
        tanDis = Double.valueOf(tanDis_String);
        return tanDis;
    }
    /**
     * 计算变量数据的标准差
     * @description 标准差计算公式为：标准差 =((var-varAvg)²/(n-1))^2
     * @param varData 变量数据
     * @param fraDigits 结果保留位数
     * @return 标准差
     */
    public static double calculateStandardDeviation(double[] varData,int fraDigits){
        double standardDev = 0;//标准差
        double varAvg = 0;//变量均值
        double denominator = 0;//分母
        //计算变量均值
        varAvg = calculateAvgValue(varData,fraDigits);
        int varDataLen = varData.length;
        for (int i = 0; i < varDataLen; i++) {
            double var = varData[i];
            denominator += (var-varAvg)*(var-varAvg);
        }
        //计算标准差
        standardDev = Math.pow(denominator/(varDataLen-1),0.5);
        //并将结果保留3位小数（四舍五入）
        String standardDev_String = ScoreUtil.getFractionDigits(standardDev, fraDigits);
        standardDev = Double.valueOf(standardDev_String);
        return standardDev;
    }
    /**
     * 计算相关系数
     * @description 相关系数表示最佳拟合线与二变量数据的拟合程度，相关系数计算公式为：r = (b*Sx)/Sy;
     *  r的取值范围为[-1,1]，当|r|越接近1，则表示拟合程度越高；当|r|越接近0，则表示拟合程度越低
     *  (1)当r=-1时，表示完全负相关;(2)当r=1时，表示完全正相关;(3)当r=0时，表示不相关。
     * @param slope 斜率
     * @param Sx 自变量的标准差
     * @param Sy 因变量的标准差
     * @param fraDigits 结果保留位数
     * @return 相关系数
     */
    public static double calculateCorrelationCoefficient(double slope,double Sx,double Sy,int fraDigits){
        double r = 0;//相关系数
        r = (slope*Sx)/Sy;
        //并将结果保留3位小数（四舍五入）
        String r_String = ScoreUtil.getFractionDigits(r, fraDigits);
        r = Double.valueOf(r_String);
        return r;
    }
    /**
     * 计算因变量的估计值
     * @description 利用最佳拟合线方程y=a+bx求解
     * @param slope 最佳拟合线的斜率
     * @param tangentDistance 最佳拟合线的切距
     * @param testiVar 测试自变量值
     * @param fraDigits 结果保留几位小数
     * @return 因变量的估计值
     */
    public static double calculateEstimatedValue(double slope,double tangentDistance,double testiVar,int fraDigits){
        double estValue = 0;//估计值
        //利用最佳拟合线方程y=a+bx求解
        estValue = tangentDistance+(slope*testiVar);
        //并将结果保留3位小数（四舍五入）
        String estValue_String = ScoreUtil.getFractionDigits(estValue, fraDigits);
        estValue = Double.valueOf(estValue_String);
        return estValue;
    }
    /**
     * 求斜率、切距、最佳拟合线、相关系数
     * @param twoVarData 二变量数据
     * @param testiVar 测试值
     * @param fraDigits 结果保留几位小数
     * @return 字符串结果数组{斜率、切距、最佳拟合线、相关系数}
     */
    public static String[] analyze(double[][] twoVarData,int fraDigits){
        String[] result = new String[4];//字符串结果数组
        String bestFittingLine = "";
        double iVarAvg = 0;//自变量均值
        double dVarAvg = 0;//因变量均值
        double b = 0;//斜率
        double a = 0;//切距
        double r = 0;//相关系数
        double Sx = 0;//自变量的标准差
        double Sy = 0;//因变量的标准差
        //计算自变量和因变量的均值
        iVarAvg = calculateAvgValue(twoVarData[0],fraDigits);
        dVarAvg = calculateAvgValue(twoVarData[1],fraDigits);
        //计算斜率
        b = calculateSlope(twoVarData,fraDigits);
        //计算切距
        a = calculateTangentDistance(b,iVarAvg,dVarAvg,fraDigits);
        //计算自变量和因变量的标准差
        Sx = calculateStandardDeviation(twoVarData[0],fraDigits);
        Sy = calculateStandardDeviation(twoVarData[1],fraDigits);
        //计算相关系数
        r = calculateCorrelationCoefficient(b,Sx,Sy,fraDigits);
        //组合最佳拟合线方程
        bestFittingLine = "y="+a+"+"+b+"x";
        //将结果加入到结果数组
        result[0]= b+"";
        result[1]= a+"";
        result[2]= bestFittingLine+"";
        result[3]= r+"";
        return result;
    }

    /**
     * @param args
     */
    public static void main(String[] args) {
        /*
         * iVar是independent variable(自变量)的缩写
         * dVar是dependent variable(因变量)的缩写
         */
         double[] iVar = {1.9,2.5,3.2,3.8,4.7,5.5,5.9,7.2};//自变量值
         double[] dVar = {22,33,30,42,38,49,42,55};//因变量值
         double[][] twoVarData = new double[][]{iVar,dVar};//二变量数据
         int fraDigits = 3;//结果保留几位小数数 
         double testiVar = 4.3;//测试自变量值
         String[] result = analyze(twoVarData,fraDigits);
         double estValue = 0;//估计值
         System.out.println("-------------输出结果---------------");
         System.out.println(" 斜率："+result[0]+" 切距："+result[1]);
         System.out.println(" 最佳拟合线："+result[2]);
         System.out.println(" 相关系数："+result[3]);
         estValue = calculateEstimatedValue(Double.valueOf(result[0]),Double.valueOf(result[1]),testiVar,fraDigits);
         System.out.println(" 测试自变量值："+testiVar);
         System.out.println(" 因变量估计值："+estValue);
         System.out.println("----------------------------------");
    }

}