Double.Equals Метод

Определение

Возвращает значение, указывающее, представляют ли два экземпляра Double одно и то же значение.Returns a value indicating whether two instances of Double represent the same value.

Перегрузки

Equals(Double)

Возвращает значение, позволяющее определить, представляют ли этот экземпляр и заданный объект Double одно и то же значение.Returns a value indicating whether this instance and a specified Double object represent the same value.

Equals(Object)

Возвращает значение, показывающее, равен ли данный экземпляр заданному объекту.Returns a value indicating whether this instance is equal to a specified object.

Equals(Double)

Возвращает значение, позволяющее определить, представляют ли этот экземпляр и заданный объект Double одно и то же значение.Returns a value indicating whether this instance and a specified Double object represent the same value.

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

Параметры

obj
Double

Объект Double, сравниваемый с этим экземпляром.A Double object to compare to this instance.

Возвраты

Значение true, если значение параметра obj равно данному экземпляру; в противном случае — значение false.true if obj is equal to this instance; otherwise, false.

Реализации

Комментарии

Этот метод реализует интерфейс System.IEquatable<T> и работает немного лучше, чем Equals, поскольку ему не нужно преобразовывать параметр obj в объект.This method implements the System.IEquatable<T> interface, and performs slightly better than Equals because it does not have to convert the obj parameter to an object.

расширяющие преобразованияWidening Conversions

В зависимости от языка программирования может быть возможным написание кода для метода Equals, где тип параметра меньше бита (является более узким), чем тип экземпляра.Depending on your programming language, it might be possible to code a Equals method where the parameter type has fewer bits (is narrower) than the instance type. Это возможно, поскольку некоторые языки программирования выполняют неявное расширяющее преобразование, которое представляет параметр как тип с количеством битов в качестве экземпляра.This is possible because some programming languages perform an implicit widening conversion that represents the parameter as a type with as many bits as the instance.

Например, предположим, что тип экземпляра — Double, а тип параметра — Int32.For example, suppose the instance type is Double and the parameter type is Int32. Компилятор Microsoft C# создает инструкции для представления значения параметра как объекта Double, а затем создает метод Double.Equals(Double), который сравнивает значения экземпляра и расширенное представление параметра.The Microsoft C# compiler generates instructions to represent the value of the parameter as a Double object, then generates a Double.Equals(Double) method that compares the values of the instance and the widened representation of the parameter.

Обратитесь к документации по языку программирования, чтобы определить, выполняет ли компилятор неявное расширяющее преобразование числовых типов.Consult your programming language's documentation to determine if its compiler performs implicit widening conversions of numeric types. Дополнительные сведения см. в разделе таблицы преобразования типов .For more information, see the Type Conversion Tables topic.

Точность в сравненияхPrecision in Comparisons

Метод Equals следует использовать с осторожностью, так как два вероятно эквивалентных значения могут быть неравными из-за разной точности этих двух значений.The Equals method should be used with caution, because two apparently equivalent values can be unequal due to the differing precision of the two values. В следующем примере сообщается, что значение Double.333333 и значение Double, возвращаемое делением 1 на 3, не равны.The following example reports that the Double value .333333 and the Double value returned by dividing 1 by 3 are unequal.

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

Вместо сравнения на равенство, один прием подразумевает определение приемлемого относительного поля разности между двумя значениями (например, 001% одного из значений).Rather than comparing for equality, one technique involves defining an acceptable relative margin of difference between two values (such as .001% of one of the values). Если абсолютное значение разницы между двумя значениями меньше или равно этому полю, разница, скорее всего, будет обусловлена различиями в точности и, следовательно, значения, скорее всего, будут равны.If the absolute value of the difference between the two values is less than or equal to that margin, the difference is likely to be due to differences in precision and, therefore, the values are likely to be equal. В следующем примере этот метод используется для сравнения значений. 33333 и 1/3, что два значения Double, которые были найдены в предыдущем примере кода, не равны.The following example uses this technique to compare .33333 and 1/3, the two Double values that the previous code example found to be unequal. В этом случае значения равны.In this case, the values are equal.

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

Примечание

Поскольку Epsilon определяет минимальное выражение для положительного значения, чей диапазон близок к нулю, поле разности между двумя похожими значениями должно быть больше Epsilon.Because Epsilon defines the minimum expression of a positive value whose range is near zero, the margin of difference between two similar values must be greater than Epsilon. Как правило, число раз больше Epsilon.Typically, it is many times greater than Epsilon. Поэтому рекомендуется не использовать Epsilon при сравнении значений Double на равенство.Because of this, we recommend that you do not use Epsilon when comparing Double values for equality.

