本文由机器翻译。若要查看英语原文,请勾选“英语”复选框。 也可将鼠标指针移到文本上,在弹出窗口中显示英语原文。
翻译
英语

IComparable<T> 接口

 

定义由值类型或类实现的通用比较方法,以为排序实例创建类型特定的比较方法。

命名空间:   System
程序集:  mscorlib(位于 mscorlib.dll)

public interface IComparable<in T>

类型参数

inT

要比较的对象的类型。

名称说明
System_CAPS_pubmethodCompareTo(T)

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

This interface is implemented by types whose values can be ordered or sorted and provides a strongly typed comparison method for ordering members of a generic collection object. For example, one number can be larger than a second number, and one string can appear in alphabetical order before another. It requires that implementing types define a single method, M:System.IComparable`1.CompareTo(`0), that indicates whether the position of the current instance in the sort order is before, after, or the same as a second object of the same type. Typically, the method is not called directly from developer code. Instead, it is called automatically by methods such as M:System.Collections.Generic.List`1.Sort and M:System.Collections.Generic.SortedList`2.Add(`0,`1).

Typically, types that provide an T:System.IComparable`1 implementation also implement the T:System.IEquatable`1 interface. The T:System.IEquatable`1 interface defines the M:System.IEquatable`1.Equals(`0) method, which determines the equality of instances of the implementing type.

The implementation of the M:System.IComparable`1.CompareTo(`0) method must return an T:System.Int32 that has one of three values, as shown in the following table.

Value

Meaning

Less than zero

This object precedes the object specified by the M:System.IComparable`1.CompareTo(`0) method in the sort order.

Zero

This current instance occurs in the same position in the sort order as the object specified by the M:System.IComparable`1.CompareTo(`0) method argument.

Greater than zero

This current instance follows the object specified by the M:System.IComparable`1.CompareTo(`0) method argument in the sort order.

All numeric types (such as T:System.Int32 and T:System.Double) implement T:System.IComparable`1, as do T:System.String, T:System.Char, and T:System.DateTime. Custom types should also provide their own implementation of T:System.IComparable`1 to enable object instances to be ordered or sorted.

实现函数说明:

Replace the type parameter of the T:System.IComparable`1 interface with the type that is implementing this interface.

If you implement T:System.IComparable`1, you should overload the op_GreaterThan, op_GreaterThanOrEqual, op_LessThan, and op_LessThanOrEqual operators to return values that are consistent with M:System.IComparable`1.CompareTo(`0). In addition, you should also implement T:System.IEquatable`1. See the T:System.IEquatable`1 article for complete information.

The following code example illustrates the implementation of T:System.IComparable`1 for a simple Temperature object. The example creates a T:System.Collections.Generic.SortedList`2 collection of strings with Temperature object keys, and adds several pairs of temperatures and strings to the list out of sequence. In the call to the M:System.Collections.Generic.SortedList`2.Add(`0,`1) method, the T:System.Collections.Generic.SortedList`2 collection uses the T:System.IComparable`1 implementation to sort the list entries, which are then displayed in order of increasing temperature.

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.
*/

通用 Windows 平台
自 8 起可用
.NET Framework
自 2.0 起可用
可移植类库
可移植 .NET 平台 中受支持
Silverlight
自 2.0 起可用
Windows Phone Silverlight
自 7.0 起可用
Windows Phone
自 8.1 起可用
返回页首
显示: