Single.CompareTo Method (Object)
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
Compares this instance to a specified object and returns an integer that indicates whether the value of this instance is greater than, less than, or equal to the value of the specified object.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- value
- Type: System.Object
An object to compare, or Nothing.
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 Nothing. |
Implements
IComparable.CompareTo(Object)| Exception | Condition |
|---|---|
| ArgumentException | value is not a Single. |
Any instance of Single, regardless of its value, is considered greater than Nothing.
The value parameter must be Nothing or an instance of Single; otherwise, an exception is thrown.
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.
Precision in Comparisons
The precision of floating-point 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 outputBlock.Text &= A.ToString() + " is less than " + Obj1.ToString() + "." & vbCrLf End If If (A.CompareTo(Obj1) > 0) Then outputBlock.Text &= A.ToString() + " is greater than " + Obj1.ToString() + "." & vbCrLf End If If (A.CompareTo(Obj1) = 0) Then outputBlock.Text &= A.ToString() + " equals " + Obj1.ToString() + "." & vbCrLf End If