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

定義

Single の 2 つのインスタンスが同じ値を表しているかどうかを示す値を返します。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.

戻り値

objSingle のインスタンスで、このインスタンスの値に等しい場合は true。それ以外の場合は falsetrue 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

注釈

2 Equalsつの値の有効桁数が異なるため、2つの意味のある値が等しくない可能性があるため、メソッドは注意して使用する必要があります。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 1 を3で割るSingleことによって返された3333との値が等しくないことを報告しています。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

1つの推奨される手法は、等しいかどうかを比較するのではなく、2つの値の差に許容される余白 (1 つの値の 0.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). 2つの値の差の絶対値がその余白以下の場合は、精度の違いによって違いが生じる可能性が高いため、値が等しい可能性があります。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とSingle 1/3 を比較しています。これは、前のコード例の2つの値が等しくないことを示しています。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. その結果、数値の内部表現の有効桁数が変更される可能性があるため、2つの特定の数値の比較が .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.

注意 (呼び出し元)

コンパイラのオーバーロードの解決では、2つ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. 次の例は、2つのメソッドオーバーロード間の動作の違いを示しています。The following example illustrates the difference in behavior between the two method overloads. Visual Basic のをDouble除くすべてのプリミティブ数値型の場合trueDecimalおよびのとDoubleを除きC#、コンパイラは自動的に拡大変換を実行するため、最初の比較が返されます。とは、 Equals(Single)メソッドを呼び出します。一方、 false 2 番目の比較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.

[!code-csharpSystem.Single.Equals#2] [!code-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。それ以外の場合は falsetrue if obj is equal to this instance; otherwise, false.

実装

注釈

このメソッドは、 System.IEquatable<T>インターフェイスを実装し、 objパラメーターをEqualsオブジェクトに変換する必要がないため、より少しのパフォーマンスを発揮します。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

2つの値の有効桁数が異なるため、2つの意味のある値は等しくない可能性があるため、このメソッドは注意して使用する必要があります。EqualsThe 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 1 を3で割るSingleことによって返された3333との値が等しくないことを報告しています。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

等しいかどうかの比較に関連する問題を回避する比較手法の1つは、2つの値の差に許容される余白を定義することです (1 つの値の 0.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). 2つの値の差の絶対値がその余白以下である場合、相違点は精度の差の結果である可能性が高いため、値が等しい可能性があります。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比較しています。これは、前のコード例の2つの値が等しくないことを示しています。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.

等しいかどうかの比較に関連する問題を回避する2番目の手法では、2つの浮動小数点数の差を絶対値で比較します。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. これを行う1つの方法として、絶対値を任意に選択する方法があります。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. 2番目の方法では、浮動小数点形式のデザイン機能を利用します。2つの浮動小数点値の整数表現に含まれる仮数部分の差は、2つの値を区切る可能性のある浮動小数点値の数を示します。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のをEpsilon操作する場合、 Epsilonが最も小さい表現可能なSingle値であるため、0.0 との差は1になります。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) 、前のコード例では、メソッドが等しくないと判明した2つの値です。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.GetBytesBitConverter.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. このため、2つの数値を比較すると、.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.

注意 (呼び出し元)

コンパイラのオーバーロードの解決では、2つ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. 次の例は、2つのメソッドオーバーロード間の動作の違いを示しています。The following example illustrates the difference in behavior between the two method overloads. Visual Basic のをDouble除くすべてのプリミティブ数値型の場合trueDecimalおよびのとDoubleを除きC#、コンパイラは自動的に拡大変換を実行するため、最初の比較が返されます。とは、 Equals(Single)メソッドを呼び出します。一方、 false 2 番目の比較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.

[!code-csharpSystem.Single.Equals#2] [!code-vbSystem.Single.Equals#2][!code-csharpSystem.Single.Equals#2] [!code-vbSystem.Single.Equals#2]

こちらもご覧ください

適用対象