Metoda System.Single.Equals
Ten artykuł zawiera dodatkowe uwagi dotyczące dokumentacji referencyjnej dla tego interfejsu API.
Metoda Single.Equals(Single) implementuje interfejs System.IEquatable<T> i działa nieco lepiej niż Single.Equals(Object), ponieważ 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. Jest to możliwe, ponieważ niektóre języki programowania wykonują niejawną konwersję rozszerzającą, która reprezentuje parametr jako typ z tyloma bitami co wystąpienie.
Załóżmy na przykład, że typ wystąpienia jest Single, a typ parametru to Int32. Kompilator języka Microsoft C# generuje instrukcje reprezentujące wartość parametru jako obiekt Single, a następnie generuje metodę Single.Equals(Single), która porównuje wartości wystąpienia i poszerzone reprezentacje parametru.
Zapoznaj się z dokumentacją języka programowania, aby ustalić, czy kompilator wykonuje niejawne konwersje rozszerzające typy liczbowe. Aby uzyskać więcej informacji, zobacz tabele konwersji typów .
Precyzja w porównaniach
Metoda Equals powinna być używana ostrożnie, 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 informuje, że wartość Single .3333 oraz Single, która została zwrócona przez podzielenie 1 przez 3, są nierówne.
// 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 floats with apparently identical values
let float1 = 0.33333f
let float2 = 1f / 3f
// Compare them for equality
printfn $"{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
Jedna technika porównania, która pozwala uniknąć problemów związanych z porównywaniem równości, polega na zdefiniowaniu dopuszczalnego marginesu różnicy między dwiema wartościami (takimi jak .01% 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ć wynikiem różnic w precyzji i dlatego wartości mogą być równe. W poniższym przykładzie użyto tej techniki do porównania wartości 0.33333 i 1/3, które są dwiema wartościami Single, stwierdzonymi jako różne w poprzednim przykładzie kodu.
// 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 floats with apparently identical values
let float1 = 0.33333f
let float2 = 1f / 3f
// Define the tolerance for variation in their values
let difference = abs (float1 * 0.0001f)
// Compare the values
// The output to the console indicates that the two values are equal
if abs (float1 - float2) <= difference then
printfn "float1 and float2 are equal."
else
printfn "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
W takim przypadku wartości są równe.
Uwaga
Ponieważ Epsilon definiuje minimalne wyrażenie wartości dodatniej, której zakres jest zbliżony do zera, margines różnicy 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 podczas porównywania wartości Double pod kątem równości.
Druga technika, która pozwala uniknąć problemów związanych z porównywaniem równości, polega na porównaniu różnicy między dwiema liczbami zmiennoprzecinkowami 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. Jednym ze sposobów wykonania tej czynności jest arbitralne wybranie wartości bezwzględnej. Jest to jednak problematyczne, ponieważ akceptowalny margines różnicy zależy od wielkości wartości Single. Drugi sposób wykorzystuje funkcję projektową formatu zmiennoprzecinkowego: Różnica między składnikami mantissa w reprezentacjach liczb całkowitych dwóch wartości zmiennoprzecinkowych wskazuje liczbę możliwych wartości zmiennoprzecinkowych, które oddziela dwie wartości. Na przykład różnica między 0,0 a Epsilon wynosi 1, ponieważ Epsilon jest najmniejszą reprezentowalną wartością, gdy Single ma wartość zero. W poniższym przykładzie użyto tej techniki do porównania wartości 33333 i 1/3, które są dwiema wartościami Double, które zostały uznane za nierówne w poprzednim przykładzie kodu z metodą Equals(Single). Należy pamiętać, że w przykładzie użyto metod BitConverter.GetBytes i BitConverter.ToInt32 w celu przekonwertowania wartości zmiennoprzecinkowej o pojedynczej precyzji na reprezentację liczby całkowitej.
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($"{value1:R} = {value2:R}: {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
open System
let hasMinimalDifference (value1: float32) (value2: float32) units =
let bytes = BitConverter.GetBytes value1
let iValue1 = BitConverter.ToInt32(bytes, 0)
let bytes = BitConverter.GetBytes(value2)
let iValue2 = BitConverter.ToInt32(bytes, 0)
// If the signs are different, return false except for +0 and -0.
if (iValue1 >>> 31) <> (iValue2 >>> 31) then
value1 = value2
else
let diff = abs (iValue1 - iValue2)
diff <= units
let value1 = 0.1f * 10f
let value2 =
List.replicate 10 0.1f
|> List.sum
printfn $"{value1:R} = {value2:R}: {hasMinimalDifference value1 value2 1}"
// The example displays the following output:
// 1 = 1.0000001: 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
Precyzja liczb zmiennoprzecinkowych poza udokumentowaną precyzją jest specyficzna dla implementacji i wersji platformy .NET. W związku z tym porównanie dwóch liczb może generować różne wyniki w zależności od wersji platformy .NET, ponieważ precyzja wewnętrznej reprezentacji liczb może ulec zmianie.
