IEquatable<T>.Equals(T) メソッド

リファレンス

定義

名前空間:: System

アセンブリ:: System.Runtime.dll

アセンブリ:: mscorlib.dll

アセンブリ:: netstandard.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

現在のオブジェクトが、同じ型の別のオブジェクトと等しいかどうかを示します。

public:
 bool Equals(T other);

public bool Equals (T other);

public bool Equals (T? other);

abstract member Equals : 'T -> bool

Public Function Equals (other As T) As Boolean

パラメーター

other: T

このオブジェクトと比較するオブジェクト。

戻り値

Boolean

現在のオブジェクトが other パラメーターと等しい場合は true、それ以外の場合は false です。

例

次の例は、2 つのプロパティをPerson実装し、持つクラスの部分的な実装IEquatable<T>を示していますSSN。 LastName このメソッドはEquals、2 つのPersonオブジェクトのプロパティが同一の場合SSNは返Trueします。それ以外の場合は、値を返しますFalse。

using System;
using System.Collections.Generic;
using System.Text.RegularExpressions;

public class Person : IEquatable<Person>
{
   private string uniqueSsn;
   private string lName;

   public Person(string lastName, string ssn)
   {
      if (Regex.IsMatch(ssn, @"\d{9}"))
        uniqueSsn = $"{ssn.Substring(0, 3)}-{ssn.Substring(3, 2)}-{ssn.Substring(5, 4)}";
      else if (Regex.IsMatch(ssn, @"\d{3}-\d{2}-\d{4}"))
         uniqueSsn = ssn;
      else
         throw new FormatException("The social security number has an invalid format.");

      this.LastName = lastName;
   }

   public string SSN
   {
      get { return this.uniqueSsn; }
   }

   public string LastName
   {
      get { return this.lName; }
      set {
         if (String.IsNullOrEmpty(value))
            throw new ArgumentException("The last name cannot be null or empty.");
         else
            this.lName = value;
      }
   }

   public bool Equals(Person other)
   {
      if (other == null)
         return false;

      if (this.uniqueSsn == other.uniqueSsn)
         return true;
      else
         return false;
   }

   public override bool Equals(Object obj)
   {
      if (obj == null)
         return false;

      Person personObj = obj as Person;
      if (personObj == null)
         return false;
      else
         return Equals(personObj);
   }

   public override int GetHashCode()
   {
      return this.SSN.GetHashCode();
   }

   public static bool operator == (Person person1, Person person2)
   {
      if (((object)person1) == null || ((object)person2) == null)
         return Object.Equals(person1, person2);

      return person1.Equals(person2);
   }

   public static bool operator != (Person person1, Person person2)
   {
      if (((object)person1) == null || ((object)person2) == null)
         return ! Object.Equals(person1, person2);

      return ! (person1.Equals(person2));
   }
}

open System
open System.Text.RegularExpressions

type Person(lastName, ssn) =
    let mutable lastName = lastName
    let ssn = 
        if Regex.IsMatch(ssn, @"\d{9}") then
            $"{ssn.Substring(0, 3)}-{ssn.Substring(3, 2)}-{ssn.Substring(5, 4)}"
        elif Regex.IsMatch(ssn, @"\d{3}-\d{2}-\d{4}") then
            ssn
        else
            raise (FormatException "The social security number has an invalid format.")

    member _.SSN =
        ssn

    member _.LastName
        with get () = lastName
        and set (value) =
            if String.IsNullOrEmpty value then
                invalidArg (nameof value) "The last name cannot be null or empty."
            else
                lastName <- value

    static member op_Equality (person1: Person, person2: Person) =
        if box person1 |> isNull || box person2 |> isNull then
            Object.Equals(person1, person2)
        else
            person1.Equals person2

    static member op_Inequality (person1: Person, person2: Person) =
        if box person1 |> isNull || box person2 |> isNull then
            Object.Equals(person1, person2) |> not
        else
            person1.Equals person2 |> not

    override _.GetHashCode() =
        ssn.GetHashCode()

    override this.Equals(obj: obj) =
        match obj with 
        | :? Person as personObj ->
            (this :> IEquatable<_>).Equals personObj
        | _ -> false

    interface IEquatable<Person> with
        member this.Equals(other: Person) =
            match box other with 
            | null -> false
            | _ ->
                this.SSN = other.SSN

