Expected |
Defines how an extra predictor's figures are expected to correlate with
energy usage (whether larger predictor numbers lead to larger or
smaller energy usage).
Inheritance HierarchyNamespace: DegreeDays.Api.Regressions
Assembly: DegreeDays (in DegreeDays.dll) Version: 1.4
SyntaxThe ExpectedCorrelation type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | Equals(ExpectedCorrelation) | Returns true if other represents the same expected correlation; false otherwise. |
| Equals(Object) |
Returns true if obj is the same
ExpectedCorrelation as this; false otherwise.
(Overrides ValueTypeEquals(Object)) |
| GetHashCode |
Overridden to ensure consistency with Equals.
(Overrides ValueTypeGetHashCode) |
 | GetValues | Returns an array of the available ExpectedCorrelation values. |
| ToString |
Returns a non-null, non-empty string representation of this item in
the format required to specify an ExpectedCorrelation in the
request XML ("Positive", "Negative", or
"PositiveOrNegative").
(Overrides ValueTypeToString) |
Operators| Name | Description | |
|---|---|---|
 | Equality(ExpectedCorrelation, ExpectedCorrelation) | Determines whether two specified ExpectedCorrelation instances are equal. |
| Inequality(ExpectedCorrelation, ExpectedCorrelation) | Determines whether two specified ExpectedCorrelation instances are not equal. |
Fields| Name | Description | |
|---|---|---|
 | Negative | For an extra predictor expected to have a negative correlation with energy usage i.e. larger extra-predictor figures lead to smaller energy usage. |
| Positive | For an extra predictor expected to have a positive correlation with energy usage i.e. larger extra-predictor figures lead to larger energy usage. |
| PositiveOrNegative | For an extra predictor that could be expected to have either a positive or negative correlation with energy usage. |
Remarks
This helps the API rank the various regressions it
tests, as it will downrank the regressions with extra predictors that
correlate with energy usage in an unexpected way.
Thread Safety
Instances of this struct are immutable and safe for use from multiple threads at once. The only values that can exist are those declared here as static readonly fields.
Version History| Version | Description |
|---|---|
| 1.4 | This was added in version 1.4. |
See Also