Object.GetHashCode メソッド

定義

既定のハッシュ関数として機能します。

public:
 virtual int GetHashCode();
public virtual int GetHashCode ();
abstract member GetHashCode : unit -> int
override this.GetHashCode : unit -> int
Public Overridable Function GetHashCode () As Integer

戻り値

Int32

現在のオブジェクトのハッシュ コード。

型とは異なる数値のハッシュコードを計算する最も簡単な方法の1つ Int32 は、単にその値を返すことです。 次の例は、構造体のこのような実装を示して Number います。

using System;

public struct Number
{
   private int n;

   public Number(int value)
   {
      n = value;
   }

   public int Value
   {
      get { return n; }
   }

   public override bool Equals(Object obj)
   {
      if (obj == null || ! (obj is Number))
         return false;
      else
         return n == ((Number) obj).n;
   }

   public override int GetHashCode()
   {
      return n;
   }

   public override string ToString()
   {
      return n.ToString();
   }
}

public class Example
{
   public static void Main()
   {
      Random rnd = new Random();
      for (int ctr = 0; ctr <= 9; ctr++) {
         int randomN = rnd.Next(Int32.MinValue, Int32.MaxValue);
         Number n = new Number(randomN);
         Console.WriteLine("n = {0,12}, hash code = {1,12}", n, n.GetHashCode());
      }
   }
}
// The example displays output like the following:
//       n =   -634398368, hash code =   -634398368
//       n =   2136747730, hash code =   2136747730
//       n =  -1973417279, hash code =  -1973417279
//       n =   1101478715, hash code =   1101478715
//       n =   2078057429, hash code =   2078057429
//       n =   -334489950, hash code =   -334489950
//       n =    -68958230, hash code =    -68958230
//       n =   -379951485, hash code =   -379951485
//       n =    -31553685, hash code =    -31553685
//       n =   2105429592, hash code =   2105429592
Public Structure Number
   Private n As Integer

   Public Sub New(value As Integer)
      n = value
   End Sub

   Public ReadOnly Property Value As Integer
      Get
         Return n
      End Get
   End Property
   
   Public Overrides Function Equals(obj As Object) As Boolean
      If obj Is Nothing OrElse Not TypeOf obj Is Number Then
         Return False
      Else
         Return n = CType(obj, Number).n
      End If
   End Function      
   
   Public Overrides Function GetHashCode() As Integer
      Return n
   End Function
   
   Public Overrides Function ToString() As String
      Return n.ToString()
   End Function
End Structure

Module Example
   Public Sub Main()
      Dim rnd As New Random()
      For ctr As Integer = 0 To 9
         Dim randomN As Integer = rnd.Next(Int32.MinValue, Int32.MaxValue)
         Dim n As New Number(randomN)
         Console.WriteLine("n = {0,12}, hash code = {1,12}", n, n.GetHashCode())
      Next
   End Sub
End Module
' The example displays output like the following:
'       n =   -634398368, hash code =   -634398368
'       n =   2136747730, hash code =   2136747730
'       n =  -1973417279, hash code =  -1973417279
'       n =   1101478715, hash code =   1101478715
'       n =   2078057429, hash code =   2078057429
'       n =   -334489950, hash code =   -334489950
'       n =    -68958230, hash code =    -68958230
'       n =   -379951485, hash code =   -379951485
'       n =    -31553685, hash code =    -31553685
'       n =   2105429592, hash code =   2105429592

多くの場合、型にはハッシュコードの生成に参加できる複数のデータフィールドがあります。 ハッシュコードを生成する方法の1つは、 XOR (eXclusive OR) 次の例に示すように、操作を使用してこれらのフィールドを結合することです。

using System;

// A type that represents a 2-D point.
public struct Point
{
    private int x;
    private int y;

    public Point(int x, int y)
    {
       this.x = x;
       this.y = y;
    }

    public override bool Equals(Object obj)
    {
       if (! (obj is Point)) return false;

       Point p = (Point) obj;
       return x == p.x & y == p.y;
    }

    public override int GetHashCode()
    {
        return x ^ y;
    }
}

