Single.Equals Single.Equals Single.Equals Single.Equals Method

Определение

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

Перегрузки

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

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

Equals(Single) Equals(Single) Equals(Single) Equals(Single)

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

Equals(Object) Equals(Object) Equals(Object) 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 Object Object Object

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

Возвраты

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

Примеры

В следующем примере кода демонстрируется Equals метод.The following code example demonstrates the Equals method.

obj1 = (Single)500;

if ( a.Equals( obj1 ) )
{
   Console::WriteLine( "The value type and reference type values are equal." );
}
obj1 = (Single)500;
if (a.Equals(obj1)) {
    Console.WriteLine("The value type and reference type values are equal.");
}
Obj1 = CType(500, Single)

If A.Equals(Obj1) Then
    Console.WriteLine("The value type and reference type values are equal.")
End If

Комментарии

Этот 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. В следующем примере сообщается, Single что значение. 3333 Single и возвращенное делением 1 на 3 не равны.The following example reports that the Single value .3333 and the Single returned by dividing 1 by 3 are unequal.

// Initialize two floats with apparently identical values
float float1 = .33333f;
object float2 = 1/3;
// Compare them for equality
Console.WriteLine(float1.Equals(float2));    // displays false
' Initialize two singles with apparently identical values
Dim single1 As Single = .33333
Dim single2 As Object = 1/3
' Compare them for equality
Console.WriteLine(single1.Equals(single2))    ' displays False

