Click or drag to resize

RegressionApi Class

Provides easy, type-safe access to the API's regression-related operations.
Inheritance Hierarchy
SystemObject
  DegreeDays.Api.RegressionsRegressionApi

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

The RegressionApi type exposes the following members.

Constructors
 NameDescription
Public methodRegressionApi Constructs a RegressionApi object that uses the specified IRequestProcessor internally.
Top
Methods
 NameDescription
Public methodRunRegressions Sends your RegressionRequest to the API servers so it can run regressions against your InputData and return a non-null RegressionResponse containing the regressions that were statistically best and/or any that you specifically requested.
Top
Remarks

Creating a RegressionApi object

Instead of creating a RegressionApi instance directly, you would typically create a DegreeDaysApi object and get a RegressionApi from that with the RegressionApi property. Although the only state of a RegressionApi object is the IRequestProcessor passed into its constructor, so, if you have an IRequestProcessor, there's no reason not to create a RegressionApi object directly if doing it that way makes sense for your app.

Example code for running regressions

Please see the C# and VB code samples in the regression API docs on our website.

Thread Safety
This class is designed to be safe for use from multiple concurrent threads. However, if you create a customized instance of this class (using an IRequestProcessor that you have written or customized), then the thread-safety of its operation will depend on the thread-safety of that IRequestProcessor.
Version History
VersionDescription
1.4 This was added in version 1.4.
See Also