IIndex Interface

This API is preliminary and subject to change.
Defines the properties and methods common to all indexes.

Definition

Namespace: Extreme.DataAnalysis
Assembly: Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.23
C# 
public interface IIndex : ICollection, IEnumerable
Implements
ICollection, IEnumerable

Properties

CountGets the number of elements contained in the ICollection.
(Inherited from ICollection)
Depth Gets the number of levels in the index.
IsSynchronizedGets a value indicating whether access to the ICollection is synchronized (thread safe).
(Inherited from ICollection)
Item[IEnumerable<Int32>] Gets a subset of the index.
Item[IList<Boolean>] Gets a subset of the index defined by a boolean mask.
Item[Int32] Gets the element at the specified position.
KeyType Gets the type of the keys.
Length Gets the number of items in the index.
Name Gets or sets the name of the index.
SyncRootGets an object that can be used to synchronize access to the ICollection.
(Inherited from ICollection)

Methods

CopyToCopies the elements of the ICollection to an Array, starting at a particular Array index.
(Inherited from ICollection)
GetEnumeratorReturns an enumerator that iterates through a collection.
(Inherited from IEnumerable)
GetSlice Returns a new index containing the specified slice of the current index.
JoinWith Returns the index that is the result of applying the specified join to this index and another index.
JoinWithNearest Returns the index that is the result of applying the specified join to this index and another index where lookups are to the nearest key in the specified direction.
Lookup Looks up the position of the specified key.
MakeVector Returns a categorical vector that uses the index as categories.
Permute Applies a permutation to the index and returns the result.
Sort Returns a permutation that can be used to sort the data in the vector in the specified order.

See Also