public class Example
{
   public static void Main()
   {
      Point pt = new Point(5, 8);
      Console.WriteLine(pt.GetHashCode());

      pt = new Point(8, 5);
      Console.WriteLine(pt.GetHashCode());
   }
}
// The example displays the following output:
//       13
//       13
' A type that represents a 2-D point.
Public Structure Point
    Private x As Integer
    Private y As Integer

    Public Sub New(x As Integer, y As Integer)
       Me.x = x
       Me.y = y
    End Sub
    
    Public Overrides Function Equals(obj As Object) As Boolean
       If Not TypeOf obj Is Point Then Return False
       
       Dim p As Point = CType(obj, Point)
       Return x = p.x And y = p.y
    End Function
    
    Public Overrides Function GetHashCode() As Integer 
        Return x Xor y
    End Function 
End Structure 

Public Module Example
   Public Sub Main() 
      Dim pt As New Point(5, 8)
      Console.WriteLine(pt.GetHashCode())
        
      pt = New Point(8, 5)
      Console.WriteLine(pt.GetHashCode())
   End Sub 
End Module

前の例では、(n1, n2) と (n2, n1) に対して同じハッシュコードが返されるため、望ましいよりも多くの衝突が発生する可能性があります。 これらのケースのハッシュコードが同一でないように、いくつかのソリューションを利用できます。 1つは、 Tuple 各フィールドの順序を反映するオブジェクトのハッシュコードを返すことです。 クラスを使用する実装の例を次に示し Tuple<T1,T2> ます。 ただし、オブジェクトのインスタンス化のパフォーマンスオーバーヘッドが、 Tuple ハッシュテーブルに多数のオブジェクトを格納するアプリケーションの全体的なパフォーマンスに大きな影響を与える可能性があることに注意してください。

using System;

public struct Point
{
    private int x;
    private int y;

    public Point(int x, int y)
    {
       this.x = x;
       this.y = y;
    }

    public override bool Equals(Object obj)
    {
        if (obj is Point)
        {
            Point p = (Point) obj;
            return x == p.x & y == p.y;
        }
        else
        {
            return false;
        }      
    }

    public override int GetHashCode()
    {
        return Tuple.Create(x, y).GetHashCode();
    }
}

public class Example
{
   public static void Main()
   {
        Point pt = new Point(5, 8);
        Console.WriteLine(pt.GetHashCode());

        pt = new Point(8, 5);
        Console.WriteLine(pt.GetHashCode());
   }
}
// The example displays the following output:
//       173
//       269
Public Structure Point
    Private x As Integer
    Private y As Integer

    Public Sub New(x As Integer, y As Integer)
       Me.x = x
       Me.y = y
    End Sub
    
    Public Overrides Function Equals(obj As Object) As Boolean
       If Not TypeOf obj Is Point Then Return False
       
       Dim p As Point = CType(obj, Point)
       Return x = p.x And y = p.y
    End Function
    
    Public Overrides Function GetHashCode() As Integer 
        Return Tuple.Create(x, y).GetHashCode()
    End Function 
End Structure 

Public Module Example
    Public Sub Main() 
        Dim pt As New Point(5, 8)
        Console.WriteLine(pt.GetHashCode())
        
        pt = New Point(8, 5)
        Console.WriteLine(pt.GetHashCode())
    End Sub 
End Module         
' The example displays the following output:
'       173
'       269

2つ目の代替ソリューションでは、連続するフィールドのハッシュコードを2つ以上のビットで左にシフトすることで、個々のハッシュコードを重み付けします。 理想的には、ビット31を超えてシフトされたビットは、破棄されるのではなく、ラップする必要があります。 ビットは C# と Visual Basic の両方の左シフト演算子によって破棄されるため、次のような左シフトアンドラップメソッドを作成する必要があります。

public int ShiftAndWrap(int value, int positions)
{
    positions = positions & 0x1F;

    // Save the existing bit pattern, but interpret it as an unsigned integer.
    uint number = BitConverter.ToUInt32(BitConverter.GetBytes(value), 0);
    // Preserve the bits to be discarded.
    uint wrapped = number >> (32 - positions);
    // Shift and wrap the discarded bits.
    return BitConverter.ToInt32(BitConverter.GetBytes((number << positions) | wrapped), 0);
}
Public Function ShiftAndWrap(value As Integer, positions As Integer) As Integer
   positions = positions And &h1F
   
   ' Save the existing bit pattern, but interpret it as an unsigned integer.
   Dim number As UInteger = BitConverter.ToUInt32(BitConverter.GetBytes(value), 0)
   ' Preserve the bits to be discarded.
   Dim wrapped AS UInteger = number >> (32 - positions)
   ' Shift and wrap the discarded bits.
   Return BitConverter.ToInt32(BitConverter.GetBytes((number << positions) Or wrapped), 0)
