Double.Equals メソッド

定義

Double の 2 つのインスタンスが同じ値を表しているかどうかを示す値を返します。

オーバーロード

Equals(Double)

このインスタンスと指定した Double オブジェクトが同じ値を表しているかどうかを示す値を返します。

Equals(Object)

このインスタンスが指定されたオブジェクトに等しいかどうかを示す値を返します。

Equals(Double)

このインスタンスと指定した Double オブジェクトが同じ値を表しているかどうかを示す値を返します。

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 オブジェクト。

戻り値

Boolean

obj がこのインスタンスと等しい場合は true。それ以外の場合は false

実装

注釈

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

拡大変換

プログラミング言語によっては、 Equals パラメーターの型がインスタンスの型よりも少ない (幅が狭い) メソッドをコーディングすることができます。 これが可能なのは、一部のプログラミング言語では、インスタンスと同数のビットを持つ型として、パラメーターを表す暗黙的な拡大変換が実行されるためです。

たとえば、インスタンスの型がで、 Double パラメーターの型がであるとし Int32 ます。 Microsoft C# コンパイラは、パラメーターの値をオブジェクトとして表す命令を生成 Double し、 Double.Equals(Double) インスタンスの値とパラメーターの拡張された表現を比較するメソッドを生成します。

プログラミング言語のドキュメントを参照して、コンパイラが数値型の暗黙的な拡大変換を実行するかどうかを判断します。 詳細については、「 型変換の表 」を参照してください。

比較における精度

2つ Equals の値の有効桁数が異なるため、2つの意味のある値が等しくない可能性があるため、メソッドは注意して使用する必要があります。 次の例では、 Double Double 1 を3で除算して返される値333333と値が等しくないことを報告しています。

// Initialize two doubles with apparently identical values
double double1 = .33333;
double double2 = (double) 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% など)。 2つの値の差の絶対値がその余白以下の場合は、精度の違いによって違いが生じる可能性が高いため、値が等しい可能性があります。 次の例では、この手法を使用して、33333と1/3 を比較しています。これは、前のコード例の2つの値が等しくないことを示してい Double ます。 この場合、値は等しいと見なされます。

// 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 。 通常、よりも多くの時間がかかり Epsilon ます。 このため、 Epsilon 値が等しいかどうかを比較する場合は、を使用しないことをお勧め Double します。

2番目の手法では、2つの浮動小数点数の差を絶対値で比較します。 差分値がその絶対値以下の場合、数値は等しいと見なされます。 値が大きい場合、数値は等しくありません。 別の方法として、絶対値を任意に選択する方法があります。 ただし、これは問題になります。これは、許容される差分が値の大きさに依存するためです Double 。 2番目の代替手段は、浮動小数点形式のデザイン機能を利用します。2つの浮動小数点値の整数表現の差は、浮動小数点値を区切る可能性のある浮動小数点値の数を示します。 たとえば、の Epsilon Epsilon 値が0のを操作する場合、が最も小さい表現可能な値であるため、0.0 との差は1になり Double ます。 次の例では、この手法を使用して、33333と1/3 を比較しています。これは、 Double 前のコード例では、 Equals(Double) メソッドが等しくないと判明した2つの値です。 この例では、メソッドを使用して、 BitConverter.DoubleToInt64Bits 倍精度浮動小数点値を整数表現に変換します。

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:
//        1 = 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 の実装とバージョンに固有です。 その結果、数値の内部表現の有効桁数が変更される可能性があるため、2つの特定の数値の比較が .NET Framework のバージョン間で変わる可能性があります。

2つの Double.NaN 値がメソッドを呼び出すことによって等しいかどうかをテストする場合 Equals 、メソッドはを返し true ます。 ただし、等値 NaN 演算子を使用して2つの値が等しいかどうかをテストする場合、演算子はを返し false ます。 の値 Double が非数 (NaN) であるかどうかを判断するには、メソッドを呼び出す方法があり IsNaN ます。

注意 (呼び出し元)

コンパイラのオーバーロードの解決では、2つのメソッドオーバーロードの動作の明らかな違いを考慮することができ Equals(Object) ます。 引数との間の暗黙の変換が定義されていて、 obj Double 引数がとして型指定されていない場合 Object 、コンパイラは暗黙的な変換を実行し、メソッドを呼び出すことができ Equals(Double) ます。 それ以外の場合は、メソッドを呼び出します。このメソッドは、 Equals(Object) false obj 引数が値でない場合は常にを返し Double ます。 次の例は、2つのメソッドオーバーロード間の動作の違いを示しています。 C# のおよびを除くすべてのプリミティブ数値型の場合、 Decimal true コンパイラは自動的に拡大変換を実行し、メソッドを呼び出し Equals(Double) ます。一方、2番目の比較では、 false コンパイラがメソッドを呼び出すため、が返され Equals(Object) ます。

using System;

public class Example
{
   static double value = 112;

