Export (0) Print
Expand All

BigInteger.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.

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

'Declaration
Public Function CompareTo ( _
	obj As Object _
) As Integer

Parameters

obj
Type: System.Object

The object to compare.

Return Value

Type: System.Int32
A signed integer that indicates the relationship of the current instance to the obj parameter, as shown in the following table.

Return value

Description

Less than zero

The current instance is less than obj.

Zero

The current instance equals obj.

Greater than zero

The current instance is greater than obj, or the obj parameter is Nothing.

Implements

IComparable.CompareTo(Object)

ExceptionCondition
ArgumentException

obj is not a BigInteger.

This overload of the CompareTo method implements the IComparable.CompareTo method. It is used by non-generic collection objects to order the items in the collection.

The obj parameter must be one of the following:

  • An object whose run-time type is BigInteger.

  • An Object variable whose value is Nothing. If the value of the obj parameter is Nothing, the method returns 1, which indicates that that the current instance is greater than obj.

The following example calls the CompareTo(Object) method to compare a BigInteger value with each element in an object array

Dim values() As Object = { BigInteger.Pow(Int64.MaxValue, 10), Nothing, 
                           12.534, Int64.MaxValue, BigInteger.One }
Dim number As BigInteger = UInt64.MaxValue

For Each value As Object In values
   Try
      Console.WriteLine("Comparing {0} with '{1}': {2}", number, value, 
                        number.CompareTo(value))
   Catch e As ArgumentException
      Console.WriteLine("Unable to compare the {0} value {1} with a BigInteger.",
                        value.GetType().Name, value)
   End Try                      
Next                                  
' The example displays the following output: 
'    Comparing 18446744073709551615 with '4.4555084156466750133735972424E+189': -1 
'    Comparing 18446744073709551615 with '': 1 
'    Unable to compare the Double value 12.534 with a BigInteger. 
'    Unable to compare the Int64 value 9223372036854775807 with a BigInteger. 
'    Comparing 18446744073709551615 with '1': 1

.NET Framework

Supported in: 4.5, 4

.NET Framework Client Profile

Supported in: 4

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft