Represents a statistical variable that takes on date/time values.
Namespace: Extreme.Statistics
Assembly: Extreme.Numerics (Extreme.Numerics)
Syntax
| Visual Basic (Declaration) |
|---|
Public Class DateTimeVariable _ Inherits Variable _ Implements IList(Of DateTime), ICollection(Of DateTime), IEnumerable(Of DateTime), IEnumerable |
| C# |
|---|
public class DateTimeVariable : Variable, IList<DateTime>, ICollection<DateTime>, IEnumerable<DateTime>, IEnumerable |
| C++ |
|---|
public ref class DateTimeVariable : public Variable, IList<DateTime>, ICollection<DateTime>, IEnumerable<DateTime>, IEnumerable |
Methods
| Icon | Type | Description |
|---|---|---|
 | Add(DateTime) |
Adds an observation to the variable.
|
| Aggregate(Int32[]()) |
Aggregates the values in the variable using the variable's aggregator.
|
| Aggregate(Int32[](), Aggregator) |
Aggregates the values in the variable using the specified aggregator.
|
| Clear() |
Removes all observations from the variable.
|
| Clone() |
Returns a Variable containing a copy of the observations that match the current filter.
|
| Compare(Int32, Int32) |
Compares the observations at the specified position.
|
| Contains(DateTime) |
Determines whether the variable contains a specific observation.
|
| CopyTo(DateTime[]()) |
Copies the numerical data in this variable to the specified Double array.
|
| CopyTo(DateTime[](), Int32) |
Copies the numerical data in this variable to the specified Double array.
|
| CreateSubset(Int32, Int32) |
Returns a Variable containing a copy of the observations within the specified range.
|
| CreateSubset(Filter) |
Returns a Variable containing a copy of the observations that match the specified filter.
|
| CreateView(Filter) |
Returns a Variable containing the observations that match the specified filter.
|
| CreateView(Int32, Int32) |
Returns a Variable containing the observations within the specified range.
|
| Equals(Object) | |
 | Finalize() | |
| GetEnumerator() |
Returns an enumerator that can iterate through the observations of the variable.
|
| GetHashCode() | Serves as a hash function for a particular type. |
| GetType() | Gets the Type of the current instance. |
| GetValue(Int32) |
Gets the observation at the specified index.
|
| GetValueUnfiltered(Int32) |
Gets the value of the variable at the specified index.
|
| IndexOf(DateTime) |
Determines the index of a specific observation of the variable.
|
| Insert(Int32, Object) |
Inserts an observation to the variable at the specified index.
|
| Insert(Int32, DateTime) |
Inserts an observation to the variable at the specified index.
|
| IsMissing(Int32) |
Returns a value that indicates whether the observation at the specified index is missing.
|
| MemberwiseClone() | Creates a shallow copy of the current Object. |
| Remove(DateTime) |
Removes the first occurrence of a specific observation from the variable.
|
| RemoveAll(DateTime) |
Removes all occurrences of a specific observation from the variable.
|
| RemoveAt(Int32) |
Removes the observation at the specified index.
|
| ReplaceMissingValues(MissingValueAction) |
Replaces the missing observations with a suitable value.
|
| ReplaceMissingValues(MissingValueAction, DateTime) |
Replaces the missing observations with a suitable value.
|
| ResetCalculations() |
Performs actions necessary when the variable's data has changed.
|
| Reverse() |
Reverses the observations in the variable.
|
| SetValue(Object, Int32) |
Sets the observation at the specified index to the specified value.
|
| SetValueUnfiltered(Object, Int32) |
Sets the value of the variable at the specified index.
|
| Sort() |
Sorts the observations in the order specified by the SortOrder property.
|
| Sort(SortOrder) |
Sorts the observations in the order specified by the SortOrder property.
|
| ToArray() |
Returns all the observations of this variable in an array.
|
| ToCategoricalVariable() |
Converts the variable to a CategoricalVariable.
|
| ToCategoricalVariable(DateTimeScale) |
Converts the variable to a CategoricalVariable
using the specified DateTimeScale.
|
| ToString() |
Constructors
| Icon | Type | Description |
|---|---|---|
| DateTimeVariableNew(String) |
Constructs a new DateTimeVariable object.
|
| DateTimeVariableNew(DataColumn) |
Constructs a new DateTimeVariable object.
|
| DateTimeVariableNew(DataColumn, IFormatProvider) |
Constructs a new DateTimeVariable object.
|
| DateTimeVariableNew(DateTime[]()) |
Constructs a new Variable object.
|
| DateTimeVariableNew(String, DateTime[]()) |
Constructs a new Variable object.
|
| DateTimeVariableNew(String, DateTime, DateTime, DateTimeUnit, BoundaryIntervalBehavior, BoundaryIntervalBehavior, Int32, DateTimeUnit) |
Constructs a new DateTimeVariable containing values at equal intervals.
|
Properties
| Icon | Type | Description |
|---|---|---|
 | Aggregator |
Gets or sets the Aggregator for this NumericalVariable.
|
| Filter |
Gets or sets the Filter associated with the current variable.
|
| Filters |
Gets the DateTimeFilters object associated with this variable.
|
| IsSortable |
Gets a value that indicates whether the observations can be sorted.
|
| IsSorted |
Gets a value that indicates whether the observations have been sorted
in the order specified by the SortOrder property.
|
| Item(Int32) |
Gets the value of the variable corresponding to the specified index.
|
| Length |
Gets the number of observations of the Variable.
|
| Maximum |
Gets the maximum of a variable.
|
| Mean |
Gets the mean of a variable.
|
| Median |
Gets the median of a variable.
|
| Minimum |
Gets the minimum of a variable.
|
| MissingValue |
Gets or sets the value used to indicate a missing value.
|
| Name |
Gets or sets the name of this Variable.
|
| PopulationStandardDeviation |
Gets the standard deviation of the variable.
|
| Range |
Gets the range of a variable.
|
| RootMeanSquare |
Gets the root-mean-square of the variable.
|
| SortOrder |
Gets or sets the order in which observations should be sorted.
|
| StandardDeviation |
Gets the unbiased standard deviation of the variable.
|
| UnfilteredLength |
Returns the number of observations in the variable.
|
| VariableCollection |
Gets the VariableCollection that contains this variable.
|
Remarks
Use the DateTimeVariable class to represent variables
that have a date or time value.
DateTimeVariable objects can be created from arrays and and DataColumn objects.
The DateTimeVariable class class supports a fairly widerange of descriptive statistics. Measures of location include the Mean, the Median, and return values of type DateTime. Measures of scale include the StandardDeviation and the Range. These properties are of type TimeSpan. Some common statistics, like the variance, are not available because their scale is not well defined.
Inheritance Hierarchy
See Also
