IndexCollectionCompareTo Method (IndexCollection)

Compares the current object with another object of the same type.

Namespace: Novacta.Analytics
Assembly: Novacta.Analytics (in Novacta.Analytics.dll) Version: 2.0.0

Syntax

public int CompareTo(
	IndexCollection other
)

Public Function CompareTo ( 
	other As IndexCollection
) As Integer

public:
virtual int CompareTo(
	IndexCollection^ other
) sealed

abstract CompareTo : 
        other : IndexCollection -> int 
override CompareTo : 
        other : IndexCollection -> int

Parameters

other: Type: Novacta.AnalyticsIndexCollection
An object to compare with this object.

Return Value

Type: Int32
A value that indicates the relative order of the objects being compared. The return value has the following meanings:

Value	Meaning
Less than zero	This object is less than the other parameter.
Zero	This object is equal to other.
Greater than zero	This object is greater than other.

Implements

IComparableTCompareTo(T)

Remarks

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

IndexCollection Class

CompareTo Overload

Novacta.Analytics Namespace

Other Resources