Represents a variable containing row keys.
Namespace: Extreme.Statistics
Assembly: Extreme.Numerics (Extreme.Numerics)
Syntax
| Visual Basic (Declaration) |
|---|
Public Class KeyVariable(Of T) _ Inherits Variable _ Implements IList(Of T), ICollection(Of T), IEnumerable(Of T), IEnumerable |
| C# |
|---|
public class KeyVariable<T> : Variable, IList<T>, ICollection<T>, IEnumerable<T>, IEnumerable |
| C++ |
|---|
generic<typename T> public ref class KeyVariable : public Variable, IList<T>, ICollection<T>, IEnumerable<T>, IEnumerable |
Methods
| Icon | Type | Description |
|---|---|---|
 | Add(T) |
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(T) |
Determines whether the variable contains a specific observation.
|
| CopyTo(T[](), Int32) |
Copies the observations of this variable
to an array starting at the specified position.
|
| 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 keys in the collection.
|
| 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(T) |
Determines the index of a specific observation of the variable.
|
| Insert(Int32, Object) |
Inserts an observation to the variable at the specified index.
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(T) |
Removes the first occurrence of a specific observation from the variable.
|
| RemoveAll(T) |
Removes all occurrences of a specific observation from the variable.
|
| RemoveAt(Int32) |
Removes the observation at the specified index.
|
| 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) |
Gets 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.
|
| ToString() |
Constructors
| Icon | Type | Description |
|---|---|---|
| KeyVariable<(Of T>)New(ICollection<(Of T>)) |
Constructs a new KeyVariable object.
|
| KeyVariable<(Of T>)New(String, ICollection<(Of T>)) |
Constructs a new KeyVariable object.
|
| KeyVariable<(Of T>)New(String, DataColumn) |
Constructs a new CategoricalVariable.
|
| KeyVariable<(Of T>)New(DataColumn) |
Constructs a new CategoricalVariable.
|
Properties
| Icon | Type | Description |
|---|---|---|
 | Aggregator |
Gets or sets the Aggregator for this NumericalVariable.
|
| Filter |
Gets or sets the Filter associated with the current 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 or sets the value of the variable corresponding to the specified index.
|
| Length |
Gets the number of observations of the Variable.
|
| MissingValue |
Gets or sets the value used to indicate a missing value.
|
| Name |
Gets or sets the name of this Variable.
|
| SortOrder |
Gets or sets the order in which observations should be sorted.
|
| UnfilteredLength |
Returns the number of observations in the variable.
|
| VariableCollection |
Gets the VariableCollection that contains this variable.
|
Remarks
Use the KeyVariable<(Of T>) class to represent a variable that uniquely identifies
each row or case in a VariableCollection.
Inheritance Hierarchy
