Single.CompareTo Method (Object)

July 28, 2014

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.

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)

public int CompareTo(
	Object value
)

Parameters

value
Type: System.Object
An object to compare, or null.

Return Value

Type: System.Int32
A 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)

ExceptionCondition
ArgumentException

value is not a Single.

Any instance of Single, regardless of its value, is considered greater than null.

The value parameter must be null 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 = (Single)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";
}


Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Show:
© 2014 Microsoft