net.degreedays.api.regression

Class ExtraRegressionComponent

java.lang.Object

net.degreedays.api.regression.RegressionComponent

net.degreedays.api.regression.ExtraRegressionComponent

All Implemented Interfaces:

java.io.Serializable

public final class ExtraRegressionComponent
extends RegressionComponent

Contains details of an extra-predictor component 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	ExtraRegressionComponent.Builder A builder class for creating immutable ExtraRegressionComponent objects e.g. for testing purposes.

Method Summary

Modifier and Type	Method and Description
boolean	multiplyByNumberOfDays() Returns true if the coefficient() is a per-day value that should be multiplied by the number of days covered by the period in question; false otherwise.
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 coefficient() is a per-day value that should be multiplied by the number of days covered by the period in question; false otherwise.

This will return true for extra predictors with PredictorType.AVERAGE, and false for extra predictors with PredictorType.CUMULATIVE.

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