System.Double.Equals, metoda

Metoda Th Double.Equals(Double) implementuje System.IEquatable<T> interfejs i działa nieco lepiej niż Double.Equals(Object) dlatego, że nie musi konwertować parametru obj na obiekt.

Konwersje rozszerzające

W zależności od języka programowania można kodować metodę Equals , w której typ parametru ma mniej bitów (jest węższy) niż typ wystąpienia. To jest możliwe, ponieważ w niektórych językach programowania jest wykonywana niejawna konwersja poszerzająca, która powoduje reprezentowanie parametru jako typu z taką samą liczbą bitów jak liczba bitów wystąpienia.

Załóżmy na przykład, że typ wystąpienia to Double , a typ parametru to Int32. Kompilator języka Microsoft C# generuje instrukcje reprezentujące wartość parametru jako Double obiekt, a następnie generuje metodę Double.Equals(Double) , która porównuje wartości wystąpienia i poszerzone reprezentacje parametru.

Sprawdź dokumentację języka programowania, aby określić, czy jego kompilator wykonuje niejawne poszerzenia konwersji dla typów liczbowych. Aby uzyskać więcej informacji, zobacz temat Tabele konwersji typów.

Precyzja w porównaniach

Metoda Equals powinna być używana z ostrożnością, ponieważ dwie pozornie równoważne wartości mogą być nierówne ze względu na różnicową precyzję tych dwóch wartości. Poniższy przykład zgłasza, że Double wartość .333333 i Double wartość zwrócona przez podzielenie 1 o 3 są nierówne.

// Initialize two doubles with apparently identical values
double double1 = .33333;
double double2 = (double) 1/3;
// Compare them for equality
Console.WriteLine(double1.Equals(double2));    // displays false

// Initialize two doubles with apparently identical values
let double1 = 0.33333
let double2 = double (1 / 3)
// Compare them for equality
printfn $"{double1.Equals double2}"    // displays false

' Initialize two doubles with apparently identical values
Dim double1 As Double = .33333
Dim double2 As Double = 1/3
' Compare them for equality
Console.WriteLine(double1.Equals(double2))    ' displays False

Zamiast porównywać równość, jedna technika polega na zdefiniowaniu dopuszczalnego względnego marginesu różnicy między dwiema wartościami (na przykład 001% jednej z wartości). Jeśli wartość bezwzględna różnicy między dwiema wartościami jest mniejsza lub równa temu marginesowi, różnica może być spowodowana różnicami w precyzji i dlatego wartości mogą być równe. W poniższym przykładzie użyto tej techniki do porównania wartości .33333 i 1/3, czyli dwóch Double wartości, które znaleziono w poprzednim przykładzie kodu, są nierówne. W takim przypadku wartości są równe.

// Initialize two doubles with apparently identical values
double double1 = .333333;
double double2 = (double) 1/3;
// Define the tolerance for variation in their values
double difference = Math.Abs(double1 * .00001);

// Compare the values
// The output to the console indicates that the two values are equal
if (Math.Abs(double1 - double2) <= difference)
   Console.WriteLine("double1 and double2 are equal.");
else
   Console.WriteLine("double1 and double2 are unequal.");

// Initialize two doubles with apparently identical values
let double1 = 0.333333
let double2 = double (1 / 3)
// Define the tolerance for variation in their values
let difference = abs (double1 * 0.00001)

// Compare the values
// The output to the console indicates that the two values are equal
if abs (double1 - double2) <= difference then
    printfn "double1 and double2 are equal."
else
    printfn "double1 and double2 are unequal."

' Initialize two doubles with apparently identical values
Dim double1 As Double = .33333
Dim double2 As Double = 1/3
' Define the tolerance for variation in their values
Dim difference As Double = Math.Abs(double1 * .00001)

' Compare the values
' The output to the console indicates that the two values are equal
If Math.Abs(double1 - double2) <= difference Then
   Console.WriteLine("double1 and double2 are equal.")
Else
   Console.WriteLine("double1 and double2 are unequal.")
End If

Uwaga

Ponieważ Epsilon definiuje minimalne wyrażenie wartości dodatniej, której zakres jest zbliżony do zera, margines różnicy między dwiema podobnymi wartościami musi być większy niż Epsilon. Zazwyczaj wartość jest wielokrotnie większa niż Epsilon. W związku z tym zalecamy, aby nie używać Epsilon ich podczas porównywania Double wartości pod kątem równości.

