IComparable<T>.CompareTo(T) Metodo

Definizione

Confronta l'istanza corrente con un altro oggetto dello stesso tipo e restituisce un intero che indica se l'istanza corrente precede, segue o si trova nella stessa posizione dell'altro oggetto all'interno dell'ordinamento.Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

public:
 int CompareTo(T other);
public int CompareTo (T other);
abstract member CompareTo : 'T -> int
Public Function CompareTo (other As T) As Integer

Parametri

other
T

Oggetto da confrontare con l'istanza.An object to compare with this instance.

Restituisce

Valore che indica l'ordine relativo degli oggetti confrontati.A value that indicates the relative order of the objects being compared. Il valore restituito ha i seguenti significati:The return value has these meanings:

ValueValue SignificatoMeaning
Minore di zeroLess than zero Questa istanza precede other nell'ordinamento.This instance precedes other in the sort order.
ZeroZero Questa istanza si presenta nella stessa posizione di other all'interno dell'ordinamento.This instance occurs in the same position in the sort order as other.
Maggiore di zeroGreater than zero Questa istanza segue other nei criteri di ordinamento.This instance follows other in the sort order.

Esempi

Nell'esempio di codice seguente viene illustrata l' IComparable<T> implementazione di per Temperature un oggetto semplice.The following code example illustrates the implementation of IComparable<T> for a simple Temperature object. Nell'esempio viene creata SortedList<TKey,TValue> una raccolta di stringhe Temperature con chiavi di oggetto e vengono aggiunte diverse coppie di temperature e stringhe all'elenco fuori sequenza.The example creates a SortedList<TKey,TValue> collection of strings with Temperature object keys, and adds several pairs of temperatures and strings to the list out of sequence. Nella chiamata al Add metodo, la SortedList<TKey,TValue> raccolta usa l' IComparable<T> implementazione di per ordinare le voci dell'elenco, che vengono quindi visualizzate in ordine di aumento della temperatura.In the call to the Add method, the SortedList<TKey,TValue> collection uses the IComparable<T> implementation to sort the list entries, which are then displayed in order of increasing temperature.

#using <System.dll>

using namespace System;
using namespace System::Collections::Generic;

public ref class Temperature: public IComparable<Temperature^> {

protected:
   // The underlying temperature value.
   Double m_value;

public:
   // Implement the generic CompareTo method with the Temperature class 
   // as the Type parameter. 
   virtual Int32 CompareTo( Temperature^ other ) {
   
      // If other is not a valid object reference, this instance 
      // is greater.
      if (other == nullptr) return 1;
      
      // The temperature comparison depends on the comparison of the
      // the underlying Double values. 
      return m_value.CompareTo( other->m_value );
   }

       // Define the is greater than operator.
    bool operator>=  (Temperature^ other)
    {
       return CompareTo(other) == 1;
    }
    
    // Define the is less than operator.
    bool operator<  (Temperature^ other)
    {
       return CompareTo(other) == -1;
    }
    
       // Define the is greater than or equal to operator.
    bool operator>  (Temperature^ other)
    {
       return CompareTo(other) >= 0;
    }
    
    // Define the is less than or equal to operator.
    bool operator<=  (Temperature^ other)
    {
       return CompareTo(other) <= 0;
    }

   property Double Celsius {
      Double get() {
         return m_value + 273.15;
      }
   }

   property Double Kelvin {
      Double get() {
         return m_value;
      }
      void set( Double value ) {
         if (value < 0)
            throw gcnew ArgumentException("Temperature cannot be less than absolute zero.");
         else
            m_value = value;
      }
   }

   Temperature(Double kelvins) {
      this->Kelvin = kelvins;
   }
};

int main() {
   SortedList<Temperature^, String^>^ temps = 
      gcnew SortedList<Temperature^, String^>();

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

   for each( KeyValuePair<Temperature^, String^>^ kvp in temps )
   {
      Console::WriteLine("{0} is {1} degrees Celsius.", kvp->Value, kvp->Key->Celsius);
   }
}
/* The example displays the following output:
      Absolute zero is 273.15 degrees Celsius.
      Freezing point of water is 546.3 degrees Celsius.
      Boiling point of water is 646.3 degrees Celsius.
      Melting point of Lead is 873.8 degrees Celsius.
      Boiling point of Lead is 2290.3 degrees Celsius.
      Boiling point of Carbon is 5373.3 degrees Celsius.
*/
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.
*/
Imports System.Collections.Generic

