BigInteger.CompareTo Method (Object)

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Compares a big integer to a value.

Namespace:  Microsoft.SolverFoundation.Common
Assembly:  Microsoft.Solver.Foundation (in Microsoft.Solver.Foundation.dll)

Syntax

'Declaration
Public Function CompareTo ( _
    obj As Object _
) As Integer
public int CompareTo(
    Object obj
)
public:
virtual int CompareTo(
    Object^ obj
) sealed
abstract CompareTo : 
        obj:Object -> int 
override CompareTo : 
        obj:Object -> int 
public final function CompareTo(
    obj : Object
) : int

Parameters

  • obj
    Type: System.Object
    An object that is compared to a big integer.

Return Value

Type: System.Int32
A signed integer that indicates how the big integer compares to an object.

Return value

Description

Less than zero

The big integer is less than an object.

Zero

The big integer is equal to an object.

Greater than zero

The big integer is greater than an object.

Implements

IComparable.CompareTo(Object)

Remarks

The object must be a Int32, UInt32, Int64, UInt64, or Double. Otherwise, the object is not a number and cannot be compared to a big integer.

.NET Framework Security

See Also

Reference

BigInteger Structure

CompareTo Overload

Microsoft.SolverFoundation.Common Namespace