Double.Equals Metoda

Definicja

Zwraca wartość wskazującą, czy dwa wystąpienia Double reprezentują tę samą wartość.

Przeciążenia

Equals(Double)

Zwraca wartość wskazującą, czy to wystąpienie i określony Double obiekt reprezentują tę samą wartość.

Equals(Object)

Zwraca wartość wskazującą, czy to wystąpienie jest równe podanemu obiektowi.

Equals(Double)

Zwraca wartość wskazującą, czy to wystąpienie i określony Double obiekt reprezentują tę samą wartość.

public:
 virtual bool Equals(double obj);
public bool Equals (double obj);
override this.Equals : double -> bool
Public Function Equals (obj As Double) As Boolean

Parametry

obj
Double

Double Obiekt do porównania z tym wystąpieniem.

Zwraca

Boolean

true jeśli obj jest równe temu wystąpieniu; w przeciwnym razie false.

Implementuje

Uwagi

Ta metoda implementuje System.IEquatable<T> interfejs i działa nieco lepiej niż Equals dlatego, że nie musi konwertować parametru obj na obiekt.

Poszerzenie konwersji

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 rozszerzonej reprezentacji 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 najwyraźniej 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 na 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ć z równością, 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, a zatem wartości mogą być równe. W poniższym przykładzie użyto tej techniki, aby porównać 33333 i 1/3, dwie 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 jest to wiele razy większe 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ównywaniu 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ę projektowania 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 1, ponieważ Epsilon jest najmniejszą wartością reprezentującą podczas pracy z wartością Double , której wartość wynosi 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 Equals(Double) kodu z metodą, która okazała się nierówna. Należy pamiętać, że w przykładzie BitConverter.DoubleToInt64Bits użyto metody w celu przekonwertowania wartości zmiennoprzecinkowej o podwójnej precyzji na reprezentację liczb całkowitych.

using System;