Druga technika polega na porównaniu różnicy między dwiema liczbami zmiennoprzecinkowych z pewną wartością bezwzględną. Jeśli różnica jest mniejsza lub równa tej wartości bezwzględnej, liczby są równe. Jeśli jest większa, liczby nie są równe. Jedną z alternatyw jest arbitralne wybranie wartości bezwzględnej. Jest to jednak problematyczne, ponieważ akceptowalny margines różnicy zależy od wielkości Double wartości. Druga alternatywa wykorzystuje funkcję projektową formatu zmiennoprzecinkowego: Różnica między reprezentacją całkowitą dwóch wartości zmiennoprzecinkowych wskazuje liczbę możliwych wartości zmiennoprzecinkowych, które je oddzielają. Na przykład różnica między wartością 0,0 a Epsilon jest równa 1, ponieważ Epsilon jest najmniejszą wartością reprezentującą podczas pracy z wartością, której Double wartość to zero. W poniższym przykładzie użyto tej techniki do porównania wartości .33333 i 1/3, które są dwiema Double wartościami, które zostały opisane w poprzednim przykładzie kodu z Equals(Double) metodą, która okazała się nierówna. W przykładzie użyto BitConverter.DoubleToInt64Bits metody , aby przekonwertować wartość zmiennoprzecinkową o podwójnej precyzji na reprezentację liczb całkowitych. Przykład deklaruje wartości jako równe, jeśli nie ma możliwych wartości zmiennoprzecinkowych między ich reprezentacjami całkowitymi.

public static void Main()
{
    // Initialize the values.
    double value1 = .1 * 10;
    double value2 = 0;
    for (int ctr = 0; ctr < 10; ctr++)
        value2 += .1;

    Console.WriteLine($"{value1:R} = {value2:R}: " +
        $"{HasMinimalDifference(value1, value2, 1)}");
}

public static bool HasMinimalDifference(
    double value1,
    double value2,
    int allowableDifference
    )
{
    // Convert the double values to long values.
    long lValue1 = BitConverter.DoubleToInt64Bits(value1);
    long lValue2 = BitConverter.DoubleToInt64Bits(value2);

    // If the signs are different, return false except for +0 and -0.
    if ((lValue1 >> 63) != (lValue2 >> 63))
    {
        if (value1 == value2)
            return true;

        return false;
    }

    // Calculate the number of possible
    // floating-point values in the difference.
    long diff = Math.Abs(lValue1 - lValue2);

    if (diff <= allowableDifference)
        return true;

    return false;
}
// The example displays the following output:
//
//        1 = 0.99999999999999989: True

open System

let hasMinimalDifference (value1: double) (value2: double) (units: int) =
    let lValue1 = BitConverter.DoubleToInt64Bits value1
    let lValue2 = BitConverter.DoubleToInt64Bits value2

    // If the signs are different, return false except for +0 and -0.
    if (lValue1 >>> 63) <> (lValue2 >>> 63) then
        value1 = value2
    else
        let diff = abs (lValue1 - lValue2)

        diff <= int64 units

let value1 = 0.1 * 10.
let mutable value2 = 0.
for _ = 0 to 9 do
    value2 <- value2 + 0.1

printfn $"{value1:R} = {value2:R}: {hasMinimalDifference value1 value2 1}"
                

// The example displays the following output:
//        1 = 0.99999999999999989: True

Module Example
   Public Sub Main()
      Dim value1 As Double = .1 * 10
      Dim value2 As Double = 0
      For ctr As Integer =  0 To 9
         value2 += .1
      Next
               
      Console.WriteLine("{0:R} = {1:R}: {2}", value1, value2,
                        HasMinimalDifference(value1, value2, 1))
   End Sub

   Public Function HasMinimalDifference(value1 As Double, value2 As Double, units As Integer) As Boolean
      Dim lValue1 As long =  BitConverter.DoubleToInt64Bits(value1)
      Dim lValue2 As long =  BitConverter.DoubleToInt64Bits(value2)
      
      ' If the signs are different, Return False except for +0 and -0.
      If ((lValue1 >> 63) <> (lValue2 >> 63)) Then
         If value1 = value2 Then
            Return True
         End If           
         Return False
      End If

      Dim diff As Long =  Math.Abs(lValue1 - lValue2)

      If diff <= units Then
         Return True
      End If

      Return False
   End Function
End Module
' The example displays the following output:
'       1 = 0.99999999999999989: True

Uwaga

W przypadku niektórych wartości można je wziąć pod uwagę nawet wtedy, gdy istnieje możliwa wartość zmiennoprzecinkowa między reprezentacjami liczb całkowitych. Rozważmy na przykład podwójne wartości 0.39 i 1.69 - 1.3 (które są obliczane jako 0.3899999999999999). Na komputerze typu little-endian reprezentacje liczb całkowitych tych wartości to 4600697235336603894 i 4600697235336603892, odpowiednio. Różnica między wartościami całkowitymi to 2, co oznacza, że istniejemożliwa wartość zmiennoprzecinkowa między 0.39 i 1.69 - 1.3.

Różnice wersji

Precyzja liczb zmiennoprzecinkowych poza udokumentowaną precyzją jest specyficzna dla implementacji i wersji platformy .NET. W związku z tym porównanie dwóch konkretnych liczb może ulec zmianie między wersjami platformy .NET, ponieważ precyzja wewnętrznej reprezentacji liczb może ulec zmianie.

NaN

Jeśli dwie Double.NaN wartości są testowane pod kątem Equals równości przez wywołanie metody , metoda zwraca truewartość . Jeśli jednak dwie Double.NaN wartości są testowane pod kątem równości przy użyciu operatora równości, operator zwraca wartość false. Jeśli chcesz określić, czy wartość elementu Double nie jest liczbą (NaN), alternatywą jest wywołanie IsNaN metody .