Double.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 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.
Value | Description |
|---|---|
A negative integer | 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 Double.NaN, PositiveInfinity, or NegativeInfinity |
A positive integer | 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 Double. |
Any instance of Double, regardless of its value, is considered greater than null.
The value parameter must be null or an instance of Double; 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 example illustrates the use of CompareTo in the context of Double.
obj1 = (Double)450; if (a.CompareTo(obj1) < 0) { outputBlock.Text += String.Format("{0} is less than {1}.", a.ToString(), obj1.ToString()) + "\n"; } if (a.CompareTo(obj1) > 0) { outputBlock.Text += String.Format("{0} is greater than {1}.", a.ToString(), obj1.ToString()) + "\n"; } if (a.CompareTo(obj1) == 0) { outputBlock.Text += String.Format("{0} equals {1}.", a.ToString(), obj1.ToString()) + "\n"; }