Interval Index<T> Class
Represents an index over contiguous intervals.
Definition
Namespace: Numerics.NET.DataAnalysis
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.3
C#
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.3
public class IntervalIndex<T> : Index<Interval<T>>
where T : Object, IComparable<T>
Type Parameters
- T
- The value of the interval bounds.
Remarks
Use the IntervalIndex<T> 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.
Constructors
Interval | Constructs a new IntervalIndex<T> using the specified boundaries. |
Interval | Constructs a new IntervalIndex<T> using the specified boundaries. |
Interval | Constructs a new index from serialization values. |
Interval | Constructs a new IntervalIndex<T> with equally spaced intervals over the specified range. |
Interval | Constructs a new IntervalIndex<T> with equally spaced intervals over the specified range. |
Properties
Depth |
Gets the number of levels in the index.
(Inherited from Index<T>) |
IsSorted |
Gets whether the values in the index are sorted.
(Inherited from Index<T>) |
IsUnique |
Gets whether the values in the index are unique.
(Inherited from Index<T>) |
Item[IList<Int32>] |
Gets the specified subset of the index.
(Overrides Index<T>.Item[IList<Int32>]) |
Item[Int32] |
Gets the element at the specified position in the index.
(Inherited from Index<T>) |
Item[Int32, Int32] |
Gets the value of the index at the specified position
and level.
(Inherited from Index<T>) |
Keep |
Gets or sets whether indexes derived from this index should
maintain the sort order.
(Inherited from Index<T>) |
Keep |
Gets or sets whether indexes derived from this index should
maintain the uniqueness of keys.
(Inherited from Index<T>) |
Length |
Gets the number of intervals.
(Overrides Index<T>.Length) |
Name |
Gets or sets the name of the index.
(Inherited from Index<T>) |
Sort |
Gets or sets how the values in the index are sorted.
(Inherited from Index<T>) |
Methods
Append( |
Appends the specified value to the index and returns the result.
(Overrides Index<T>.Append(T)) |
Append( |
Appends the specified index at the end of the current index and returns the result.
(Overrides Index<T>.Append(Index<T>, Boolean)) |
Check |
Verifies whether the elements appear in increasing or decreasing order.
(Inherited from Index<T>) |
Check |
Verifies whether the elements in an index are unique.
(Inherited from Index<T>) |
Contains |
Returns whether the specified key is present in the index.
(Inherited from Index<T>) |
Copy |
Copies the elements of the index to an array beginning at the specified index.
(Inherited from Index<T>) |
Equals( |
Indicates whether the current index is equal to another index.
(Inherited from Index<T>) |
Equals( | (Inherited from Index<T>) |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
Get | Gets an array containing the bounds of the IntervalIndex<T>. |
Get |
Returns an enumerator that iterates through a collection.
(Inherited from Index<T>) |
Get | (Inherited from Index<T>) |
Get | Gets the lower bound of the interval with the specified index. |
Get |
Populates a SerializationInfo with the values
needed to serialize the target object.
(Overrides Index<T>.GetObjectData(SerializationInfo, StreamingContext)) Obsolete. |
Get |
Returns a slice of the current index.
(Inherited from Index<T>) |
Get |
Returns a slice of the current sorted index.
(Inherited from Index<T>) |
Get |
Returns a slice of the current index.
(Inherited from Index<T>) |
Get |
Returns a subset of the current index.
(Inherited from Index<T>) |
Get | Gets the Type of the current instance. (Inherited from Object) |
Get | Gets the upper bound of the interval with the specified index. |
Get |
Gets the value of the index at the specified position.
(Overrides Index<T>.GetValue(Int32)) |
Join |
Returns the index that results from joining each key in an index to
the nearest key in this index.
(Inherited from Index<T>) |
Lookup( |
Maps a sequence of keys to their position in the index.
(Inherited from Index<T>) |
Lookup( | Gets the indexes of the intervals containing a set of values. |
Lookup( |
Maps the specified key to its position in the index.
(Inherited from Index<T>) |
Lookup( | Gets the index of the interval containing a value. |
Lookup |
Maps a sequence of keys to the position of the nearest key in the index.
(Inherited from Index<T>) |
Lookup |
Finds the key nearest to the specified value in the index.
(Inherited from Index<T>) |
Make |
Converts the index to an index that can serve as a key
in a join operation.
(Inherited from Index<T>) |
Memberwise | 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.
(Inherited from Index<T>) |
Permute |
Permutes the elements of the index and returns the result.
(Inherited from Index<T>) |
Remove |
Removes the element with the specified key in the index.
(Inherited from Index<T>) |
Remove |
Removes the element at the specified position in the index.
(Overrides Index<T>.RemoveAt(Int32)) |
ToArray |
Returns an array containing the keys in the index.
(Inherited from Index<T>) |
ToString | Returns a string that represents the current object. (Inherited from Object) |
Try |
Tries to find the specified key in the index.
(Overrides Index<T>.TryLookup(T, Int32)) |
Try |
Tries to find the key nearest to the specified value in the index.
(Overrides Index<T>.TryLookupNearest(T, Direction, Int32)) |