IndexCollection Class

public class IndexCollection : IList<int>, 
	ICollection<int>, IEnumerable<int>, IEnumerable, IReadOnlyList<int>, 
	IReadOnlyCollection<int>, IEquatable<IndexCollection>, IComparable<IndexCollection>, 
	IComparable

Public Class IndexCollection
	Implements IList(Of Integer), ICollection(Of Integer), 
	IEnumerable(Of Integer), IEnumerable, IReadOnlyList(Of Integer), 
	IReadOnlyCollection(Of Integer), IEquatable(Of IndexCollection), 
	IComparable(Of IndexCollection), IComparable

public ref class IndexCollection : IList<int>, 
	ICollection<int>, IEnumerable<int>, IEnumerable, IReadOnlyList<int>, 
	IReadOnlyCollection<int>, IEquatable<IndexCollection^>, IComparable<IndexCollection^>, 
	IComparable

type IndexCollection = 
    class
        interface IList<int>
        interface ICollection<int>
        interface IEnumerable<int>
        interface IEnumerable
        interface IReadOnlyList<int>
        interface IReadOnlyCollection<int>
        interface IEquatable<IndexCollection>
        interface IComparable<IndexCollection>
        interface IComparable
    end

Inheritance

Object    IndexCollection

Implements

ICollectionInt32, IEnumerableInt32, IListInt32, IReadOnlyCollectionInt32, IReadOnlyListInt32, IEnumerable, IComparable, IComparableIndexCollection, IEquatableIndexCollection

Instantiation

IndexCollection instances can be created using several methods. Indexes ranging in a given interval are returned by Range(Int32, Int32). A collection of evenly spaced indexes can be initialized by Sequence(Int32, Int32, Int32). A collection ranging from zero to a specified last index is instead returned by Default(Int32). A collection can also be defined to contain elements copied from a specified array by calling FromArray(Int32), or, eventually to prevent copying operations, by calling FromArray(Int32, Boolean).

Matrix Indexing

The DoubleMatrix class defines zero-based indexers to get or set individual matrix entries, or entire sub matrices. Usually, a given datum is accessed by specifying a pair of row and column indexes, but indexers are overloaded to accept also a linear index, i.e. an index to which an matrix element corresponds provided that matrix entries have been interpreted as well ordered following a column major ordering. All such indexers accept IndexCollection instances as arguments, enabling the simultaneous specification of multiple linear, row, or column indexes.

Comparison

IndexCollection instances are quasi-lexicographically ordered. This means that instances are firstly ordered by their Count, and then, within collections having the same length, by lexicographic order.

This also means that when tested for equality, IndexCollection instances are considered equal if and only if they have the same Count and, for each index position, indexes corresponding to such position are equal, too.

Reference

Other Resources