Extreme Optimization™: Complexity made simple.

Math and Statistics
Libraries for .NET
  • Home
  • Features
    • Math Library
    • Vector and Matrix Library
    • Statistics Library
    • Performance
    • Usability
  • Documentation
    • Introduction
    • Math Library User's Guide
    • Vector and Matrix Library User's Guide
    • Data Analysis Library User's Guide
    • Statistics Library User's Guide
    • Reference
  • Resources
    • Downloads
    • QuickStart Samples
    • Sample Applications
    • Frequently Asked Questions
    • Technical Support
  • Order
  • Company
    • About us
    • Testimonials
    • Customers
    • Press Releases
    • Careers
    • Partners
    • Contact us
Introduction
Deployment Guide
Nuget packages
Configuration
Using Parallelism
Expand Mathematics Library User's GuideMathematics Library User's Guide
Expand Vector and Matrix Library User's GuideVector and Matrix Library User's Guide
Expand Data Analysis Library User's GuideData Analysis Library User's Guide
Expand Statistics Library User's GuideStatistics Library User's Guide
Expand Data Access Library User's GuideData Access Library User's Guide
Expand ReferenceReference

Skip Navigation LinksHome»Documentation»Reference»Extreme.DataAnalysis»Index(T) Class

IndexT Class

Extreme Optimization Numerical Libraries for .NET Professional
Represents a set of keys of a specific type.
Inheritance Hierarchy
SystemObject
  Extreme.DataAnalysisIndexT
    Extreme.DataAnalysisIntervalIndexT

Namespace:  Extreme.DataAnalysis
Assembly:  Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.1
Syntax
C#
VB
C++
F#
Copy
public abstract class Index<T> : IList<T>, 
	ICollection<T>, IEnumerable<T>, IEnumerable, IIndex, ICollection, 
	IEquatable<Index<T>>, ISerializable

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
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

Type Parameters

T
The type of the keys.

The IndexT type exposes the following members.

Constructors
  NameDescription
Protected methodIndexT(Int32)
Constructs a new index of the specified length.
Protected methodIndexT(SerializationInfo, StreamingContext)
Constructs a new index from serialization values.
Top
Properties
  NameDescription
Public propertyDepth
Gets the number of levels in the index.
Public propertyIsSorted
Gets whether the values in the index are sorted.
Public propertyIsUnique
Gets whether the values in the index are unique.
Public propertyItemIListInt32
Gets the specified subset of the index.
Public propertyItemInt32
Gets the element at the specified position in the index.
Public propertyItemInt32, Int32
Gets the value of the index at the specified position and level.
Public propertyKeepOrder
Gets or sets whether indexes derived from this index should maintain the sort order.
Public propertyKeepUnique
Gets or sets whether indexes derived from this index should maintain the uniqueness of keys.
Public propertyLength
Gets the length of the index.
Public propertyName
Gets or sets the name of the index.
Public propertySortOrder
Gets or sets how the values in the index are sorted.
Top
Methods
  NameDescription
Public methodAppend(T)
Appends the specified value to the index and returns the result.
Public methodAppend(IndexT, Boolean)
Appends the specified index at the end of the current index and returns the result.
Protected methodCheckOrder
Verifies whether the elements appear in increasing or decreasing order.
Protected methodCheckUnique
Verifies whether the elements in an index are unique.
Public methodContains
Returns whether the specified key is present in the index.
Public methodCopyTo
Copies the elements of the index to an array beginning at the specified index.
Public methodEquals(IndexT)
Indicates whether the current index is equal to another index.
Public methodEquals(Object)
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetEnumerator
Returns an enumerator that iterates through a collection.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetObjectData
Populates a SerializationInfo with the values needed to serialize the target object.
Public methodGetSlice(Slice)
Returns a slice of the current index.
Public methodGetSlice(T, T)
Returns a slice of the current sorted index.
Public methodGetSlice(Int32, Int32, Int32)
Returns a slice of the current index.
Public methodGetSubset
Returns a subset of the current index.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValue
Gets the value of the index at the specified position.
Public methodJoinNearest
Returns the index that results from joining each key in an index to the nearest key in this index.
Public methodLookup(IEnumerableT)
Maps a sequence of keys to their position in the index.
Public methodLookup(T)
Maps the specified key to its position in the index.
Public methodLookupNearest(IEnumerableT, Direction)
Maps a sequence of keys to the position of the nearest key in the index.
Public methodLookupNearest(T, Direction)
Finds the key nearest to the specified value in the index.
Protected methodMakeJoinIndex
Converts the index to an index that can serve as a key in a join operation.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodNestU
Returns a new index that adds a new level containing all the values in the specified index.
Public methodPermute
Permutes the elements of the index and returns the result.
Public methodRemove
Removes the element with the specified key in the index.
Public methodRemoveAt
Removes the element at the specified position in the index.
Public methodToArray
Returns an array containing the keys in the index.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTryLookup
Tries to find the specified key in the index.
Public methodTryLookupNearest
Tries to find the key nearest to the specified value in the index.
Top
Extension Methods
  NameDescription
Public Extension MethodGroupTOverloaded.
Returns a grouping by the unique elements in a list.
(Defined by Grouping.)
Public Extension MethodGroupTOverloaded.
Returns a grouping by the unique elements in a sequence.
(Defined by Grouping.)
Public Extension MethodGroupT(IEqualityComparerT)Overloaded.
Returns a grouping by the unique elements in a list using the specified comparer to determine equality.
(Defined by Grouping.)
Public Extension MethodGroupT(IEqualityComparerT)Overloaded.
Returns a grouping by the unique elements in a sequence using the specified comparer to determine equality.
(Defined by Grouping.)
Public Extension MethodSumTOverloaded.
Computes the sum of the sequence of values.
(Defined by ArrayMath.)
Public Extension MethodSumT, U(FuncT, U)Overloaded.
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.)
Top
Remarks

Use the IndexT class to serve as the row and column index of a data frame, the category index of a CategoricalVectorT, or to label the elements of a vector or the rows and columns of a matrix.

See Also

Reference

Extreme.DataAnalysis Namespace

Copyright (c) 2004-2023 ExoAnalytics Inc.

Send comments on this topic to support@extremeoptimization.com

Copyright © 2004-2023, Extreme Optimization. All rights reserved.
Extreme Optimization, Complexity made simple, M#, and M Sharp are trademarks of ExoAnalytics Inc.
Microsoft, Visual C#, Visual Basic, Visual Studio, Visual Studio.NET, and the Optimized for Visual Studio logo
are registered trademarks of Microsoft Corporation.