Imports System.Collections.Generic
Imports System.Text.RegularExpressions

Public Class Person : Implements IEquatable(Of Person)
   Private uniqueSsn As String
   Private lName As String
   
   Public Sub New(lastName As String, ssn As String)
      If Regex.IsMatch(ssn, "\d{9}") Then
         uniqueSsn = $"{ssn.Substring(0, 3)}-{ssn.Substring(3, 2)}-{ssn.Substring(5, 4)}"
      ElseIf Regex.IsMatch(ssn, "\d{3}-\d{2}-\d{4}") Then
         uniqueSsn = ssn
      Else 
         Throw New FormatException("The social security number has an invalid format.")
      End If
      Me.LastName = lastName
   End Sub
   
   Public ReadOnly Property SSN As String
      Get
         Return Me.uniqueSsn
      End Get      
   End Property
   
   Public Property LastName As String
      Get
         Return Me.lName
      End Get
      Set
         If String.IsNullOrEmpty(value) Then
            Throw New ArgumentException("The last name cannot be null or empty.")
         Else
            lname = value
         End If   
      End Set
   End Property
   
   Public Overloads Function Equals(other As Person) As Boolean _
                   Implements IEquatable(Of Person).Equals
      If other Is Nothing Then Return False
      
      If Me.uniqueSsn = other.uniqueSsn Then
         Return True
      Else
         Return False
      End If
   End Function

   Public Overrides Function Equals(obj As Object) As Boolean
      If obj Is Nothing Then Return False
      
      Dim personObj As Person = TryCast(obj, Person)
      If personObj Is Nothing Then
         Return False
      Else   
         Return Equals(personObj)   
      End If
   End Function   
   
   Public Overrides Function GetHashCode() As Integer
      Return Me.SSN.GetHashCode()
   End Function
   
   Public Shared Operator = (person1 As Person, person2 As Person) As Boolean
      If person1 Is Nothing OrElse person2 Is Nothing Then
         Return Object.Equals(person1, person2)
      End If
         
      Return person1.Equals(person2)
   End Operator
   
   Public Shared Operator <> (person1 As Person, person2 As Person) As Boolean
      If person1 Is Nothing OrElse person2 Is Nothing Then
         Return Not Object.Equals(person1, person2) 
      End If
      
      Return Not person1.Equals(person2)
   End Operator
End Class

Person 次の例に示すように、オブジェクトを List<T> オブジェクトに格納し、メソッドで Contains 識別できます。

public class TestIEquatable
{
   public static void Main()
   {
      // Create a Person object for each job applicant.
      Person applicant1 = new Person("Jones", "099-29-4999");
      Person applicant2 = new Person("Jones", "199-29-3999");
      Person applicant3 = new Person("Jones", "299-49-6999");

      // Add applicants to a List object.
      List<Person> applicants = new List<Person>();
      applicants.Add(applicant1);
      applicants.Add(applicant2);
      applicants.Add(applicant3);

       // Create a Person object for the final candidate.
       Person candidate = new Person("Jones", "199-29-3999");
       if (applicants.Contains(candidate))
          Console.WriteLine("Found {0} (SSN {1}).",
                             candidate.LastName, candidate.SSN);
      else
         Console.WriteLine("Applicant {0} not found.", candidate.SSN);

      // Call the shared inherited Equals(Object, Object) method.
      // It will in turn call the IEquatable(Of T).Equals implementation.
      Console.WriteLine("{0}({1}) already on file: {2}.",
                        applicant2.LastName,
                        applicant2.SSN,
                        Person.Equals(applicant2, candidate));
   }
}
// The example displays the following output:
//       Found Jones (SSN 199-29-3999).
//       Jones(199-29-3999) already on file: True.

// Create a Person object for each job applicant.
let applicant1 = Person("Jones", "099-29-4999")
let applicant2 = Person("Jones", "199-29-3999")
let applicant3 = Person("Jones", "299-49-6999")

// Add applicants to a List object.
let applicants = ResizeArray()
applicants.Add applicant1
applicants.Add applicant2
applicants.Add applicant3

