UInt64.CompareTo() Method in C# with Examples

UInt64.CompareTo Method is used to compare the current instance to a specified object or another UInt64 instance. It returns an integer which shows whether the value of the current instance is less than, equal to, or greater than the value of the specified object or the other UInt64 instance. There are 2 methods in the overload list of this method as follows:

• CompareTo(UInt64) Method
• CompareTo(Object) Method

UInt64.CompareTo(UInt64) Method

This method is used to compare the current instance to a specified 64-bit unsigned long integer and returns an integer which shows whether the value of the current instance is less than, equal to, or greater than the value of the specified 64-bit unsigned long integer.

Syntax:

public int CompareTo (ulong value);

Here, it takes an unsigned long value to compare.

Return Value: It returns a 32-bit signed number indicating the relative values of current instance and value parameter as follows:

• Less than Zero: if Current Instance < value
• Zero: if Current Instance = value
• Greater than Zero: if Current Instance > value

Below programs illustrate the use of UInt64.CompareTo(UInt64) Method:

Example 1:

// C# program to demonstrate the
// UInt64.CompareTo(UInt64) Method
using System;

class GFG {

    // Main Method
    public static void Main()
    {

        // Declaring and initializing value1
        ulong value1 = 312312131231;

        // Declaring and initializing value2
        ulong value2 = 523564123;

        // using CompareTo() method
        int status = value1.CompareTo(value2);

        // checking the status
        if (status > 0)
            Console.WriteLine("{0} is greater than {1}",
                                        value1, value2);
        else if (status < 0)
            Console.WriteLine("{0} is less than {1}",
                                     value1, value2);
        else
            Console.WriteLine("{0} is equal to {1}",
                                    value1, value2);
    }
}

Output:

312312131231 is greater than 523564123

Example 2:

// C# program to demonstrate the
// UInt64.CompareTo(UInt64) Method
using System;

class GFG {

    // Main Method
    public static void Main()
    {
        // calling get() method
        get(34432425, 708343);
        get(3780, 8920);
        get(8543453910, 85345340920);
        get(7006789, 7006789);
    }

    // defining get() method
    public static void get(ulong value1,
                           ulong value2)
    {

        // using CompareTo() method
        int status = value1.CompareTo(value2);

        // checking the status
        if (status > 0)
            Console.WriteLine("{0} is greater than {1}",
                                        value1, value2);
        else if (status < 0)
            Console.WriteLine("{0} is less than {1}",
                                     value1, value2);
        else
            Console.WriteLine("{0} is equal to {1}",
                                    value1, value2);
    }
}

Output:

34432425 is greater than 708343
3780 is less than 8920
8543453910 is less than 85345340920
7006789 is equal to 7006789

UInt64.CompareTo(Object) Method

This method is used to compare the current instance to a specified object and returns an integer which indicates whether the value of the current instance is less than, equal to, or greater than the value of the object.

Syntax:

public int CompareTo (object value);

Here, it takes the object to compare with this instance, or null.

Return Value: It returns a 32-bit signed number indicating the relative values of current instance and value parameter as follows:

• Less than Zero: if Current Instance < value
• Zero: if Current Instance = value
• Greater than Zero: if Current Instance > value

Exception: It throws ArgumentException if value is not a UInt64.

Below programs illustrate the use of UInt64.CompareTo(Object) Method

Example 1:

// C# program to demonstrate the
// UInt64.CompareTo(Object) Method
using System;

class GFG {

    // Main Method
    public static void Main()
    {
        try {

            // Declaring and initializing value1
            ulong value1 = 2324313420;

            // Declaring and initializing value2
            object value2 = (ulong)687.876;

            // using CompareTo() method
            int status = value1.CompareTo(value2);

            // checking the status
            if (status > 0)
                Console.WriteLine("{0} is greater than {1}",
                                           value1, value2);

            else if (status < 0)
                Console.WriteLine("{0} is less than {1}",
                                         value1, value2);
            else
                Console.WriteLine("{0} is equal to {1}",
                                        value1, value2);
        }

        catch (ArgumentException e)
        {
            Console.WriteLine("value2 must be null"+
                       " or an instance of UInt32");
            Console.Write("Exception Thrown: ");
            Console.Write("{0}", e.GetType(), e.Message);
        }
    }
}

Output:

2324313420 is greater than 687

Example 2: For ArgumentException

// C# program to demonstrate the
// UInt64.CompareTo(Object) Method
using System;
using System.Globalization;

class GFG {

    // Main Method
    public static void Main()
    {
        try {

            // Declaring and initializing value1
            ulong value1 = 104646549854;

            // Declaring and initializing value2
            object value2 = 1 / 6;

            // using CompareTo() method
            int status = value1.CompareTo(value2);

            // checking the status
            if (status > 0)
                Console.WriteLine("{0} is greater than {1}",
                                            value1, value2);

            else if (status < 0)
                Console.WriteLine("{0} is less than {1}",
                                         value1, value2);
            else
                Console.WriteLine("{0} is equal to {1}",
                                        value1, value2);
        }

        catch (ArgumentException e)
        {
            Console.WriteLine("value2 must be null"+
                       " or an instance of UInt64");
            Console.Write("Exception Thrown: ");
            Console.Write("{0}", e.GetType(), e.Message);
        }
    }
}

Output:

value2 must be null or an instance of UInt64
Exception Thrown: System.ArgumentException

Reference:

• https://docs.microsoft.com/en-us/dotnet/api/system.uint64.compareto?view=netstandard-2.1