RegressionTestPlan Class

Defines how the API should test regressions against the InputData you provide it.

Inheritance Hierarchy

SystemObject
DegreeDays.Api.RegressionsRegressionTestPlan

Namespace: DegreeDays.Api.Regressions
Assembly: DegreeDays (in DegreeDays.dll) Version: 1.4

Syntax

public sealed class RegressionTestPlan

Public NotInheritable Class RegressionTestPlan

The RegressionTestPlan type exposes the following members.

Properties

	Name	Description
	DayNormalization	Gets the DayNormalization to be used in the regression process.
	ExtraPredictorKeys	Returns the non-null, possibly-empty set of extra-predictor keys that this RegressionTestPlan has ExtraPredictorSpec objects for.
	HasCustomTestCoolingBaseTemperatures	Returns true if a custom set of base temperatures is to be used for the CDD in the regressions tested by the API, or false if the API should choose the test cooling base temperatures automatically.
	HasCustomTestHeatingBaseTemperatures	Returns true if a custom set of base temperatures is to be used for the HDD in the regressions tested by the API, or false if the API should choose the test heating base temperatures automatically.
	RequestedRegressionSpecs	Returns a non-null possibly-empty set of specifications for regressions that the API is specifically instructed to test and return (on top of any others that it will test and potentially return anyway).
	TemperatureUnit	Gets the TemperatureUnit that specifies whether Celsius-based or Fahrenheit-based degree days should be used in regressions.

Methods

	Name	Description
	Equals	Returns true if obj is an RegressionTestPlan with the same configuration as this. (Overrides ObjectEquals(Object))
	GetCustomTestCoolingBaseTemperatures	Returns the custom set of base temperatures to be used for the CDD in regressions tested by the API, or throws an InvalidOperationException if no such base temperatures are specified (check HasCustomTestCoolingBaseTemperatures before calling this).
	GetCustomTestHeatingBaseTemperatures	Returns the custom set of base temperatures to be used for the HDD in regressions tested by the API, or throws an InvalidOperationException if no such base temperatures are specified (check HasCustomTestHeatingBaseTemperatures before calling this).
	GetExtraPredictorSpec	Returns the non-null ExtraPredictorSpec associated with the specified string extraPredictorKey.
	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)

Remarks

To create a RegressionTestPlan, use a RegressionTestPlanBuilder. In many cases this will simply be a case of e.g.:

RegressionTestPlan testPlan = new RegressionTestPlan.Builder(
        TemperatureUnit.Celsius).Build();

Dim testPlan As RegressionTestPlan = New RegressionTestPlan.Builder(
        TemperatureUnit.Celsius).Build()

but there are lots of more advanced options you can configure as well.

See www.degreedays.net/api/regression for more info and code samples. And check the docs for the RegressionTestPlanBuilder class for details on all the configuration options.

Thread Safety

Instances of this class are immutable. You can safely reuse them and call them from multiple threads at once.

Version History

Version	Description
1.4	This was added in version 1.4.