public class Example
{
   public static void Main()
   {
      double value1 = .1 * 10;
      double value2 = 0;
      for (int ctr = 0; ctr < 10; ctr++)
         value2 += .1;

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

   public static bool HasMinimalDifference(double value1, double value2, int units)
   {
      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;
      }

      long diff = Math.Abs(lValue1 - lValue2);

      if (diff <= (long) units)
         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

Dokładność liczb zmiennoprzecinkowych poza udokumentowaną dokładnością jest określona dla implementacji oraz wersji systemu .NET Framework. W związku z tym porównanie dwóch określonych liczb może ulec zmianie między wersji systemu .NET Framework, ponieważ precyzja przedstawienia numeracji wewnętrznej może ulec zmianie.

Jeśli dwie Double.NaN wartości są testowane pod kątem równości, wywołując metodę Equals , metoda zwraca wartość true. Jeśli jednak dwie 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 .

Uwagi dotyczące wywoływania

Rozpoznawanie przeciążeń kompilatora może uwzględniać widoczną różnicę w zachowaniu dwóch Equals(Object) przeciążeń metody. Jeśli niejawna konwersja między obj argumentem a elementem Double jest zdefiniowana, a argument nie jest wpisywany jako , kompilatory mogą wykonać niejawną Objectkonwersję i wywołać metodę Equals(Double) . W przeciwnym razie wywołają metodę Equals(Object) , która zawsze zwraca wartość false , jeśli jej obj argument nie jest wartością Double . Poniższy przykład ilustruje różnicę w zachowaniu między dwoma przeciążeniami metody. W przypadku wszystkich pierwotnych typów liczbowych z wyjątkiem Decimal i w języku C#pierwsze porównanie zwraca, ponieważ kompilator automatycznie wykonuje konwersję rozszerzającą i wywołuje Equals(Double) metodę, natomiast drugie porównanie zwraca true false, ponieważ kompilator wywołuje metodęEquals(Object).

using System;

public class Example
{
   static double value = 112;

   public static void Main()
   {
      byte byte1= 112;
      Console.WriteLine("value = byte1: {0,16}", value.Equals(byte1));
      TestObjectForEquality(byte1);

      short short1 = 112;
      Console.WriteLine("value = short1: {0,16}", value.Equals(short1));
      TestObjectForEquality(short1);

      int int1 = 112;
      Console.WriteLine("value = int1: {0,18}", value.Equals(int1));
      TestObjectForEquality(int1);

      long long1 = 112;
      Console.WriteLine("value = long1: {0,17}", value.Equals(long1));
      TestObjectForEquality(long1);

      sbyte sbyte1 = 112;
      Console.WriteLine("value = sbyte1: {0,16}", value.Equals(sbyte1));
      TestObjectForEquality(sbyte1);

      ushort ushort1 = 112;
      Console.WriteLine("value = ushort1: {0,16}", value.Equals(ushort1));
      TestObjectForEquality(ushort1);

      uint uint1 = 112;
      Console.WriteLine("value = uint1: {0,18}", value.Equals(uint1));
      TestObjectForEquality(uint1);

      ulong ulong1 = 112;
      Console.WriteLine("value = ulong1: {0,17}", value.Equals(ulong1));
      TestObjectForEquality(ulong1);

      decimal dec1 = 112m;
      Console.WriteLine("value = dec1: {0,21}", value.Equals(dec1));
      TestObjectForEquality(dec1);

      float sng1 = 112;
      Console.WriteLine("value = sng1: {0,19}", value.Equals(sng1));
      TestObjectForEquality(sng1);
   }

   private static void TestObjectForEquality(Object obj)
   {
      Console.WriteLine("{0} ({1}) = {2} ({3}): {4}\n",
                        value, value.GetType().Name,
                        obj, obj.GetType().Name,
                        value.Equals(obj));
   }
}
// The example displays the following output:
//       value = byte1:             True
//       112 (Double) = 112 (Byte): False
//
//       value = short1:             True
//       112 (Double) = 112 (Int16): False
//
//       value = int1:               True
//       112 (Double) = 112 (Int32): False
//
//       value = long1:              True
//       112 (Double) = 112 (Int64): False
//
//       value = sbyte1:             True
//       112 (Double) = 112 (SByte): False
//
//       value = ushort1:             True
//       112 (Double) = 112 (UInt16): False
//
//       value = uint1:               True
//       112 (Double) = 112 (UInt32): False
//
//       value = ulong1:              True
//       112 (Double) = 112 (UInt64): False
//
//       value = dec1:                 False
//       112 (Double) = 112 (Decimal): False
//
//       value = sng1:                True
//       112 (Double) = 112 (Single): False

Zobacz też

Dotyczy

Equals(Object)

Zwraca wartość wskazującą, czy to wystąpienie jest równe podanemu obiektowi.

public:
 override bool Equals(System::Object ^ obj);
public override bool Equals (object obj);
public override bool Equals (object? obj);
override this.Equals : obj -> bool
Public Overrides Function Equals (obj As Object) As Boolean

Parametry

obj
Object

Obiekt, który ma zostać porównany z tym wystąpieniem.

Zwraca

Boolean

truejeśli obj jest wystąpieniem Double i równa wartości tego wystąpienia; w przeciwnym razie . false

Uwagi

Metoda Equals powinna być używana z ostrożnością, ponieważ dwie najwyraźniej 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 informuje, że Double wartość .3333 i Double zwrócona przez podzielenie 1 na 3 są nierówne.

// Initialize two doubles with apparently identical values
double double1 = .33333;
object 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) |> box
// 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 Object = 1/3
' Compare them for equality
Console.WriteLine(double1.Equals(double2))    ' displays False

Aby uzyskać alternatywy dla wywołania Equals metody, zobacz dokumentację przeciążenia Equals(Double) .

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 jest to wiele razy większe niż Epsilon.

Dokładność liczb zmiennoprzecinkowych poza udokumentowaną dokładnością jest określona dla implementacji oraz wersji systemu .NET Framework. W związku z tym porównanie dwóch określonych liczb może ulec zmianie między wersji systemu .NET Framework, ponieważ precyzja przedstawienia numeracji wewnętrznej może ulec zmianie.

Jeśli dwie Double.NaN wartości są testowane pod kątem równości, wywołując metodę Equals , metoda zwraca wartość true. Jeśli jednak dwie 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 .

Uwagi dotyczące wywoływania

Rozpoznawanie przeciążeń kompilatora może uwzględniać widoczną różnicę w zachowaniu dwóch Equals(Object) przeciążeń metody. Jeśli niejawna konwersja między obj argumentem a elementem Double jest zdefiniowana, a argument nie jest wpisywany jako , kompilatory mogą wykonać niejawną Objectkonwersję i wywołać metodę Equals(Double) . W przeciwnym razie wywołają metodę Equals(Object) , która zawsze zwraca wartość false , jeśli jej obj argument nie jest wartością Double . Poniższy przykład ilustruje różnicę w zachowaniu między dwoma przeciążeniami metody. W przypadku wszystkich pierwotnych typów liczbowych z wyjątkiem Decimal i w języku C#pierwsze porównanie zwraca, ponieważ kompilator automatycznie wykonuje konwersję rozszerzającą i wywołuje Equals(Double) metodę, natomiast drugie porównanie zwraca true false, ponieważ kompilator wywołuje metodęEquals(Object).

using System;

public class Example
{
   static double value = 112;