Второй метод включает сравнение различий между двумя числами с плавающей запятой и определенным абсолютным значением.A second technique involves comparing the difference between two floating-point numbers with some absolute value. Если разность меньше или равна этому абсолютному значению, числа равны.If the difference is less than or equal to that absolute value, the numbers are equal. Если оно больше, числа не равны.If it is greater, the numbers are not equal. Одним из альтернативных способов является произвольное выделение абсолютного значения.One alternative is to arbitrarily select an absolute value. Однако это проблематично, поскольку приемлемое поле разности зависит от величины значений Double.This is problematic, however, because an acceptable margin of difference depends on the magnitude of the Double values. Второй вариант использует преимущества функции проектирования в формате с плавающей запятой: Разница между целочисленным представлением двух значений с плавающей запятой указывает количество возможных значений с плавающей запятой, разделяющих их.A second alternative takes advantage of a design feature of the floating-point format: The difference between the integer representation of two floating-point values indicates the number of possible floating-point values that separates them. Например, разница между 0,0 и Epsilon равна 1, поскольку Epsilon — наименьшее значение, которое может быть представлено при работе с Double, значение которого равно нулю.For example, the difference between 0.0 and Epsilon is 1, because Epsilon is the smallest representable value when working with a Double whose value is zero. В следующем примере этот метод используется для сравнения значений. 33333 и 1/3, которые являются двумя значениями Double, которые предыдущий пример кода с методом Equals(Double) не равны.The following example uses this technique to compare .33333 and 1/3, which are the two Double values that the previous code example with the Equals(Double) method found to be unequal. Обратите внимание, что в примере используется метод BitConverter.DoubleToInt64Bits для преобразования значения с плавающей запятой двойной точности в целочисленное представление.Note that the example uses the BitConverter.DoubleToInt64Bits method to convert a double-precision floating-point value to its integer representation.

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:
//        01 = 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

Точность чисел с плавающей запятой, превышающих задокументированную точность, зависит от реализации и версии .NET Framework.The precision of floating-point numbers beyond the documented precision is specific to the implementation and version of the .NET Framework. Следовательно, сравнение двух определенных чисел может измениться между версиями .NET Framework, так как точность внутреннего представления чисел может измениться.Consequently, a comparison of two particular numbers might change between versions of the .NET Framework because the precision of the numbers' internal representation might change.

Если два значения Double.NaN проверяются на равенство путем вызова метода Equals, метод возвращает true.If two Double.NaN values are tested for equality by calling the Equals method, the method returns true. Однако если два значения NaN проверяются на равенство с помощью оператора равенства, оператор возвращает false.However, if two NaN values are tested for equality by using the equality operator, the operator returns false. Если необходимо определить, является ли значение Double нечисловым (NaN), можно также вызвать метод IsNaN.When you want to determine whether the value of a Double is not a number (NaN), an alternative is to call the IsNaN method.

Примечания для тех, кто вызывает этот метод

Разрешение перегрузки компилятора может учитывать очевидную разницу в поведении двух перегрузок метода Equals(Object).Compiler overload resolution may account for an apparent difference in the behavior of the two Equals(Object) method overloads. Если неявное преобразование между аргументом obj и Double определено и аргумент не типизирован как Object, компиляторы могут выполнить неявное преобразование и вызвать метод Equals(Double).If an implicit conversion between the obj argument and a Double is defined and the argument is not typed as an Object, compilers may perform an implicit conversion and call the Equals(Double) method. В противном случае они вызывают метод Equals(Object), который всегда возвращает false, если его аргумент obj не является значением Double.Otherwise, they call the Equals(Object) method, which always returns false if its obj argument is not a Double value. В следующем примере показано различие в поведении между двумя перегрузками метода.The following example illustrates the difference in behavior between the two method overloads. В случае со всеми примитивными числовыми типами, за исключением @no__t- C#0 и в, первое сравнение возвращает true, так как компилятор автоматически выполняет расширяющее преобразование и вызывает метод Equals(Double), тогда как второе сравнение возвращает false. так как компилятор вызывает метод Equals(Object).In the case of all primitive numeric types except for Decimal and in C#, the first comparison returns true because the compiler automatically performs a widening conversion and calls the Equals(Double) method, whereas the second comparison returns false because the compiler calls the Equals(Object) method.