// Create a Person object for the final candidate.
let candidate = Person("Jones", "199-29-3999")
if applicants.Contains candidate then
    printfn $"Found {candidate.LastName} (SSN {candidate.SSN})."
else
    printfn $"Applicant {candidate.SSN} not found."

// Call the shared inherited Equals(Object, Object) method.
// It will in turn call the IEquatable<T>.Equals implementation.
printfn $"{applicant2.LastName}({applicant2.SSN}) already on file: {Person.Equals(applicant2, candidate)}."

// The example displays the following output:
//       Found Jones (SSN 199-29-3999).
//       Jones(199-29-3999) already on file: True.

Module TestIEquatable
   Public Sub Main()
      ' Create a Person object for each job applicant.
      Dim applicant1 As New Person("Jones", "099-29-4999")
      Dim applicant2 As New Person("Jones", "199-29-3999")
      Dim applicant3 As New Person("Jones", "299-49-6999")

      ' Add applicants to a List object.
      Dim applicants As New List(Of Person)
      applicants.Add(applicant1)
      applicants.Add(applicant2)
      applicants.Add(applicant3)
      
      ' Create a Person object for the final candidate.
      Dim candidate As New Person("Jones", "199-29-3999")
      
      If applicants.Contains(candidate) Then
         Console.WriteLine("Found {0} (SSN {1}).", _
                            candidate.LastName, candidate.SSN)
      Else
         Console.WriteLine("Applicant {0} not found.", candidate.SSN)
      End If         

      ' Call the shared inherited Equals(Object, Object) method.
      ' It will in turn call the IEquatable(Of T).Equals implementation.
      Console.WriteLine("{0}({1}) already on file: {2}.", _ 
                        applicant2.LastName, _
                        applicant2.SSN, _
                        Person.Equals(applicant2, candidate)) 
   End Sub
End Module
' The example displays the following output:
'       Found Jones (SSN 199-29-3999).
'       Jones(199-29-3999) already on file: True.

注釈

メソッドの Equals 実装は、現在のオブジェクトと同じ型 Tの別のオブジェクトと等しいかどうかをテストすることを目的としています。このメソッドは Equals(T) 、次の状況で呼び出されます。

メソッドが Equals 呼び出され、引数が other 厳密に型指定された型 Tのオブジェクトである場合。 (型Tでない場合otherは、基本Object.Equals(Object)メソッドが呼び出されます。 2 つの方法のうち、 IEquatable<T>.Equals パフォーマンスが若干向上しています)。
多数のジェネリックコレクションオブジェクトの検索メソッドが呼び出されたとき。これらの型とそのメソッドの一部には、次のものが含まれます。
- メソッドの一般的なオーバーロードの BinarySearch 一部。
- クラスのList<T>検索メソッド (、、List<T>.IndexOf、List<T>.Contains(T)List<T>.LastIndexOf、List<T>.Remove、 .
- クラスの検索メソッド。次をDictionary<TKey,TValue>含みますContainsKey Remove。
- ジェネリック LinkedList<T> クラスの検索メソッド。次を含みますLinkedList<T>.Contains Remove。

つまり、クラスのオブジェクトが配列またはジェネリックコレクションオブジェクトに格納される可能性を処理するには、オブジェクトを簡単に識別して操作できるように実装 IEquatable<T> することをお勧めします。

メソッドを Equals 実装する場合は、ジェネリック型引数で指定された型に対して等価性を適切に定義します。たとえば、型引数が指定されている場合は Int32、2 つの 32 ビット符号付き整数の比較に対して等値を適切に定義します。

注意 (実装者)

実装Equals(T)する場合は、基底クラスのEquals(Object)実装をオーバーライドし、その動作がメソッドのEquals(T)動作とGetHashCode()一致するようにする必要もあります。オーバーライド Equals(Object)する場合、オーバーライドされた実装は、クラスの静的 Equals(System.Object, System.Object) メソッドの呼び出しでも呼び出されます。さらに、and op_Inequality 演算子をオーバーロードするop_Equality必要があります。これにより、等しいかどうかを確認するすべてのテストで一貫した結果が返されることが保証されます。この例で示します。

適用対象

IEquatable<T>.Equals(T) メソッド

定義

パラメーター

戻り値

例

注釈

注意 (実装者)

適用対象

その他のリソース