   public static void Main()
   {
      byte byte1= 112;
      Console.WriteLine("value = byte1: {0,16}", value.Equals(byte1));
      TestObjectForEquality(byte1);

      short short1 = 112;
      Console.WriteLine("value = short1: {0,16}", value.Equals(short1));
      TestObjectForEquality(short1);

      int int1 = 112;
      Console.WriteLine("value = int1: {0,18}", value.Equals(int1));
      TestObjectForEquality(int1);

      long long1 = 112;
      Console.WriteLine("value = long1: {0,17}", value.Equals(long1));
      TestObjectForEquality(long1);

      sbyte sbyte1 = 112;
      Console.WriteLine("value = sbyte1: {0,16}", value.Equals(sbyte1));
      TestObjectForEquality(sbyte1);

      ushort ushort1 = 112;
      Console.WriteLine("value = ushort1: {0,16}", value.Equals(ushort1));
      TestObjectForEquality(ushort1);

      uint uint1 = 112;
      Console.WriteLine("value = uint1: {0,18}", value.Equals(uint1));
      TestObjectForEquality(uint1);

      ulong ulong1 = 112;
      Console.WriteLine("value = ulong1: {0,17}", value.Equals(ulong1));
      TestObjectForEquality(ulong1);

      decimal dec1 = 112m;
      Console.WriteLine("value = dec1: {0,21}", value.Equals(dec1));
      TestObjectForEquality(dec1);

      float sng1 = 112;
      Console.WriteLine("value = sng1: {0,19}", value.Equals(sng1));
      TestObjectForEquality(sng1);
   }

   private static void TestObjectForEquality(Object obj)
   {
      Console.WriteLine("{0} ({1}) = {2} ({3}): {4}\n",
                        value, value.GetType().Name,
                        obj, obj.GetType().Name,
                        value.Equals(obj));
   }
}
// The example displays the following output:
//       value = byte1:             True
//       112 (Double) = 112 (Byte): False
//
//       value = short1:             True
//       112 (Double) = 112 (Int16): False
//
//       value = int1:               True
//       112 (Double) = 112 (Int32): False
//
//       value = long1:              True
//       112 (Double) = 112 (Int64): False
//
//       value = sbyte1:             True
//       112 (Double) = 112 (SByte): False
//
//       value = ushort1:             True
//       112 (Double) = 112 (UInt16): False
//
//       value = uint1:               True
//       112 (Double) = 112 (UInt32): False
//
//       value = ulong1:              True
//       112 (Double) = 112 (UInt64): False
//
//       value = dec1:                 False
//       112 (Double) = 112 (Decimal): False
//
//       value = sng1:                True
//       112 (Double) = 112 (Single): False

Zobacz też

Dotyczy