[! код-CSharpSystem. Double. Equals # 2] [! код-VBSystem. Double. Equals # 2][!code-csharpSystem.Double.Equals#2] [!code-vbSystem.Double.Equals#2]

Дополнительно

Equals(Object)

Возвращает значение, показывающее, равен ли данный экземпляр заданному объекту.Returns a value indicating whether this instance is equal to a specified object.

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

Параметры

obj
Object

Объект для сравнения с данным экземпляром.An object to compare with this instance.

Возвраты

Значение true, если параметр obj является экземпляром типа Double и равен значению данного экземпляра; в противном случае — значение false.true if obj is an instance of Double and equals the value of this instance; otherwise, false.

Комментарии

Метод Equals следует использовать с осторожностью, так как два вероятно эквивалентных значения могут быть неравными из-за разной точности этих двух значений.The Equals method should be used with caution, because two apparently equivalent values can be unequal due to the differing precision of the two values. В следующем примере сообщается, что значение Double.3333 и Double, возвращаемые делением 1 на 3, не равны.The following example reports that the Double value .3333 and the Double returned by dividing 1 by 3 are unequal.

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

Альтернативные варианты вызова метода Equals см. в документации по перегрузке Equals(Double).For alternatives to calling the Equals method, see the documentation for the Equals(Double) overload.

Примечание

Поскольку Epsilon определяет минимальное выражение для положительного значения, чей диапазон близок к нулю, поле разности между двумя похожими значениями должно быть больше Epsilon.Because Epsilon defines the minimum expression of a positive value whose range is near zero, the margin of difference between two similar values must be greater than Epsilon. Как правило, число раз больше Epsilon.Typically, it is many times greater than Epsilon.

Точность чисел с плавающей запятой, превышающих задокументированную точность, зависит от реализации и версии .NET Framework.The precision of floating-point numbers beyond the documented precision is specific to the implementation and version of the .NET Framework. Следовательно, сравнение двух определенных чисел может измениться между версиями .NET Framework, так как точность внутреннего представления чисел может измениться.Consequently, a comparison of two particular numbers might change between versions of the .NET Framework because the precision of the numbers' internal representation might change.

Если два значения Double.NaN проверяются на равенство путем вызова метода Equals, метод возвращает true.If two Double.NaN values are tested for equality by calling the Equals method, the method returns true. Однако если два значения NaN проверяются на равенство с помощью оператора равенства, оператор возвращает false.However, if two NaN values are tested for equality by using the equality operator, the operator returns false. Если необходимо определить, является ли значение Double нечисловым (NaN), можно также вызвать метод IsNaN.When you want to determine whether the value of a Double is not a number (NaN), an alternative is to call the IsNaN method.

Примечания для тех, кто вызывает этот метод

Разрешение перегрузки компилятора может учитывать очевидную разницу в поведении двух перегрузок метода Equals(Object).Compiler overload resolution may account for an apparent difference in the behavior of the two Equals(Object) method overloads. Если неявное преобразование между аргументом obj и Double определено и аргумент не типизирован как Object, компиляторы могут выполнить неявное преобразование и вызвать метод Equals(Double).If an implicit conversion between the obj argument and a Double is defined and the argument is not typed as an Object, compilers may perform an implicit conversion and call the Equals(Double) method. В противном случае они вызывают метод Equals(Object), который всегда возвращает false, если его аргумент obj не является значением Double.Otherwise, they call the Equals(Object) method, which always returns false if its obj argument is not a Double value. В следующем примере показано различие в поведении между двумя перегрузками метода.The following example illustrates the difference in behavior between the two method overloads. В случае со всеми примитивными числовыми типами, за исключением @no__t- C#0 и в, первое сравнение возвращает true, так как компилятор автоматически выполняет расширяющее преобразование и вызывает метод Equals(Double), тогда как второе сравнение возвращает false. так как компилятор вызывает метод Equals(Object).In the case of all primitive numeric types except for Decimal and in C#, the first comparison returns true because the compiler automatically performs a widening conversion and calls the Equals(Double) method, whereas the second comparison returns false because the compiler calls the Equals(Object) method.

[! код-CSharpSystem. Double. Equals # 2] [! код-VBSystem. Double. Equals # 2][!code-csharpSystem.Double.Equals#2] [!code-vbSystem.Double.Equals#2]

Дополнительно

Применяется к