Input |
Inheritance HierarchyNamespace: DegreeDays.Api.Regressions
Assembly: DegreeDays (in DegreeDays.dll) Version: 1.4
SyntaxThe InputData type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | InputData(IEnumerableInputPeriod) | Constructs an InputData object containing the specified InputPeriod objects. |
| InputData(InputPeriod) | Constructs an InputData object containing the specified InputPeriod objects. |
| InputData(InputPeriod, InputPeriod) | Constructs an InputData object containing the specified InputPeriod objects. |
Properties| Name | Description | |
|---|---|---|
 | ExtraPredictorKeys | Gets the non-null, possibly-empty, immutable set of extra-predictor keys that this InputData (and each InputPeriod within it) has extra-predictor figures for. |
| FullRange | Gets the DayRange indicating the total period of time covered by this InputData object (including any gaps between its input periods). |
| Periods | Gets the non-null, non-empty, chronologically-ordered list of the InputPeriod objects that make up this InputData. |
Methods| Name | Description | |
|---|---|---|
| Equals |
Returns true if obj is an InputData
object containing equal InputPeriod objects (same
dates, same usage values, and same extra-predictor keys and
figures).
(Overrides ObjectEquals(Object)) |
| GetHashCode |
Overridden to ensure consistency with Equals.
(Overrides ObjectGetHashCode) |
| ToString |
Returns a non-null, non-empty string representation of this instance for logging and debugging purposes.
(Overrides ObjectToString) |
RemarksAn InputData object is essentially a chronologically-ordered set of InputPeriod objects, with each one specifying a dated period and the energy usage (and optionally any extra-predictor figures) for that period.
The regression API docs on our website have more information and code samples.
Requirements of the InputPeriod objects that make up an InputData object
Input periods must be consecutively ordered, and cannot overlap. Gaps between input periods are OK though.
If any input periods have extra-predictor figures, then all input periods must have figures for the same extra-predictor keys.
The minimum number of input periods required is:
minimumNumberOfInputPeriods = 3 + numberOfExtraPredictors
Though this is just a bare minimum – you cannot hope for good regression results unless you have considerably more input periods than this. We recommend at least:
recommendedMinimumNumberOfInputPeriods = 10 + numberOfExtraPredictors
InputData allows a maximum of 1096 input periods. This is enough to cover 3 years of daily data (with one of those years being a leap year).
Thread SafetyVersion History| Version | Description |
|---|---|
| 1.4 | This was added in version 1.4. |
See Also