Single.CompareTo Method (Object)
Compares this instance to a specified object and returns an integer that indicates whether the value of this instance is less than, equal to, or greater than the value of the specified object.
Assembly: mscorlib (in mscorlib.dll)
Parameters
 value

Type:
System.Object
An object to compare, or null.
Return Value
Type: System.Int32A signed number indicating the relative values of this instance and value.
Return Value  Description 

Less than zero  This instance is less than value. or This instance is not a number (NaN) and value is a number. 
Zero  This instance is equal to value. or This instance and value are both not a number (NaN), PositiveInfinity, or NegativeInfinity. 
Greater than zero  This instance is greater than value. or This instance is a number and value is not a number (NaN). or value is null. 
Implements
IComparable.CompareTo(Object)Exception  Condition 

ArgumentException  value is not a Single. 
The value parameter must be null or an instance of Single; otherwise, an exception is thrown. Any instance of Single, regardless of its value, is considered greater than null.
Values must be identical to be considered equal. Particularly when floatingpoint values depend on multiple mathematical operations, it is common for them to lose precision and for their values to be nearly identical except for their least significant digits. Because of this, the return value of the CompareTo method may seem surprising at times. For example, multiplication by a particular value followed by division by the same value should produce the original value, but in the following example, the computed value turns out to be greater than the original value. Showing all significant digits of the two values by using the "R" standard numeric format string indicates that the computed value differs from the original value in its least significant digits. For information about handling such comparisons, see the Remarks section of the Equals(Single) method.
Module Example Public Sub Main() Dim value1 As Single = 16.5457 Dim value2 As Object = value1 * CSng(3.8899982) / CSng(3.8899982) Console.WriteLine("Comparing {0} and {1}: {2}", value1, value2, value1.CompareTo(value2)) Console.WriteLine() Console.WriteLine("Comparing {0:R} and {1:R}: {2}", value1, value2, value1.CompareTo(value2)) End Sub End Module ' The example displays the following output: ' Comparing 16.5457 and 16.5457: 1 ' ' Comparing 16.5457 and 16.545702: 1
This method is implemented to support the IComparable interface. Note that, although a NaN is not considered to be equal to another NaN (even itself), the IComparable interface requires that A.CompareTo(A) return zero.
The precision of floatingpoint numbers beyond the documented precision is specific to the implementation and version of the .NET Framework. Consequently, a comparison of two particular numbers might change between versions of the .NET Framework because the precision of the numbers' internal representation might change.
The following code example demonstrates the CompareTo method.
Obj1 = CType(450, Single) If A.CompareTo(Obj1) < 0 Then Console.WriteLine(A.ToString() + " is less than " + Obj1.ToString() + ".") End If If (A.CompareTo(Obj1) > 0) Then Console.WriteLine(A.ToString() + " is greater than " + Obj1.ToString() + ".") End If If (A.CompareTo(Obj1) = 0) Then Console.WriteLine(A.ToString() + " equals " + Obj1.ToString() + ".") End If
Available since 1.1
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0