net.degreedays.api.regression

Class BaseloadRegressionComponent

java.lang.Object

net.degreedays.api.regression.RegressionComponent

net.degreedays.api.regression.BaseloadRegressionComponent

All Implemented Interfaces:

java.io.Serializable

public final class BaseloadRegressionComponent
extends RegressionComponent

Contains details of the baseload component (non-weather-dependent energy usage) in a regression.

Since:

1.4

Instances of this 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	BaseloadRegressionComponent.Builder A builder class for creating immutable BaseloadRegressionComponent objects e.g. for testing purposes.

Method Summary

Modifier and Type	Method and Description
boolean	multiplyByNumberOfDays() Returns true if the baseload coefficient() is a per-day value that should be multiplied by the number of days covered by the period in question; or false if the coefficient is such that it will only work for periods of the same length used in the InputData.
java.lang.String	toString() Returns a non-null, non-empty string representation of this object for logging and debugging purposes.

Methods inherited from class net.degreedays.api.regression.RegressionComponent

coefficient, coefficientPValue, coefficientStandardError, equals, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

multiplyByNumberOfDays

public boolean multiplyByNumberOfDays()

Returns true if the baseload coefficient() is a per-day value that should be multiplied by the number of days covered by the period in question; or false if the coefficient is such that it will only work for periods of the same length used in the InputData.

For the baseload component this will always return true unless you ran regressions with DayNormalization.NONE.

The notes on day normalization for our online regression tool have example regression equations that should help make this clearer.

toString

public java.lang.String toString()

Returns a non-null, non-empty string representation of this object for logging and debugging purposes.

The exact details of the representation are unspecified and subject to change.

Overrides:

toString in class java.lang.Object