文書 > Swift 標準ライブラリ > Basic Behaviors > Equatable

プロトコル

Equatable

値が等しいかどうかを比較できる型。

概要

等価演算子 (==) を使用する等式または不等価演算子 (!=) を使用する不等式を使用して Equatable プロトコルに準拠する型を比較することができます。Swift 標準ライブラリのほとんどの基本型は Equatable に準拠しています。

要素が Equatable に準拠している場合、よりシンプルにシーケンスおよびコレクションの操作を使用できます。たとえば、配列に特定の値が含まれているかどうかをチェックするには、等価性を決定するクロージャを提供する代わりに、配列の要素が Equatable に準拠する場合に、値自体を contains(_:) メソッドに渡すことができます。以下の例は、文字列の配列で contains(_:) メソッドを使用する方法を示しています。

let students = ["Nora", "Fern", "Ryan", "Rainer"]

let nameToCheck = "Ryan"
if students.contains(nameToCheck) {
    print("\(nameToCheck) is signed up!")
} else {
    print("No record of \(nameToCheck).")
}
// Prints "Ryan is signed up!"

Equatable プロトコルへの準拠

カスタム型に Equatable の準拠を追加すると、コレクション内の特定のインスタンスを検索する際に、より便利な API を使用できるようになります。Equatable は、また Hashable プロトコルと Comparable プロトコルの基本プロトコルでもあり、セットの構築やコレクションの要素のソートなど、カスタム型の使用を増やすことができます。

型のオリジナルの宣言で Equatable 準拠を宣言し、型が以下の基準を満たす場合、カスタム型に対する Equatable プロトコルの要件の自動合成に頼ることができます：

構造体 (struct) の場合、格納されているすべてのプロパティは Equatable に準拠していなければなりません。

列挙型 (enum) の場合、関連するすべての値は Equatable に準拠していなければなりません。(関連した値のない enum は、宣言がなくても Equatable への準拠があります。)

型の Equatable への準拠をカスタマイズするには、上記に挙げた基準を満たさない型で Equatable を採用するか、または Equatable に準拠するように既存の型を拡張するため、等価演算子 (==) を型の静的メソッドとして実装します。標準ライブラリは、任意の Equatable 型の not-equal-to 演算子 (!=) の実装を提供します。これは、カスタムの == 関数を呼び出し、その結果を否定します。

例として、番地の住所の一部を保持する StreetAddress クラスを考えてみましょう。住宅または建物の番号、番地の名前、およびオプションのユニット番号。StreetAddress 型の最初の宣言は以下のとおりです。

class StreetAddress {
    let number: String
    let street: String
    let unit: String?

    init(_ number: String, _ street: String, unit: String? = nil) {
        self.number = number
        self.street = street
        self.unit = unit
    }
}

ここで、特定のアドレスを確認するために必要なアドレスの配列があるとします。各呼び出しのクロージャを含まずに contains(_:) メソッドを使用するには、StreetAddress 型を Equatable に準拠するように拡張します。

extension StreetAddress: Equatable {
    static func == (lhs: StreetAddress, rhs: StreetAddress) -> Bool {
        return
            lhs.number == rhs.number &&
            lhs.street == rhs.street &&
            lhs.unit == rhs.unit
    }
}

StreetAddress 型は現在 Equatable に準拠しています。== を使用して、任意の 2 つのインスタンス間の等価性をチェックするか、Equatable に強制された contains(_:) メソッドを呼び出すことができます。

let addresses = [StreetAddress("1490", "Grove Street"),
                 StreetAddress("2119", "Maple Avenue"),
                 StreetAddress("1400", "16th Street")]
let home = StreetAddress("1400", "16th Street")

print(addresses[0] == home)
// Prints "false"
print(addresses.contains(home))
// Prints "true"

等価性は代入可能性を意味します。同等に比較される任意の 2 つのインスタンスは、その値に依存するコードで同じ意味で使用できます。代入可能性を維持するために、== 演算子は、Equatable 型のすべての可視的な側面を考慮する必要があります。クラス ID 以外の Equatable 型の値でない側面を公開することはお勧めできません。公開されているものは、ドキュメントで明示的に指摘する必要があります。

Equatable 型のインスタンス間の等価性は等価関係であるため、Equatable に準拠するすべてのカスタム型は、任意の値 a、b、および c に対して3つの条件を満たさなければなりません。

a == a は常に true である (再帰性)

a == b は b == a を意味する (対称性)

a == b および b == c は a == c を意味する(推移性)

さらに、不等式は等式の逆です。したがって、!= 演算子の全てのカスタム実装では、a != b が !(a == b) を暗示するのを保証しなければなりません。!= 演算子関数のデフォルト実装は、この要件を満たします。

等式は ID から離れている

クラスインスタンスの ID はインスタンスの値の一部ではありません。整数値を包み込む IntegerRef というクラスを考えてみましょう。以下は IntegerRef と == 関数の定義であり、Equatable に準拠しています。

class IntegerRef: Equatable {
    let value: Int
    init(_ value: Int) {
        self.value = value
    }

    static func == (lhs: IntegerRef, rhs: IntegerRef) -> Bool {
        return lhs.value == rhs.value
    }
}

== 関数の実装は、その 2 つの引数が同じインスタンスであるか、value プロパティに格納された同じ整数を持つ 2 つの異なるインスタンスであるかにかかわらず、同じ値を返します。例えば：

let a = IntegerRef(100)
let b = IntegerRef(100)

print(a == a, a == b, separator: ", ")
// Prints "true, true"

一方、クラスインスタンス ID は、三重 equals identical-to 演算子 (===) を使用して比較されます。例えば：

let c = a
print(c === a, c === b, separator: ", ")
// Prints "true, false"

トピックス

Equatable 要件

static func == (Self, Self)

2 つの値が等しいかどうかを示すブール値を返します。
必須。

static func != (Self, Self)

2 つの値が等しくないかどうかを示すブール値を返します。

タプルの比較

等式と不等式で 2 つから 6 つの Equatable 要素のタプルを比較します。

func == ((), ())

2 つのタプルの対応する部分が等しいかどうかを示すブール値を返します。

func == <A, B>((A, B), (A, B))

2 つのタプルの対応する部分が等しいかどうかを示すブール値を返します。

func == <A, B, C>((A, B, C), (A, B, C))

2 つのタプルの対応する部分が等しいかどうかを示すブール値を返します。

func == <A, B, C, D>((A, B, C, D), (A, B, C, D))

2 つのタプルの対応する部分が等しいかどうかを示すブール値を返します。

func == <A, B, C, D, E>((A, B, C, D, E), (A, B, C, D, E))

2 つのタプルの対応する部分が等しいかどうかを示すブール値を返します。

func == <A, B, C, D, E, F>((A, B, C, D, E, F), (A, B, C, D, E, F))

2 つのタプルの対応する部分が等しいかどうかを示すブール値を返します。

func != ((), ())