Index<T> Class

Represents a set of keys of a specific type.

Definition

Namespace: Numerics.NET.DataAnalysis
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.3

public abstract class Index<T> : IList<T>, 
	ICollection<T>, IEnumerable<T>, IEnumerable, IIndex, ICollection, 
	IEquatable<Index<T>>, ISerializable

Visual Basic

Public MustInherit Class Index(Of T)
	Implements IList(Of T), ICollection(Of T), 
	IEnumerable(Of T), IEnumerable, IIndex, ICollection, IEquatable(Of Index(Of T)), 
	ISerializable

C++/CLI

generic<typename T>
public ref class Index abstract : IList<T>, 
	ICollection<T>, IEnumerable<T>, IEnumerable, IIndex, ICollection, 
	IEquatable<Index<T>^>, ISerializable

[<AbstractClassAttribute>]
type Index<'T> = 
    class
        interface IList<'T>
        interface ICollection<'T>
        interface IEnumerable<'T>
        interface IEnumerable
        interface IIndex
        interface ICollection
        interface IEquatable<Index<'T>>
        interface ISerializable
    end

Inheritance: Object → Index<T>

Derived: Numerics.NET.DataAnalysis.IntervalIndex<T>

Implements: IIndex, ICollection<T>, IEnumerable<T>, IList<T>, ICollection, IEnumerable, IEquatable<Index<T>>, ISerializable

Type Parameters

T: The type of the keys.

Remarks

Use the Index<T> class to serve as the row and column index of a data frame, the category index of a CategoricalVector<T>, or to label the elements of a vector or the rows and columns of a matrix.

Constructors

Index<T>(Int32)	Constructs a new index of the specified length.
Index<T>(SerializationInfo, StreamingContext)	Constructs a new index from serialization values.

Properties

Depth	Gets the number of levels in the index.
IsSorted	Gets whether the values in the index are sorted.
IsUnique	Gets whether the values in the index are unique.
Item[IList<Int32>]	Gets the specified subset of the index.
Item[Int32]	Gets the element at the specified position in the index.
Item[Int32, Int32]	Gets the value of the index at the specified position and level.
KeepOrder	Gets or sets whether indexes derived from this index should maintain the sort order.
KeepUnique	Gets or sets whether indexes derived from this index should maintain the uniqueness of keys.
Length	Gets the length of the index.
Name	Gets or sets the name of the index.
SortOrder	Gets or sets how the values in the index are sorted.

Methods

Append(T)	Appends the specified value to the index and returns the result.
Append(Index<T>, Boolean)	Appends the specified index at the end of the current index and returns the result.
CheckOrder	Verifies whether the elements appear in increasing or decreasing order.
CheckUnique	Verifies whether the elements in an index are unique.
Contains	Returns whether the specified key is present in the index.
CopyTo	Copies the elements of the index to an array beginning at the specified index.
Equals(Index<T>)	Indicates whether the current index is equal to another index.
Equals(Object)	(Overrides Object.Equals(Object))
Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
GetEnumerator	Returns an enumerator that iterates through a collection.
GetHashCode	(Overrides Object.GetHashCode())
GetObjectData	Populates a SerializationInfo with the values needed to serialize the target object. Obsolete.
GetSlice(Slice)	Returns a slice of the current index.
GetSlice(T, T)	Returns a slice of the current sorted index.
GetSlice(Int32, Int32, Int32)	Returns a slice of the current index.
GetSubset	Returns a subset of the current index.
GetType	Gets the Type of the current instance. (Inherited from Object)
GetValue	Gets the value of the index at the specified position.
JoinNearest	Returns the index that results from joining each key in an index to the nearest key in this index.
Lookup(IEnumerable<T>)	Maps a sequence of keys to their position in the index.
Lookup(T)	Maps the specified key to its position in the index.
LookupNearest(IEnumerable<T>, Direction)	Maps a sequence of keys to the position of the nearest key in the index.
LookupNearest(T, Direction)	Finds the key nearest to the specified value in the index.
MakeJoinIndex	Converts the index to an index that can serve as a key in a join operation.
MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
Nest<U>	Returns a new index that adds a new level containing all the values in the specified index.
Permute	Permutes the elements of the index and returns the result.
Remove	Removes the element with the specified key in the index.
RemoveAt	Removes the element at the specified position in the index.
ToArray	Returns an array containing the keys in the index.
ToString	Returns a string that represents the current object. (Inherited from Object)
TryLookup	Tries to find the specified key in the index.
TryLookupNearest	Tries to find the key nearest to the specified value in the index.

Extension Methods

Group<T>	Returns a grouping by the unique elements in a list. (Defined by Grouping)
Group<T>	Returns a grouping by the unique elements in a sequence. (Defined by Grouping)
Group<T>	Returns a grouping by the unique elements in a list using the specified comparer to determine equality. (Defined by Grouping)
Group<T>	Returns a grouping by the unique elements in a sequence using the specified comparer to determine equality. (Defined by Grouping)
StandardDeviation<T>	Returns the standard deviation of the elements of a sequence. (Defined by Stats)
Sum<T>	Computes the sum of the sequence of values. (Defined by ArrayMath)
Sum<T, U>	Computes the sum of the sequence of values that are obtained by invoking a transform function on each element of the input sequence. (Defined by ArrayMath)
Sum<T, T2, U>	Computes the sum of the sequence of values that are obtained by invoking a transform function on each pair of elements of the input sequences. (Defined by ArrayMath)