Вместо сравнения на равенство, одним из рекомендуемых способов является определение приемлемого поля разности между двумя значениями (например, .01% одного из значений).Rather than comparing for equality, one recommended technique involves defining an acceptable margin of difference between two values (such as .01% 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, два Single значения которых в предыдущем примере кода не совпадают.The following example uses this technique to compare .33333 and 1/3, the two Single values that the previous code example found to be unequal.

// Initialize two floats with apparently identical values
float float1 = .33333f;
object float2 = (float) 1/3;
// Define the tolerance for variation in their values
float difference = Math.Abs(float1 * .0001f);

// Compare the values
// The output to the console indicates that the two values are equal
if (Math.Abs(float1 - (float) float2) <= difference)
   Console.WriteLine("float1 and float2 are equal.");
else
   Console.WriteLine("float1 and float2 are unequal.");
' Initialize two singles with apparently identical values
Dim single1 As Single = .33333
Dim single2 As Object = 1/3
' Define the tolerance for variation in their values
Dim difference As Single = Math.Abs(single1 * .0001f)

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

В этом случае значения равны.In this case, the values are equal.

Примечание

Поскольку Epsilon определяет минимальное выражение положительного значения, чей диапазон близок к нулю, поле разности должно быть Epsilonбольше.Because Epsilon defines the minimum expression of a positive value whose range is near zero, the margin of difference 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.

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

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

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

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

Equals(Single) Equals(Single) Equals(Single) Equals(Single)

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

public:
 virtual bool Equals(float obj);
public bool Equals (float obj);
override this.Equals : single -> bool
Public Function Equals (obj As Single) As Boolean

Параметры

obj
Single Single Single Single

Объект для сравнения с данным экземпляром.An object to compare with 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 an 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.

Например, предположим, что тип экземпляра — Single , а тип параметра — Int32.For example, suppose the instance type is Single and the parameter type is Int32. Компилятор Microsoft C# создает инструкции для представления значения параметра в виде Single объекта, Single.Equals(Single) а затем создает метод, который сравнивает значения экземпляра и расширенное представление параметра.The Microsoft C# compiler generates instructions to represent the value of the parameter as a Single object, and then generates a Single.Equals(Single) 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 because of the differing precision of the two values. В следующем примере сообщается, Single что значение. 3333 Single и возвращенное делением 1 на 3 не равны.The following example reports that the Single value .3333 and the Single returned by dividing 1 by 3 are unequal.

// Initialize two floats with apparently identical values
float float1 = .33333f;
float float2 = 1/3;
// Compare them for equality
Console.WriteLine(float1.Equals(float2));    // displays false
' Initialize two singles with apparently identical values
Dim single1 As Single = .33333
Dim single2 As Single = 1/3
' Compare them for equality
Console.WriteLine(single1.Equals(single2))    ' displays False

Одна методика сравнения, которая позволяет избежать проблем, связанных с сравнением на равенство, заключается в определении приемлемого поля разности между двумя значениями (например, .01% одного из значений).One comparison technique that avoids the problems associated with comparing for equality involves defining an acceptable margin of difference between two values (such as .01% 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 an outcome of differences in precision and, therefore, the values are likely to be equal. В следующем примере этот метод используется для сравнения значений. 33333 и 1/3, которые представляют собой Single два значения, которые в предыдущем примере кода не совпадают.The following example uses this technique to compare .33333 and 1/3, which are the two Single values that the previous code example found to be unequal.

// Initialize two floats with apparently identical values
float float1 = .33333f;
float float2 = (float) 1/3;
// Define the tolerance for variation in their values
float difference = Math.Abs(float1 * .0001f);

// Compare the values
// The output to the console indicates that the two values are equal
if (Math.Abs(float1 - float2) <= difference)
   Console.WriteLine("float1 and float2 are equal.");
else
   Console.WriteLine("float1 and float2 are unequal.");
' Initialize two singles with apparently identical values
Dim single1 As Single = .33333
Dim single2 As Single = 1/3
' Define the tolerance for variation in their values
Dim difference As Single = Math.Abs(single1 * .0001f)

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

В этом случае значения равны.In this case, the values are equal.

Примечание

Поскольку Epsilon определяет минимальное выражение положительного значения, чей диапазон близок к нулю, поле разности должно быть Epsilonбольше.Because Epsilon defines the minimum expression of a positive value whose range is near zero, the margin of difference 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 that avoids the problems associated with comparing for equality 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 way to do this is to arbitrarily select an absolute value. Однако это проблематично, поскольку приемлемое поле разности зависит от величины Single значений.However, this is problematic, because an acceptable margin of difference depends on the magnitude of the Single values. Второй способ использует преимущества функции проектирования в формате с плавающей запятой: Разница между компонентами мантисса в целочисленных представлениях двух значений с плавающей запятой указывает на количество возможных значений с плавающей запятой, разделяющих эти два значения.A second way takes advantage of a design feature of the floating-point format: The difference between the mantissa components in the integer representations of two floating-point values indicates the number of possible floating-point values that separates the two values. Например, разница между 0,0 и Epsilon равно 1, поскольку Epsilon — это наименьшее значение, которое может быть представлено при работе Single с, значение которого равно нулю.For example, the difference between 0.0 and Epsilon is 1, because Epsilon is the smallest representable value when working with a Single whose value is zero. В следующем примере этот метод используется для сравнения значений. 33333 и 1/3, которые являются двумя Double значениями, приведенными в предыдущем примере кода Equals(Single) с методом, не равным.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(Single) method found to be unequal. Обратите внимание, что в BitConverter.GetBytes примере BitConverter.ToInt32 используются методы и для преобразования значения с плавающей запятой одиночной точности в целочисленное представление.Note that the example uses the BitConverter.GetBytes and BitConverter.ToInt32 methods to convert a single-precision floating-point value to its integer representation.

using System;

public class Example
{
   public static void Main()
   {
      float value1 = .1f * 10f;
      float value2 = 0f;
      for (int ctr = 0; ctr < 10; ctr++)
         value2 += .1f;
         
      Console.WriteLine("{0:R} = {1:R}: {2}", value1, value2,
                        HasMinimalDifference(value1, value2, 1));
   }

   public static bool HasMinimalDifference(float value1, float value2, int units)
   {
      byte[] bytes = BitConverter.GetBytes(value1);
      int iValue1 = BitConverter.ToInt32(bytes, 0);
      
      bytes = BitConverter.GetBytes(value2);
      int iValue2 = BitConverter.ToInt32(bytes, 0);
      
      // If the signs are different, return false except for +0 and -0.
      if ((iValue1 >> 31) != (iValue2 >> 31))
      {
         if (value1 == value2)
            return true;
          
         return false;
      }

      int diff = Math.Abs(iValue1 - iValue2);

      if (diff <= units)
         return true;

      return false;
   }
}
// The example displays the following output:
//        1 = 1.00000012: True
Module Example
   Public Sub Main()
      Dim value1 As Single = .1 * 10
      Dim value2 As Single = 0
      For ctr As Integer =  0 To 9
         value2 += CSng(.1)
      Next
               
      Console.WriteLine("{0:R} = {1:R}: {2}", value1, value2,
                        HasMinimalDifference(value1, value2, 1))
   End Sub

   Public Function HasMinimalDifference(value1 As Single, value2 As Single, units As Integer) As Boolean
      Dim bytes() As Byte = BitConverter.GetBytes(value1)
      Dim iValue1 As Integer =  BitConverter.ToInt32(bytes, 0)
      
      bytes = BitConverter.GetBytes(value2)
      Dim iValue2 As Integer =  BitConverter.ToInt32(bytes, 0)
      
      ' If the signs are different, Return False except for +0 and -0.
      If ((iValue1 >> 31) <> (iValue2 >> 31)) Then
         If value1 = value2 Then
            Return True
         End If           
         Return False
      End If

      Dim diff As Integer =  Math.Abs(iValue1 - iValue2)

      If diff <= units Then
         Return True
      End If

      Return False
   End Function
End Module
' The example displays the following output:
'       1 = 1.00000012: 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 numbers might produce different results depending on the version of the .NET Framework, because the precision of the numbers' internal representation might change.

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

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

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

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

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