End Function

次の例では、この shift キーと wrap メソッドを使用して、 Point 前の例で使用した構造体のハッシュコードを計算します。

using System;

public struct Point
{
    private int x;
    private int y;

    public Point(int x, int y)
    {
       this.x = x;
       this.y = y;
    }

    public override bool Equals(Object obj)
    {
       if (!(obj is Point)) return false;

       Point p = (Point) obj;
       return x == p.x & y == p.y;
    }

    public override int GetHashCode()
    {
        return ShiftAndWrap(x.GetHashCode(), 2) ^ y.GetHashCode();
    }

    private int ShiftAndWrap(int value, int positions)
    {
        positions = positions & 0x1F;

        // Save the existing bit pattern, but interpret it as an unsigned integer.
        uint number = BitConverter.ToUInt32(BitConverter.GetBytes(value), 0);
        // Preserve the bits to be discarded.
        uint wrapped = number >> (32 - positions);
        // Shift and wrap the discarded bits.
        return BitConverter.ToInt32(BitConverter.GetBytes((number << positions) | wrapped), 0);
    }
}

public class Example
{
   public static void Main()
   {
        Point pt = new Point(5, 8);
        Console.WriteLine(pt.GetHashCode());

        pt = new Point(8, 5);
        Console.WriteLine(pt.GetHashCode());
   }
}
// The example displays the following output:
//       28
//       37
Public Structure Point
    Private x As Integer
    Private y As Integer

    Public Sub New(x As Integer, y As Integer)
       Me.x = x
       Me.y = y
    End Sub
    
    Public Overrides Function Equals(obj As Object) As Boolean
       If Not TypeOf obj Is Point Then Return False
       
       Dim p As Point = CType(obj, Point)
       Return x = p.x And y = p.y
    End Function
    
    Public Overrides Function GetHashCode() As Integer 
        Return ShiftAndWrap(x.GetHashCode(), 2) XOr y.GetHashCode()
    End Function 
    
    Private Function ShiftAndWrap(value As Integer, positions As Integer) As Integer
        positions = positions And &h1F
      
        ' Save the existing bit pattern, but interpret it as an unsigned integer.
        Dim number As UInteger = BitConverter.ToUInt32(BitConverter.GetBytes(value), 0)
        ' Preserve the bits to be discarded.
        Dim wrapped AS UInteger = number >> (32 - positions)
        ' Shift and wrap the discarded bits.
        Return BitConverter.ToInt32(BitConverter.GetBytes((number << positions) Or wrapped), 0)
    End Function
End Structure 

Module Example
   Public Sub Main()
        Dim pt As New Point(5, 8)
        Console.WriteLine(pt.GetHashCode())
        
        pt = New Point(8, 5)
        Console.WriteLine(pt.GetHashCode())
   End Sub
End Module
' The example displays the following output:
'       28
'       37

注釈

ハッシュコードは、クラス、 Dictionary<TKey,TValue> Hashtable クラス、またはクラスから派生した型など、ハッシュベースのコレクションにオブジェクトを挿入および識別するために使用される数値です DictionaryBase 。 メソッドは、 GetHashCode オブジェクトの等価性を簡単にチェックする必要があるアルゴリズムに対して、このハッシュコードを提供します。

注意

ハッシュコードをハッシュテーブルで使用する方法と、追加のハッシュコードアルゴリズムの詳細については、Wikipedia の Hash 関数 のエントリを参照してください。

等しい2つのオブジェクトが等しい場合は、そのハッシュコードが等しいことを示します。 ただし、逆は true ではありません。等値のハッシュコードでは、オブジェクトの等価性を意味しません。これは、異なる (等しくない) オブジェクトが同じハッシュコードを持つことができるためです。 さらに、.net では、メソッドの既定の実装は保証されません。また、 GetHashCode このメソッドが返す値は、さまざまなバージョンの .NET Framework や .net Core などの .net 実装と、32ビットや64ビットのプラットフォームなどのプラットフォームで異なる場合があります。 このような理由から、このメソッドの既定の実装をハッシュ用の一意のオブジェクト識別子として使用しないでください。 これには、次の2つの影響があります。

  • 等しいハッシュコードでは、オブジェクトの等価性を意味することを想定しないでください。

  • 同じオブジェクトがアプリケーションドメイン、プロセス、およびプラットフォーム間でハッシュされる可能性があるため、作成元のアプリケーションドメインの外部でハッシュコードを永続化したり、使用したりしないでください。

