Regression |
For creating a RegressionTestPlan object that defines how the API
should test regressions against the InputData you provide it.
Inheritance HierarchyNamespace: DegreeDays.Api.Regressions
Assembly: DegreeDays (in DegreeDays.dll) Version: 1.4
SyntaxThe RegressionTestPlanBuilder type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | RegressionTestPlanBuilder | Constructs a RegressionTestPlan.Builder with the specified TemperatureUnit (to be used for degree days) and default values for everything else. |
Methods| Name | Description | |
|---|---|---|
| AddExtraPredictorSpec | Adds a specification for an extra predictor included in the InputData sent to the API, to help the API test and rank the regressions that include data for that extra predictor. |
| AddRequestedRegressionSpec | Adds a specification for a regression that you want to receive in the response from the API. |
| Build | Creates a RegressionTestPlan with the configuration currently held by this Builder. |
| SetCustomTestCoolingBaseTemperatures(Double) | Sets custom base temperatures to be used for the CDD in regressions tested by the API, assuming the temperature unit (Celsius or Fahrenheit) this Builder was constructed with. |
| SetCustomTestCoolingBaseTemperatures(IEnumerableTemperature) | Sets custom base temperatures to be used for the CDD in regressions tested by the API. |
| SetCustomTestCoolingBaseTemperatures(Temperature) | Sets custom base temperatures to be used for the CDD in regressions tested by the API. |
| SetCustomTestHeatingBaseTemperatures(Double) | Sets custom base temperatures to be used for the HDD in regressions tested by the API, assuming the temperature unit (Celsius or Fahrenheit) this Builder was constructed with. |
| SetCustomTestHeatingBaseTemperatures(IEnumerableTemperature) | Sets custom base temperatures to be used for the HDD in regressions tested by the API. |
| SetCustomTestHeatingBaseTemperatures(Temperature) | Sets custom base temperatures to be used for the HDD in regressions tested by the API. |
| SetDayNormalization | Sets the DayNormalization to be used in the regression process. |
| SetExtraPredictorSpecs | Sets the specifications for the extra predictors included in the InputData sent to the API, to help the API test and rank the regressions that include data for those extra predictors. |
| SetRequestedRegressionSpecs(IEnumerableRegressionSpec) | Sets specifications for up to 60 regressions that you want to receive in the response from the API. |
| SetRequestedRegressionSpecs(RegressionSpec) | Sets specifications for up to 60 regressions that you want to receive in the response from the API. |
Remarks
Read the docs here for details on everything you can configure, and
see www.degreedays.net/api/regression for more info
and code samples.
Thread Safety
Instances of this builder class are designed for single-threaded use only. It's fine to create and use instances in multiple concurrent threads, but, in the absence of external synchronization, the use of each individual builder instance should be restricted to one thread only.
Version History| Version | Description |
|---|---|
| 1.4 | This was added in version 1.4. |
See Also