UInt16.CompareTo() Method in C# with Examples

UInt16.CompareTo Method is used to compare the current instance to a specified object or another UInt16 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 UInt16 instance. There are 2 methods in the overload list of this method as follows:

• CompareTo(UInt16) Method
• CompareTo(Object) Method

UInt16.CompareTo(UInt16) Method

This method is used to compare the current instance to a specified 16-bit unsigned 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 16-bit unsigned integer.

Syntax:

public int CompareTo (ushort value);

Here, it takes an unsigned integer 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 UInt16.CompareTo(UInt16) Method

Example 1:

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

class GFG {

    // Main Method
    public static void Main()
    {

        // Declaring and initializing value1
        ushort value1 = 7;

        // Declaring and initializing value2
        ushort value2 = 98;

        // 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:

7 is less than 98

Example 2:

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

class GFG {

    // Main Method
    public static void Main()
    {
        // calling get() method
        get(54, 77);
        get(70, 95);
        get(10, 24);
        get(45, 45);
    }

    // defining get() method
    public static void get(ushort value1,
                           ushort 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:

54 is less than 77
70 is less than 95
10 is less than 24
45 is equal to 45

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

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

Example 1:

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

class GFG {

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

            // Declaring and initializing value1
            ushort value1 = 10;

            // Declaring and initializing value2
            object value2 = (ushort)56;

            // 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 UInt16");
            Console.Write("Exception Thrown: ");
            Console.Write("{0}", e.GetType(), e.Message);
        }
    }
}

Output:

10 is less than 56

Example 2: For ArgumentException

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

class GFG {

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

            // Declaring and initializing value1
            ushort value1 = 150;

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

            // 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 UInt16");
            Console.Write("Exception Thrown: ");
            Console.Write("{0}", e.GetType(), e.Message);
        }
    }
}

Output:

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

Reference:

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