   public static void Main()
   {
      byte byte1= 112;
      Console.WriteLine("value = byte1: {0,16}", value.Equals(byte1));
      TestObjectForEquality(byte1);

      short short1 = 112;
      Console.WriteLine("value = short1: {0,16}", value.Equals(short1));
      TestObjectForEquality(short1);

      int int1 = 112;
      Console.WriteLine("value = int1: {0,18}", value.Equals(int1));
      TestObjectForEquality(int1);

      long long1 = 112;
      Console.WriteLine("value = long1: {0,17}", value.Equals(long1));
      TestObjectForEquality(long1);

      sbyte sbyte1 = 112;
      Console.WriteLine("value = sbyte1: {0,16}", value.Equals(sbyte1));
      TestObjectForEquality(sbyte1);

      ushort ushort1 = 112;
      Console.WriteLine("value = ushort1: {0,16}", value.Equals(ushort1));
      TestObjectForEquality(ushort1);

      uint uint1 = 112;
      Console.WriteLine("value = uint1: {0,18}", value.Equals(uint1));
      TestObjectForEquality(uint1);

      ulong ulong1 = 112;
      Console.WriteLine("value = ulong1: {0,17}", value.Equals(ulong1));
      TestObjectForEquality(ulong1);

      decimal dec1 = 112m;
      Console.WriteLine("value = dec1: {0,21}", value.Equals(dec1));
      TestObjectForEquality(dec1);

      float sng1 = 112;
      Console.WriteLine("value = sng1: {0,19}", value.Equals(sng1));
      TestObjectForEquality(sng1);
   }

   private static void TestObjectForEquality(Object obj)
   {
      Console.WriteLine("{0} ({1}) = {2} ({3}): {4}\n",
                        value, value.GetType().Name,
                        obj, obj.GetType().Name,
                        value.Equals(obj));
   }
}
// The example displays the following output:
//       value = byte1:             True
//       112 (Double) = 112 (Byte): False
//
//       value = short1:             True
//       112 (Double) = 112 (Int16): False
//
//       value = int1:               True
//       112 (Double) = 112 (Int32): False
//
//       value = long1:              True
//       112 (Double) = 112 (Int64): False
//
//       value = sbyte1:             True
//       112 (Double) = 112 (SByte): False
//
//       value = ushort1:             True
//       112 (Double) = 112 (UInt16): False
//
//       value = uint1:               True
//       112 (Double) = 112 (UInt32): False
//
//       value = ulong1:              True
//       112 (Double) = 112 (UInt64): False
//
//       value = dec1:                 False
//       112 (Double) = 112 (Decimal): False
//
//       value = sng1:                True
//       112 (Double) = 112 (Single): False

こちらもご覧ください

適用対象

Equals(Object)

このインスタンスが指定されたオブジェクトに等しいかどうかを示す値を返します。

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

パラメーター

obj
Object

このインスタンスと比較するオブジェクト。

戻り値

Boolean

objDouble のインスタンスで、このインスタンスの値に等しい場合は true。それ以外の場合は false

注釈

2 つの値の有効桁数が異なって、明らかに等価な 2 つの値が等しくない可能性があるため、メソッドは注意して Equals 使用する必要があります。 次の例では、1 を 3 で除算して返される Double 値 .3333 と が等 Double しくないと報告しています。

// Initialize two doubles with apparently identical values
double double1 = .33333;
object double2 = (double) 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) してください。

注意

は、範囲が 0 に近い正の値の最小式を定義します。ため、類似する 2 つの値の差の余白は より Epsilon 大きくする必要があります Epsilon 。 通常は、 よりも何倍も大きくなります Epsilon

ドキュメントに記載されている有効桁数を超える浮動小数点数の有効桁数は、 の実装とバージョンに固有.NET Framework。 その結果、数値の内部表現の精度が変化する可能性.NET Frameworkのバージョン間で 2 つの特定の数値の比較が変更される可能性があります。

メソッドを Double.NaN 呼び出して 2 つの値が等しいかテストされた場合、 Equals メソッドは を返します true 。 ただし、2 つの値が等値演算子を使用して等しいかテストされた場合、演算子 NaN は を返します false 。 の値が数値 (NaN) ではないかどうかを判断する場合は、 メソッドを呼び出す Double 方法 IsNaN があります。

注意 (呼び出し元)

コンパイラオーバーロードの解決は、2 つのメソッド オーバーロードの動作の明らかな違い Equals(Object) を考慮する可能性があります。 引数と の間の暗黙的な変換が定義され、引数が として型指定されていない場合、コンパイラは暗黙的な変換を実行し、 obj Double Object メソッドを呼び出 Equals(Double) す可能性があります。 それ以外の場合は、 メソッドを呼び出します。このメソッドは、引数が値でない場合 Equals(Object) false obj は常に を返 Double します。 次の例は、2 つのメソッド オーバーロードの動作の違いを示しています。 C# の と を除くすべてのプリミティブ数値型の場合、コンパイラは拡大変換を自動的に実行し、 メソッドを呼び出すのに対し、2 番目の比較は メソッドを呼び出すので、 を返します。 Decimal true Equals(Double) false Equals(Object)

こちらもご覧ください

適用対象