Click or drag to resize

Regression Class

Contains details of a regression model that the API calculated using the InputData you provided and, typically, HDD and/or CDD as well.
Inheritance Hierarchy
SystemObject
  DegreeDays.Api.RegressionsRegression

Namespace: DegreeDays.Api.Regressions
Assembly: DegreeDays (in DegreeDays.dll) Version: 1.4
Syntax
Copy
public sealed class Regression

The Regression type exposes the following members.

Properties
 NameDescription
Public propertyAdjustedRSquared Gets the adjusted-R-squared value for this Regression.
Public propertyBaseload Gets the non-null BaseloadRegressionComponent object representing the baseload component (b*days) of this Regression.
Public propertyCrossValidatedRSquared Gets the cross-validated-R-squared value for this Regression.
Public propertyCvrmse Gets the CVRMSE of this Regression.
Public propertyExtraPredictorKeys Gets the non-null, possibly-empty, immutable set of extra-predictor keys that this Regression has extra components for.
Public propertyHasCoolingDegreeDays Returns true if this Regression has a cooling-degree-days component (c*CDD); false otherwise.
Public propertyHasHeatingDegreeDays Returns true if this Regression has a heating-degree-days component (h*HDD); false otherwise.
Public propertyRSquared Gets the the R-squared value for this Regression.
Public propertySampleDays Gets the number of days covered by the sample of data used for this Regression, excluding any gaps between input periods.
Public propertySampleSize Gets the number of energy-usage figures used for this Regression.
Public propertySampleSpan Returns a DayRange representing the full period covered by the sample (including any gaps) that was used for this Regression.
Public propertySampleSpanDays Returns the number of days covered by the sample (including any gaps) that was used for this Regression.
Public propertySpec Gets the non-null RegressionSpec specifying the components that this Regression contains, such that an equivalent Regression can be requested in another API request.
Public propertyStandardError Gets the standard error of this Regression.
Public propertyTags Gets the non-null immutable set of RegressionTag items that describe how this Regression came to be included in the response from the API.
Top
Methods
 NameDescription
Public methodEquals Returns true if obj is a Regression object with identical values for everything apart from the Tags (which are not considered in the equality test).
(Overrides ObjectEquals(Object))
Public methodGetCoolingDegreeDays Returns the non-null DegreeDaysRegressionComponent object representing the cooling-degree-days component (c*CDD) of this Regression, or throws an InvalidOperationException if no such component exists (check HasCoolingDegreeDays before calling this).
Public methodGetExtraComponent Returns the non-null ExtraRegressionComponent object with the specified extraPredictorKey, or throws an InvalidOperationException if no such component exists in this Regression (check HasExtraComponent(String) before calling this).
Public methodGetHashCode Overridden to ensure consistency with Equals.
(Overrides ObjectGetHashCode)
Public methodGetHeatingDegreeDays Returns the non-null DegreeDaysRegressionComponent object representing the heating-degree-days component (h*HDD) of this Regression, or throws an InvalidOperationException if no such component exists (check HasHeatingDegreeDays before calling this).
Public methodHasExtraComponent Returns true if this Regression has an extra-predictor component with the specified extraPredictorKey; false otherwise.
Public methodHasTag Returns true if this Regression contains the specified RegressionTag; false otherwise.
Public methodToString Returns a non-null, non-empty string representation of this instance for logging and debugging purposes.
(Overrides ObjectToString)
Top
Thread Safety
Instances of this class are immutable. You can safely reuse them and call them from multiple threads at once.
Version History
VersionDescription
1.4 This was added in version 1.4.
See Also