Public Class Temperature
    Implements IComparable(Of Temperature)

    ' Implement the generic CompareTo method with the Temperature class 
    ' as the type parameter. 
    '
    Public Overloads Function CompareTo(ByVal other As Temperature) As Integer _
        Implements IComparable(Of Temperature).CompareTo

        ' If other is not a valid object reference, this instance is greater.
        If other Is Nothing Then Return 1
        
        ' The temperature comparison depends on the comparison of the
        ' the underlying Double values. 
        Return m_value.CompareTo(other.m_value)
    End Function
    
    ' Define the is greater than operator.
    Public Shared Operator >  (operand1 As Temperature, operand2 As Temperature) As Boolean
       Return operand1.CompareTo(operand2) = 1
    End Operator
    
    ' Define the is less than operator.
    Public Shared Operator <  (operand1 As Temperature, operand2 As Temperature) As Boolean
       Return operand1.CompareTo(operand2) = -1
    End Operator

    ' Define the is greater than or equal to operator.
    Public Shared Operator >=  (operand1 As Temperature, operand2 As Temperature) As Boolean
       Return operand1.CompareTo(operand2) >= 0
    End Operator
    
    ' Define the is less than operator.
    Public Shared Operator <=  (operand1 As Temperature, operand2 As Temperature) As Boolean
       Return operand1.CompareTo(operand2) <= 0
    End Operator

    ' The underlying temperature value.
    Protected m_value As Double = 0.0

    Public ReadOnly Property Celsius() As Double
        Get
            Return m_value - 273.15
        End Get
    End Property

    Public Property Kelvin() As Double
        Get
            Return m_value
        End Get
        Set(ByVal Value As Double)
            If value < 0.0 Then 
                Throw New ArgumentException("Temperature cannot be less than absolute zero.")
            Else
                m_value = Value
            End If
        End Set
    End Property

    Public Sub New(ByVal kelvins As Double)
        Me.Kelvin = kelvins 
    End Sub
End Class

Public Class Example
    Public Shared Sub Main()
        Dim temps As New SortedList(Of 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")

        For Each kvp As KeyValuePair(Of Temperature, String) In temps
            Console.WriteLine("{0} is {1} degrees Celsius.", kvp.Value, kvp.Key.Celsius)
        Next
    End Sub
End Class

' The 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.
'

Commenti

CompareTofornisce un metodo di confronto fortemente tipizzato per ordinare i membri di un oggetto della raccolta generica.CompareTo provides a strongly typed comparison method for ordering members of a generic collection object. Per questo motivo, in genere non viene chiamato direttamente dal codice dello sviluppatore.Because of this, it is usually not called directly from developer code. Viene invece chiamato automaticamente da metodi quali List<T>.Sort() e. AddInstead, it is called automatically by methods such as List<T>.Sort() and Add.

Questo metodo è solo una definizione e deve essere implementato da una classe o un tipo di valore specifico per avere effetto.This method is only a definition and must be implemented by a specific class or value type to have effect. Il significato dei confronti specificati nella sezione valori restituiti ("precede", "si trova nella stessa posizione di" e "segue) dipende dall'implementazione specifica.The meaning of the comparisons specified in the Return Values section ("precedes", "occurs in the same position as", and "follows) depends on the particular implementation.

Per definizione, qualsiasi oggetto viene confrontato nullcon maggiore di e due riferimenti null si confrontano tra loro.By definition, any object compares greater than null, and two null references compare equal to each other.

Note per gli implementatori

Per gli oggetti A, B e C, è necessario che siano soddisfatte le condizioni seguenti:For objects A, B, and C, the following must be true: A . CompareTo (a) è necessario per restituire zero.A.CompareTo(A) is required to return zero.

Se a. CompareTo (B) viene restituito zero, B. CompareTo (a) è necessario per restituire zero.If A.CompareTo(B) returns zero, then B.CompareTo(A) is required to return zero.

Se a. CompareTo (B) restituisce zero e B. CompareTo (c) restituisce zero, per restituire zero è necessario un. CompareTo (c) .If A.CompareTo(B) returns zero and B.CompareTo(C) returns zero, then A.CompareTo(C) is required to return zero.

Se a. CompareTo (B) viene restituito un valore diverso da zero, b. CompareTo (a) è necessario per restituire un valore del segno opposto.If A.CompareTo(B) returns a value other than zero, then B.CompareTo(A) is required to return a value of the opposite sign.

Se a. CompareTo (B) viene restituito un x valore diverso da zero e B. CompareTo (c) restituisce un y xvalore con lo stesso segno di, a . CompareTo (c) è necessario restituire un valore con lo stesso segno di x e .yIf A.CompareTo(B) returns a value x that is not equal to zero, and B.CompareTo(C) returns a value y of the same sign as x, then A.CompareTo(C) is required to return a value of the same sign as x and y.

Note per i chiamanti

Utilizzare il CompareTo(T) metodo per determinare l'ordinamento delle istanze di una classe.Use the CompareTo(T) method to determine the ordering of instances of a class.

Si applica a

Vedi anche