org.protempa.proposition.stats.RegressionLine Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of protempa-framework Show documentation
Protempa Framework is the core of Protempa.
There is a newer version: 5.2-Alpha-2
/*
 * #%L
 * Protempa Framework
 * %%
 * Copyright (C) 2012 - 2013 Emory University
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package org.protempa.proposition.stats;

import org.protempa.proposition.PrimitiveParameter;
import org.protempa.proposition.Segment;
import org.protempa.proposition.value.NumericalValue;

import org.arp.javautil.stat.Line;
import org.arp.javautil.stat.UpdatingCovarCalc;
import org.arp.javautil.stat.UpdatingVarCalc;

/**
 * A class for manipulating regression lines.
 * 
 * @author Andrew Post
 */
public class RegressionLine extends Line {

    private UpdatingVarCalc varCalcX = null;
    private UpdatingVarCalc varCalcY = null;
    private UpdatingCovarCalc covarCalc = null;

    public static class NullValueException extends Exception {

        /**
		 * 
		 */
		private static final long serialVersionUID = -4392403268217798814L;
		private PrimitiveParameter point;

        NullValueException(PrimitiveParameter point) {
            this.point = point;
        }

        public PrimitiveParameter getPoint() {
            return this.point;
        }
    }

    /**
     * Creates a new regression line of points. Calculation of the line occurs
     * within this constructor.
     * 
     * @param points
     *            an array of Point objects.
     * @throws NullValueException
     *             if one of the points has a null value.
     */
    public RegressionLine(Segment points)
            throws NullValueException {

        double sumY = 0;
        double sumX = 0;
        PrimitiveParameter curPoint = points.first();
        sumX = curPoint.getPosition();
        if (curPoint.getValue() == null) {
            throw new NullValueException(curPoint);
        }
        sumY = ((NumericalValue) curPoint.getValue()).doubleValue();
        varCalcX = new UpdatingVarCalc(sumX);
        varCalcY = new UpdatingVarCalc(sumY);
        covarCalc = new UpdatingCovarCalc(sumX, sumY);
        for (int i = 1, n = points.size(); i < n; i++) {
            curPoint = points.get(i);
            double x = curPoint.getPosition();
            sumX += x;
            if (curPoint.getValue() == null) {
                throw new NullValueException(curPoint);
            }
            double y = ((NumericalValue) curPoint.getValue()).doubleValue();
            sumY += y;
            varCalcX.addValue(x);
            varCalcY.addValue(y);
            covarCalc.addPoint(x, y);
        }

        setm(covarCalc.getSumSquaredDeviations()
                / varCalcX.getSumSquaredDeviations());
        setb((sumY - m * sumX) / points.size());
    }

    /**
     * Returns the r.m.s. error of this regression line.
     * 
     * @return the r.m.s. error of this regression line.
     */
    public double getRMSError() {
        double r = covarCalc.getSumSquaredDeviations()
                / Math.sqrt(varCalcX.getSumSquaredDeviations()
                * varCalcY.getSumSquaredDeviations());
        return Math.sqrt(1 - r) * varCalcX.getStdDev();
    }
}