Represents a mapping from DateTime values to a discrete scale of time periods.

Namespace: Extreme.Statistics
Assembly: Extreme.Numerics (Extreme.Numerics)

Syntax

Visual Basic (Declaration)
Public Class DateTimeScale _
	Inherits CategoricalScale
C#
public class DateTimeScale : CategoricalScale
C++
public ref class DateTimeScale : public CategoricalScale

Methods

IconTypeDescription
Equals(Object)
Determines whether the specified Object is equal to the current Object.
Finalize()
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
GetBounds()
Gets an array containing the bounds of the DateTimeScale.
GetCaption(Int32)
Gets a textual representation of the level at the specified index.
GetCaptions()
Gets an array containing the captions of the levels in this CategoricalScale.
GetComparer()
Gets an IComparer object that can be used to compare the levels of this CategoricalScale.
GetEnumerator()
Returns an IEnumerator object that can be used to iterate through the levels of the CategoricalScale.
GetHashCode()
Serves as a hash function for a particular type.
GetLevelIndex(Object)
Gets the index of the specified level in this CategoricalScale.
GetLevels()
Gets an array containing the levels of this CategoricalScale.
GetLowerBound(Int32)
Gets the lower bound of the interval with the specified index.
GetType()
Gets the Type of the current instance.
GetUpperBound(Int32)
Gets the upper bound of the interval with the specified index.
Map(Object)
Gets the index of the interval containing a value.
Map(Object, IFormatProvider)
Gets the index of the interval containing a value.
Map(Object[](), IFormatProvider)
Gets the indexes of the intervals containing the values in an array.
Map(DateTime[]())
Gets the indexes of the intervals containing a set of values.
Map(DateTime)
Gets the index of the interval containing a value.
Map(Object[]())
Returns an array of indexes corresponding to the
MemberwiseClone()
Creates a shallow copy of the current Object.
ToString()
Returns a String that represents the current Object.

Constructors

IconTypeDescription
DateTimeScaleNew(DateTime[](), SpecialBins)
Constructs a new DateTimeScale using the specified boundaries.
DateTimeScaleNew(DateTime[]())
Constructs a new DateTimeScale using the specified boundaries.
DateTimeScaleNew(DateTime, DateTime, DateTimeUnit)
Constructs a new DateTimeScale using bins of equal width.
DateTimeScaleNew(DateTime, DateTime, DateTimeUnit, SpecialBins, BoundaryIntervalBehavior, BoundaryIntervalBehavior)
Constructs a new DateTimeScale using bins of equal width.
DateTimeScaleNew(DateTime, DateTime, DateTimeUnit, SpecialBins, BoundaryIntervalBehavior, BoundaryIntervalBehavior, Int32, DateTimeUnit)
Constructs a new DateTimeScale using bins of equal width.
DateTimeScaleNew(DateTime, DateTime, DateTimeUnit, SpecialBins)
Constructs a new DateTimeScale using bins of equal width.

Properties

IconTypeDescription
Count
Gets the number of intervals in this DateTimeScale.
IsOrdered
Gets a value that indicates whether the categorical scale is ordered or unordered.
Item(Int32)
Gets the specified interval of a DateTimeScale.

In C#, this property is the indexer for the DateTimeScale class.

Remarks

Use the DateTimeScale class to represent a categorization of a range of numerical values. The categories are contiguous intervals on a range of real numbers that may be infinite.

There are two ways to supply the intervals. The first is to supply an array containing the boundaries of the intervals. Every value except the first and the last acts both as the upper bound of one interval and the lower bound of the next. The second way is to supply an interval and a DateTimeUnit value that specify the width or length in time of each interval. Time units can be hours, days, weeks, months, or years. In this case, the interval is divided into subintervals, each covering the specified length of time. This method takes into account that the number of days varies from month to month.

DateTimeScale inherits from CategoricalScale. The intervals of the DateTimeScale correspond to the levels of the CategoricalScale.

The Map(Object) method maps a DateTime value to an interval. Overloads are available that map many values in one operatioin

Using a DateTimeScale, a DateTimeVariable can be transformed into a CategoricalVariable.

Inheritance Hierarchy

System.Object
  Extreme.Statistics.CategoricalScale
    Extreme.Statistics.DateTimeScale

See Also