Click or drag to resize

ExtraPredictorSpec Class

Defines an extra predictor in terms of its PredictorType and ExpectedCorrelation, to help the API test and rank regressions that include data for that extra predictor.
Inheritance Hierarchy
SystemObject
  DegreeDays.Api.RegressionsExtraPredictorSpec

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

The ExtraPredictorSpec type exposes the following members.

Constructors
 NameDescription
Public methodExtraPredictorSpec Constructs an ExtraPredictorSpec with the specified PredictorType and ExpectedCorrelation.
Top
Properties
 NameDescription
Public propertyExpectedCorrelation Returns the ExpectedCorrelation that defines how the extra predictor is expected to correlate with energy usage.
Public propertyPredictorType Gets the PredictorType that defines how the extra predictor's figures vary with the length of the periods they are measured over.
Top
Methods
 NameDescription
Public methodEquals Returns true if obj is an ExtraPredictorSpec with the same PredictorType and ExpectedCorrelation as this.
(Overrides ObjectEquals(Object))
Public methodGetHashCode Overridden to ensure consistency with Equals.
(Overrides ObjectGetHashCode)
Public methodToString Returns a non-null, non-empty string representation of this instance for logging and debugging purposes.
(Overrides ObjectToString)
Top
Remarks

These are held by the RegressionTestPlan. There's some sample code in the regression API docs on our website, and also there's some additional practical information on specifying and using extra predictors in the docs for our website regression tool (which itself uses the API internally).

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