PredictorType Structure

Defines an extra predictor's figures as being cumulative (increasing with time and naturally larger over longer periods) or average (normalized such that the length of the period has no effect).

Inheritance Hierarchy

SystemObject
SystemValueType
DegreeDays.Api.RegressionsPredictorType

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

Syntax

Copy

public struct PredictorType : IEquatable<PredictorType>

Public Structure PredictorType
	Implements IEquatable(Of PredictorType)

The PredictorType type exposes the following members.

Methods

	Name	Description
	Equals(Object)	Returns true if obj is the same PredictorType as this; false otherwise. (Overrides ValueTypeEquals(Object))
	Equals(PredictorType)	Returns true if other represents the same predictor type; false otherwise.
	GetHashCode	Overridden to ensure consistency with Equals. (Overrides ValueTypeGetHashCode)
	GetValues	Returns an array of the available PredictorType values.
	ToString	Returns a non-null, non-empty string representation of this object in the format required to specify an PredictorType in the request XML ("Cumulative" or "Average"). (Overrides ValueTypeToString)

Top

Operators

	Name	Description
	Equality(PredictorType, PredictorType)	Determines whether two specified PredictorType instances are equal.
	Inequality(PredictorType, PredictorType)	Determines whether two specified PredictorType instances are not equal.

Top

Fields

	Name	Description
	Average	For an extra predictor that is normalized such that the length of the period has no effect e.g. an Average measure of occupancy could be the percentage of full occupancy. A building could be 50% occupied for a week, or a month, or a year – longer periods would not mean larger figures.
	Cumulative	For an extra predictor that increases with time and is naturally larger over longer periods e.g. a Cumulative measure of occupancy could be the total person-hours worked. If a typical day saw 110 person hours, a typical 5-day week might see 770 person hours (i.e. larger figures for longer periods).

Top

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.

Reference

DegreeDays.Api.Regressions Namespace