Geotools.Net

CoordinateCompare.Compare Method 

Compares two object and returns a value indicating whether one is less than, equal to or greater than the other.

[Visual Basic]
NotOverridable Public Function Compare( _
   ByVal x As Object, _
   ByVal y As Object _
) As Integer Implements _
   IComparer.Compare
[C#]
public int Compare(
   object x,
   object y
);

Parameters

x
First Coordinate object to compare.
y
Second Coordinate object to compare.

Return Value

<table cellspacing="0" class="dtTABLE"> <TR VALIGN="top"> <TH width=50%>Value</TH> <TH width=50%>Condition</TH> </TR> <TR VALIGN="top"> <TD width=50%>Less than zero</TD> <TD width=50%><I>a</I> is less than <I>b</I>.</TD> </TR> <TR VALIGN="top"> <TD width=50%>Zero</TD> <TD width=50%><I>a</I> equals <I>b</I>.</TD> </TR> <TR VALIGN="top"> <TD width=50%>Greater than zero</TD> <TD width=50%><I>a</I> is greater than <I>b</I>.</TD> </TR> </table>

Implements

IComparer.Compare

Remarks

If a implements IComparable, then a. CompareTo (b) is returned; otherwise, if b implements IComparable, then b. CompareTo (a) is returned. Comparing a null reference (Nothing in Visual Basic) with any type is allowed and does not generate an exception when using IComparable. When sorting, a null reference (Nothing) is considered to be less than any other object.

See Also

CoordinateCompare Class | CoordinateCompare Members | Geotools.Utilities Namespace