IndexCollectionCompareTo Method (Object)

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

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

Syntax

C++

Copy

public int CompareTo(
	Object obj
)

Public Function CompareTo ( 
	obj As Object
) As Integer

public:
virtual int CompareTo(
	Object^ obj
) sealed

abstract CompareTo : 
        obj : Object -> int 
override CompareTo : 
        obj : Object -> int

Parameters

obj: Type: SystemObject
An object to compare with this instance.

Return Value

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

Value	Meaning
Less than zero	This instance precedes obj in the sort order.
Zero	This instance occurs in the same position in the sort order as obj.
Greater than zero	This instance follows obj in the sort order.

Implements

IComparableCompareTo(Object)

Exceptions

Exception	Condition
ArgumentException	obj is not the same type as this instance.

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