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»IntervalIndex(T) Class

IntervalIndexT Class

Extreme Optimization Numerical Libraries for .NET Professional
Represents an index over contiguous intervals.
Inheritance Hierarchy

SystemObject
  Extreme.DataAnalysisIndexIntervalT
    Extreme.DataAnalysisIntervalIndexT

Namespace:  Extreme.DataAnalysis
Assembly:  Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.1
Syntax

C#
VB
C++
F#
Copy
public class IntervalIndex<T> : Index<Interval<T>>
where T : Object, IComparable<T>
Public Class IntervalIndex(Of T As {Object, IComparable(Of T)})
	Inherits Index(Of Interval(Of T))
generic<typename T>
where T : Object, IComparable<T>
public ref class IntervalIndex : public Index<Interval<T>>
type IntervalIndex<'T when 'T : Object and IComparable<'T>> =  
    class
        inherit Index<Interval<'T>>
    end

Type Parameters

T
The value of the interval bounds.

The IntervalIndexT type exposes the following members.

Constructors

  NameDescription
Public methodIntervalIndexT(T)
Constructs a new IntervalIndexT using the specified boundaries.
Public methodIntervalIndexT(IListT, SpecialBins)
Constructs a new IntervalIndexT using the specified boundaries.
Protected methodIntervalIndexT(SerializationInfo, StreamingContext)
Constructs a new index from serialization values.
Public methodIntervalIndexT(T, T, Int32)
Constructs a new IntervalIndexT with equally spaced intervals over the specified range.
Public methodIntervalIndexT(T, T, Int32, SpecialBins)
Constructs a new IntervalIndexT with equally spaced intervals over the specified range.
Top
Properties

  NameDescription
Public propertyDepth
Gets the number of levels in the index.
(Inherited from IndexT.)
Public propertyIsSorted
Gets whether the values in the index are sorted.
(Inherited from IndexT.)
Public propertyIsUnique
Gets whether the values in the index are unique.
(Inherited from IndexT.)
Public propertyItemIListInt32
Gets the specified subset of the index.
(Overrides IndexTItemIListInt32.)
Public propertyItemInt32
Gets the element at the specified position in the index.
(Inherited from IndexT.)
Public propertyItemInt32, Int32
Gets the value of the index at the specified position and level.
(Inherited from IndexT.)
Public propertyKeepOrder
Gets or sets whether indexes derived from this index should maintain the sort order.
(Inherited from IndexT.)
Public propertyKeepUnique
Gets or sets whether indexes derived from this index should maintain the uniqueness of keys.
(Inherited from IndexT.)
Public propertyLength
Gets the number of intervals.
(Overrides IndexTLength.)
Public propertyName
Gets or sets the name of the index.
(Inherited from IndexT.)
Public propertySortOrder
Gets or sets how the values in the index are sorted.
(Inherited from IndexT.)
Top
Methods

  NameDescription
Public methodAppend(IntervalT)
Appends the specified value to the index and returns the result.
(Overrides IndexTAppend(T).)
Public methodAppend(IndexIntervalT, Boolean)
Appends the specified index at the end of the current index and returns the result.
(Overrides IndexTAppend(IndexT, Boolean).)
Protected methodCheckOrder
Verifies whether the elements appear in increasing or decreasing order.
(Inherited from IndexT.)
Protected methodCheckUnique
Verifies whether the elements in an index are unique.
(Inherited from IndexT.)
Public methodContains
Returns whether the specified key is present in the index.
(Inherited from IndexT.)
Public methodCopyTo
Copies the elements of the index to an array beginning at the specified index.
(Inherited from IndexT.)
Public methodEquals(IndexT)
Indicates whether the current index is equal to another index.
(Inherited from IndexT.)
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 methodGetBounds
Gets an array containing the bounds of the IntervalIndexT.
Public methodGetEnumerator
Returns an enumerator that iterates through a collection.
(Inherited from IndexT.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetLowerBound
Gets the lower bound of the interval with the specified index.
Public methodGetObjectData
Populates a SerializationInfo with the values needed to serialize the target object.
(Overrides IndexTGetObjectData(SerializationInfo, StreamingContext).)
Public methodGetSlice(Slice)
Returns a slice of the current index.
(Inherited from IndexT.)
Public methodGetSlice(T, T)
Returns a slice of the current sorted index.
(Inherited from IndexT.)
Public methodGetSlice(Int32, Int32, Int32)
Returns a slice of the current index.
(Inherited from IndexT.)
Public methodGetSubset
Returns a subset of the current index.
(Inherited from IndexT.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUpperBound
Gets the upper bound of the interval with the specified index.
Public methodGetValue
Gets the value of the index at the specified position.
(Overrides IndexTGetValue(Int32).)
Public methodJoinNearest
Returns the index that results from joining each key in an index to the nearest key in this index.
(Inherited from IndexT.)
Public methodLookup(IEnumerableT)
Maps a sequence of keys to their position in the index.
(Inherited from IndexT.)
Public methodLookup(IListT)
Gets the indexes of the intervals containing a set of values.
Public methodLookup(T)
Maps the specified key to its position in the index.
(Inherited from IndexT.)
Public methodLookup(T)
Gets the index of the interval containing a value.
Public methodLookupNearest(IEnumerableT, Direction)
Maps a sequence of keys to the position of the nearest key in the index.
(Inherited from IndexT.)
Public methodLookupNearest(T, Direction)
Finds the key nearest to the specified value in the index.
(Inherited from IndexT.)
Protected methodMakeJoinIndex
Converts the index to an index that can serve as a key in a join operation.
(Inherited from IndexT.)
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.
(Inherited from IndexT.)
Public methodPermute
Permutes the elements of the index and returns the result.
(Inherited from IndexT.)
Public methodRemove
Removes the element with the specified key in the index.
(Inherited from IndexT.)
Public methodRemoveAt
Removes the element at the specified position in the index.
(Overrides IndexTRemoveAt(Int32).)
Public methodToArray
Returns an array containing the keys in the index.
(Inherited from IndexT.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTryLookup
Tries to find the specified key in the index.
(Overrides IndexTTryLookup(T, Int32).)
Public methodTryLookupNearest
Tries to find the key nearest to the specified value in the index.
(Overrides IndexTTryLookupNearest(T, Direction, Int32).)
Top
Remarks

Use the IntervalIndexT class to represent an index over a sequence of contiguous intervals. This type is commonly used as the index for a histogram, where the intervals represent the bins in the histogram.

Interval indexes have additional methods to look up the interval a value belongs to.

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.