IComparable<T>.CompareTo(T) 方法

IComparable<T>.CompareTo(T) 方法

定义

命名空间:

System

程序集:

System.Runtime.dll, mscorlib.dll, netstandard.dll

将当前实例与同一类型的另一个对象进行比较，并返回一个整数，该整数指示当前实例在排序顺序中的位置是位于另一个对象之前、之后还是与其位置相同。

C#复制

 

public int CompareTo (T other);

参数

other

T

与此实例进行比较的对象。

返回

Int32

一个值，指示要比较的对象的相对顺序。 返回值的含义如下：

值	含义
小于零	此实例在排序顺序中位于 other 之前。
零	此实例在排序顺序中的位置与 other 相同。
大于零	此实例在排序顺序中位于 other 之后。

示例

下面的代码示例演示了一个简单IComparable<T> Temperature对象的实现。 该示例创建一个SortedList<TKey,TValue>具有Temperature对象键的字符串集合，并将多对的温度和字符串按顺序添加到列表中。 在对Add方法的调用中SortedList<TKey,TValue> ，集合使用IComparable<T>实现对列表条目进行排序，然后按温度的增加顺序显示这些条目。

C#复制

 

using System;
using System.Collections.Generic;

public class Temperature : IComparable<Temperature>
{
    // Implement the generic CompareTo method with the Temperature
    // class as the Type parameter.
    //
    public int CompareTo(Temperature other)
    {
        // If other is not a valid object reference, this instance is greater.
        if (other == null) return 1;

        // The temperature comparison depends on the comparison of
        // the underlying Double values.
        return m_value.CompareTo(other.m_value);
    }

    // Define the is greater than operator.
    public static bool operator >  (Temperature operand1, Temperature operand2)
    {
       return operand1.CompareTo(operand2) == 1;
    }

    // Define the is less than operator.
    public static bool operator <  (Temperature operand1, Temperature operand2)
    {
       return operand1.CompareTo(operand2) == -1;
    }

    // Define the is greater than or equal to operator.
    public static bool operator >=  (Temperature operand1, Temperature operand2)
    {
       return operand1.CompareTo(operand2) >= 0;
    }

    // Define the is less than or equal to operator.
    public static bool operator <=  (Temperature operand1, Temperature operand2)
    {
       return operand1.CompareTo(operand2) <= 0;
    }

    // The underlying temperature value.
    protected double m_value = 0.0;

    public double Celsius
    {
        get
        {
            return m_value - 273.15;
        }
    }

    public double Kelvin
    {
        get
        {
            return m_value;
        }
        set
        {
            if (value < 0.0)
            {
                throw new ArgumentException("Temperature cannot be less than absolute zero.");
            }
            else
            {
                m_value = value;
            }
        }
    }

    public Temperature(double kelvins)
    {
        this.Kelvin = kelvins;
    }
}

public class Example
{
    public static void Main()
    {
        SortedList<Temperature, string> temps =
            new SortedList<Temperature, string>();

        // Add entries to the sorted list, out of order.
        temps.Add(new Temperature(2017.15), "Boiling point of Lead");
        temps.Add(new Temperature(0), "Absolute zero");
        temps.Add(new Temperature(273.15), "Freezing point of water");
        temps.Add(new Temperature(5100.15), "Boiling point of Carbon");
        temps.Add(new Temperature(373.15), "Boiling point of water");
        temps.Add(new Temperature(600.65), "Melting point of Lead");

        foreach( KeyValuePair<Temperature, string> kvp in temps )
        {
            Console.WriteLine("{0} is {1} degrees Celsius.", kvp.Value, kvp.Key.Celsius);
        }
    }
}
/* This example displays the following output:
      Absolute zero is -273.15 degrees Celsius.
      Freezing point of water is 0 degrees Celsius.
      Boiling point of water is 100 degrees Celsius.
      Melting point of Lead is 327.5 degrees Celsius.
      Boiling point of Lead is 1744 degrees Celsius.
      Boiling point of Carbon is 4827 degrees Celsius.
*/

注解

CompareTo提供强类型的比较方法以对泛型集合对象的成员进行排序。 因此，通常不会直接从开发人员代码中调用它。 相反，它由List<T>.Sort()和Add等方法自动调用。

此方法只是定义，必须由特定的类或值类型实现才能使其生效。 "返回值" 部分中指定的比较（"先于"、"与" 的位置相同）的含义取决于特定实现。

按照定义，任何对象比较大于null，两个 null 引用的比较结果相等。

实施者说明

对于对象 A、B 和 C，必须满足以下条件： 需要CompareTo （A）以返回零。

如果CompareTo （B）返回零，则需要CompareTo （A）以返回零。

如果CompareTo （B）返回零， CompareTo （c）返回零，则需要CompareTo （c）以返回零。

如果CompareTo （B）返回的值不是零，则需要CompareTo （A）来返回相反的符号值。

如果CompareTo （B）返回一个不等于零x的值，而CompareTo （c）返回与相同的符号y x值，则需要CompareTo （c）来返回与相同的符号的值x和。y

调用方说明

CompareTo(T)使用方法来确定类的实例的排序。

适用于

.NET Core

3.1 3.0 2.2 2.1 2.0 1.1 1.0

.NET Framework

4.8 4.7.2 4.7.1 4.7 4.6.2 4.6.1 4.6 4.5.2 4.5.1 4.5 4.0 3.5 3.0 2.0

.NET Standard

2.1 2.0 1.6 1.5 1.4 1.3 1.2 1.1 1.0

UWP

10.0

Xamarin.Android

7.1

Xamarin.iOS

10.8

Xamarin.Mac

3.0

另请参阅

• Object
• IComparable