System.IComparable 接口

方法描述

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

语法定义(C# System.IComparable 接口 的用法)

public interface IComparable

构造函数

构造函数名称 构造函数描述

成员/方法

方法名称 方法描述
CompareTo 比较当前对象和同一类型的另一对象。

提示和注释

此接口由值可以排序的类型实现；例如数值或字符串类。 值类型或类实现 CompareTo(T) 方法以创建适合排序等目的的类型特定的比较方法。

IComparable 接口定义 CompareTo(T) 方法，该方法确定实现类型的实例的排序顺序。 IEquatable 接口定义 Equals 方法，该方法确定实现类型的实例的相等性。

CompareTo(T) 方法的实现必须返回有三个值之一的 Int32，如下表中所示。

值

含义

小于零

此对象小于 CompareTo 方法指定的对象。

零

此对象等于方法参数。

大于零

此对象大于方法参数。

IComparable 接口提供强类型的比较方法，以排序泛型集合对象的成员。 因此，通常不从开发人员代码直接调用该方法。 List.Sort() 和 Add 等方法会自动调用它。

对实现者的说明

用实现此接口的类型替换 IComparable 接口的类型参数。

System.IComparable 接口例子

在调用 Add 方法时，SortedList 集合使用 IComparable 实现对列表项进行排序，然后，这些列表项将按温度的升序显示。

using System;
using System.Collections.Generic;

public class Temperature : IComparable
{
    // Implement the CompareTo method. For the parameter type, Use 
    // the type specified for the type parameter of the generic 
    // IComparable interface. 
    //
    public int CompareTo(Temperature other)
    {
        // The temperature comparison depends on the comparison of the
        // the underlying Double values. Because the CompareTo method is
        // strongly typed, it is not necessary to test for the correct
        // object type.
        return m_value.CompareTo(other.m_value);
    }

    // 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 temps = 
            new SortedList();

        // 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 kvp in temps )
        {
            Console.WriteLine("{0} is {1} degrees Celsius.", kvp.Value, kvp.Key.Celsius);
        }
    }
}

/* This code example produces 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.

*/

继承层次结构

命名空间

namespace: System

程序集: mscorlib（在 mscorlib.dll 中）

线程安全

版本信息

.NET Framework 受以下版本支持：4、3.5、3.0、2.0 .NET Framework Client Profile 受以下版本支持：4、3.5 SP1 受以下版本支持：

适用平台

Windows 7, Windows Vista SP1 或更高版本, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008（不支持服务器核心）, Windows Server 2008 R2（支持 SP1 或更高版本的服务器核心）, Windows Server 2003 SP2 .NET Framework 并不是对每个平台的所有版本都提供支持。有关支持的版本的列表，请参见.NET Framework 系统要求。

相关资源

System 命名空间
IComparable
IEquatable
MSDN