net.degreedays.api.regression

Class RegressionComponent

java.lang.Object

net.degreedays.api.regression.RegressionComponent

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

BaseloadRegressionComponent, DegreeDaysRegressionComponent, ExtraRegressionComponent

public abstract class RegressionComponent
extends java.lang.Object
implements java.io.Serializable

Contains details of a regression component e.g. the baseload (b*days) or the heating (h*HDD) component in a regression like E = b*days + h*HDD

Since:

1.4

This abstract class is not designed to be extended by third-party code, which is why it does not have an accessible constructor.

All concrete subclasses of this abstract class are immutable. You can safely reuse them and call them from multiple threads at once.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegressionComponent.Builder<T extends RegressionComponent.Builder<T>> An abstract builder extended by the builders for the various concrete subtypes of RegressionComponent.

Method Summary

Modifier and Type	Method and Description
double	coefficient() Returns the coefficient of this regression component e.g. the b, h, or c (depending on the component in question) in a regression with an equation like E = b*days + h*HDD + c*CDD
double	coefficientPValue() Returns the p-value of the coefficient().
double	coefficientStandardError() Returns the standard error of the coefficient().
boolean	equals(java.lang.Object o) Two RegressionComponent instances are equal if they have the same class and the same configuration.
int	hashCode() Overridden to ensure consistency with equals.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

coefficient

public final double coefficient()

Returns the coefficient of this regression component e.g. the b, h, or c (depending on the component in question) in a regression with an equation like E = b*days + h*HDD + c*CDD

coefficientStandardError

public final double coefficientStandardError()

Returns the standard error of the coefficient(). This is a measure of the precision of the regression model's estimate of the coefficient value. It's a common statistic (not energy specific) that you can look up online.

coefficientPValue

public final double coefficientPValue()

Returns the p-value of the coefficient(). It can have values between 0 (best) and 1 (worst), and you can use it as an indication of whether there is likely to be a meaningful relationship between the component and energy consumption. People often look for p-values of 0.05 or less, but really it is a sliding scale. p-value is a common statistic (not energy specific) that you can look up online.

Note that, for a BaseloadRegressionComponent the p-value is usually high if the coefficient is small, so it's often not as useful as the other p-values when assessing the quality of a regression.

equals

public final boolean equals(java.lang.Object o)

Two RegressionComponent instances are equal if they have the same class and the same configuration.

Overrides:

equals in class java.lang.Object

hashCode

public final int hashCode()

Overridden to ensure consistency with equals.

Overrides:

hashCode in class java.lang.Object