警告

ハッシュコードは、ハッシュテーブルに基づくコレクション内での効率的な挿入と検索を目的としています。 ハッシュコードが永続的な値ではありません。 理由:

  • ハッシュコード値をシリアル化したり、データベースに格納したりしないでください。
  • キーとしてハッシュコードを使用して、キー付きコレクションからオブジェクトを取得することは避けてください。
  • アプリケーションドメインまたはプロセス間でハッシュコードを送信しないでください。 場合によっては、プロセスごとまたはアプリケーションごとのドメインごとにハッシュコードを計算することがあります。
  • 暗号ハッシュ関数によって返される値の代わりにハッシュコードを使用しないでください。暗号化に強力なハッシュが必要な場合に使用します。 暗号化ハッシュの場合 System.Security.Cryptography.HashAlgorithm は、クラスまたはクラスから派生したクラスを使用し System.Security.Cryptography.KeyedHashAlgorithm ます。
  • 2つのオブジェクトが等しいかどうかを判断するために、ハッシュコードが等しいかどうかをテストしないでください。 (等しくないオブジェクトは、同一のハッシュコードを持つことができます)。等しいかどうかをテストするに ReferenceEquals は、メソッドまたはメソッドを呼び出し Equals ます。

メソッドは、 GetHashCode 派生型でオーバーライドできます。 GetHashCodeがオーバーライドされていない場合、参照型のハッシュコードは、 Object.GetHashCode オブジェクトの参照に基づいてハッシュコードを計算する基底クラスのメソッドを呼び出すことによって計算されます。詳細については、「」を参照してください RuntimeHelpers.GetHashCode 。 言い換えると、メソッドが返す2つのオブジェクトの ReferenceEquals true ハッシュコードが同じであるということです。 値型がオーバーライドされない場合 GetHashCodeValueType.GetHashCode 基本クラスのメソッドは、リフレクションを使用して、型のフィールドの値に基づいてハッシュコードを計算します。 言い換えると、同じ値を持つフィールドを持つ値型には、同じハッシュコードが含まれます。 オーバーライドの詳細については GetHashCode 、「継承に関する注意事項」を参照してください。

警告

メソッドをオーバーライドする場合は GetHashCode 、もオーバーライドする必要があり Equals ます (その逆も同様)。 Equals true 2 つのオブジェクトが等しいかどうかをテストするときに、オーバーライドされたメソッドがを返す場合、オーバーライドされた GetHashCode メソッドは2つのオブジェクトに対して同じ値を返す必要があります。

ハッシュテーブルのキーとして使用されているオブジェクトが、の便利な実装を提供していない場合は GetHashCodeIEqualityComparer クラスコンストラクターのいずれかのオーバーロードに実装を指定することで、ハッシュコードプロバイダーを指定でき Hashtable ます。

Windows ランタイムのメモ

Windows ランタイムのクラスでメソッドを呼び出すと、 GetHashCode オーバーライドされないクラスの既定の動作が提供され GetHashCode ます。 これは、.NET Framework が Windows ランタイムに対して提供するサポートの一部です ( Windows ストアアプリおよび Windows ランタイムの .NET Framework サポートを参照してください)。 Windows ランタイムのクラスは継承さ Object れず、現在はを実装していません GetHashCode 。 ただし、 ToString Equals(Object) C# または Visual Basic コードで使用するときは、、、およびの各メソッドがあるように見え GetHashCode ます。 .NET Framework は、これらのメソッドの既定の動作を提供します。

注意

C# または Visual Basic で記述された Windows ランタイムクラスは、メソッドをオーバーライドでき GetHashCode ます。

注意 (継承者)

ハッシュ関数は、オブジェクトの値に対応する数値 (ハッシュコード) をすばやく生成するために使用されます。 通常、ハッシュ関数はそれぞれの型に固有であり、一意性を確保するには、少なくとも1つのインスタンスフィールドを入力として使用する必要があります。 ハッシュコードは、静的フィールドの値を使用して計算することはできません。

