Double.Equals メソッド

定義

Double の 2 つのインスタンスが同じ値を表しているかどうかを示す値を返します。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。それ以外の場合は 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 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

2つの値の有効桁数が異なるため、2つの意味のある値は等しくない可能性があるため、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と、1を3で割ることによって返される Double 値が等しくないことを報告しています。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

1つの手法では、等しいかどうかを比較するのではなく、2つの値の差に許容される相対余白を定義します (1 つの値の .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). 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と1/3 を比較しています。これは、前のコード例の2つの 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 は、範囲がゼロ付近の正の値の最小式を定義するため、2つの類似する値の差の余白は 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. このため、Double 値が等しいかどうかを比較する場合は、Epsilon を使用しないことをお勧めします。Because of this, we recommend that you do not use Epsilon when comparing Double values for equality.

2番目の手法では、2つの浮動小数点数の差を絶対値で比較します。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. 2番目の代替手段は、浮動小数点形式のデザイン機能を利用します。2つの浮動小数点値の整数表現の差は、浮動小数点値を区切る可能性のある浮動小数点値の数を示します。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です。これは、値がゼロである Double を操作するときに、Epsilon が最も小さい表現可能な値であるためです。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 を比較しています。これは、前のコード例で Equals(Double) メソッドを使用した場合と等しくないことが判明した2つの 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. その結果、数値の内部表現の有効桁数が変更される可能性があるため、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.

Equals メソッドを呼び出すことによって2つの Double.NaN 値が等しいかどうかをテストした場合、メソッドは trueを返します。If two Double.NaN values are tested for equality by calling the Equals method, the method returns true. ただし、等値演算子を使用して2つの 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.

注意 (呼び出し元)

コンパイラのオーバーロードの解決では、2つの 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) メソッドを呼び出します。このメソッドは、obj 引数が Double 値でない場合は常に false を返します。Otherwise, they call the Equals(Object) method, which always returns false if its obj argument is not a Double value. 次の例は、2つのメソッドオーバーロード間の動作の違いを示しています。The following example illustrates the difference in behavior between the two method overloads. Decimal とのを除くすべてのプリミティブ数値型の場合C#、コンパイラは、自動的に拡大変換を実行して Equals(Double) メソッドを呼び出します。一方、2番目の false 比較では、コンパイラが Equals(Object) メソッドを呼び出すため、true が返されます。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.

[! code-csharp# 2][! code-vb system.string# 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.

戻り値

trueobj のインスタンスで、このインスタンスの値に等しい場合は Double。それ以外の場合は falsetrue if obj is an instance of Double and equals the value of this instance; otherwise, false.

注釈

2つの値の有効桁数が異なるため、2つの意味のある値は等しくない可能性があるため、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と、1を3で除算して返された Double が等しくないことを報告しています。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 は、範囲がゼロ付近の正の値の最小式を定義するため、2つの類似する値の差の余白は 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. その結果、数値の内部表現の有効桁数が変更される可能性があるため、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.

Equals メソッドを呼び出すことによって2つの Double.NaN 値が等しいかどうかをテストした場合、メソッドは trueを返します。If two Double.NaN values are tested for equality by calling the Equals method, the method returns true. ただし、等値演算子を使用して2つの 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.

注意 (呼び出し元)

コンパイラのオーバーロードの解決では、2つの 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) メソッドを呼び出します。このメソッドは、obj 引数が Double 値でない場合は常に false を返します。Otherwise, they call the Equals(Object) method, which always returns false if its obj argument is not a Double value. 次の例は、2つのメソッドオーバーロード間の動作の違いを示しています。The following example illustrates the difference in behavior between the two method overloads. Decimal とのを除くすべてのプリミティブ数値型の場合C#、コンパイラは、自動的に拡大変換を実行して Equals(Double) メソッドを呼び出します。一方、2番目の false 比較では、コンパイラが Equals(Object) メソッドを呼び出すため、true が返されます。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.

[! code-csharp# 2][! code-vb system.string# 2][!code-csharpSystem.Double.Equals#2] [!code-vbSystem.Double.Equals#2]

こちらもご覧ください

適用対象