から派生したクラスの Object 場合、メソッドは、 GetHashCode GetHashCode() 派生クラスが参照の等価性を定義する場合にのみ、基底クラスの実装にデリゲートできます。 参照型のの既定の実装では、 GetHashCode() メソッドによって返されるハッシュコードに相当するハッシュコードが返され GetHashCode(Object) ます。 変更できない GetHashCode() 参照型については、をオーバーライドできます。 一般に、変更可能な参照型の場合は、次の場合にのみオーバーライド GetHashCode() する必要があります。

  • 変更できないフィールドからハッシュ コードを計算できます。または
  • オブジェクトがハッシュ コードに依存するコレクションに含まれている間、変更可能なオブジェクトのハッシュ コードが変更されないよう保証できます。

そうしないと、変更可能なオブジェクトがハッシュ テーブルで失われると思われる場合があります。 変更可能な参照型に対して オーバーライドを選択した場合、ドキュメントでは、オブジェクトがハッシュ テーブルに格納されている間、型のユーザーがオブジェクト値を変更しなきことを明確にする GetHashCode() 必要があります。

値型の場合は GetHashCode() 、リフレクションを使用する既定のハッシュ コード実装が提供されます。 パフォーマンスを向上させるには、オーバーライドを検討する必要があります。

ハッシュ コードをさまざまな方法で計算する詳細と例については、「例」セクションを参照してください。

ハッシュ関数には、次のプロパティが必要です。

  • 2 つのオブジェクトが等しいと比較する場合、各オブジェクトの GetHashCode() メソッドは同じ値を返す必要があります。 ただし、2 つのオブジェクトが等しいと比較されない場合、2 つのオブジェクトのメソッドは異 GetHashCode() なる値を返す必要があります。

  • オブジェクト GetHashCode()System.Object.Equals メソッドの戻り値を決定するオブジェクト状態に変更がない限り、オブジェクトのメソッドは同じハッシュ コードを一貫して返す必要があります。 これは、アプリケーションの現在の実行に対する場合にのみ当てはめ、アプリケーションが再度実行された場合は別のハッシュ コードを返す可能性があります。

  • 最高のパフォーマンスを得る場合、ハッシュ関数では、大量にクラスター化された入力を含め、すべての入力に対して"等しい分布" を生成する必要があります。 これは、オブジェクトの状態を小さく変更すると、ハッシュ テーブルのパフォーマンスを最適化するために、結果として得られるハッシュ コードに大きな変更が加える必要があるという意味です。

  • ハッシュ関数は、計算に安価である必要があります。

  • メソッド GetHashCode() は例外をスローしません。

たとえば、 クラスによって提供される メソッドの実装では、同一の文字列値に対して GetHashCode() String 同じハッシュ コードが返されます。 したがって、2 つの String オブジェクトが同じ文字列値を表す場合、2 つのオブジェクトは同じハッシュ コードを返します。 また、 メソッドは、入力が特定の範囲でクラスター化されている場合でも、文字列内のすべての文字を使用して、ランダムに分散された出力を生成します (たとえば、多くのユーザーは、文字列に 65,535 文字の Unicode 文字を含めることができますが、より小さい 128 ASCII 文字のみを含む文字列を持つ場合があります)。

クラスに優れたハッシュ関数を提供すると、それらのオブジェクトをハッシュ テーブルに追加するパフォーマンスに大きく影響する可能性があります。 ハッシュ関数の優れた実装を提供するキーを持つハッシュ テーブルでは、要素の検索には一定の時間がかかる (O(1) 演算など)。 ハッシュ関数の実装が不十分なハッシュ テーブルでは、検索のパフォーマンスはハッシュ テーブル内の項目の数によって異なります (たとえば、O( ) 操作。ここで、 はハッシュ テーブル内の項目の数 n n です。 悪意のあるユーザーは、競合の数を増やすデータを入力できます。これは、次の条件下で、ハッシュ テーブルに依存するアプリケーションのパフォーマンスを大幅に低下させる可能性があります。

  • ハッシュ関数によって頻繁に競合が発生する場合。

  • ハッシュ テーブル内のオブジェクトの大部分が、同じかほぼ等しいハッシュ コードを生成する場合。

  • ユーザーがハッシュ コードの計算に使用するデータを入力した場合。

また、 をオーバーライドする派生クラスは、 をオーバーライドして、等しいと見なされる 2 つのオブジェクトが同じハッシュ コードを持つ必要があります。そうしないと、型が正しく GetHashCode() Equals(Object) 動作しない Hashtable 可能性があります。

適用対象

こちらもご覧ください