Protocol

SetAlgebra

A type that provides mathematical set operations. 数学的な集合演算を提供する型。

Declaration 宣言 

protocol SetAlgebra

Overview 概要

You use types that conform to the SetAlgebra protocol when you need efficient membership tests or mathematical set operations such as intersection, union, and subtraction. In the standard library, you can use the Set type with elements of any hashable type, or you can easily create bit masks with SetAlgebra conformance using the OptionSet protocol. See those types for more information. あなたがSetAlgebraプロトコルに準拠する型を使うのは、あなたが帰属について能率的にテストするか、数学的集合演算たとえば交叉、合併、そして差分を必要とする場合です。標準ライブラリにおいて、あなたはSet型を何らかのハッシュ型の要素で使うことができます、またはあなたはSetAlgebra準拠を持つビットマスクをOptionSetプロトコルを使って簡単に作成することができます。さらなる情報としてそれらの型を見てください。

Conforming to the SetAlgebra Protocol SetAlgebraプロトコルに準拠する

When implementing a custom type that conforms to the SetAlgebra protocol, you must implement the required initializers and methods. For the inherited methods to work properly, conforming types must meet the following axioms. Assume that S is a custom type that conforms to the SetAlgebra protocol, x and y are instances of S, and e is of type S.Element—the type that the set holds. SetAlgebraプロトコルに準拠するあつらえの型を実装する場合、あなたは必須イニシャライザとメソッドを実装する必要があります。継承されたメソッドを適切に働かせるためには、準拠する型は以下の原則に応じる必要があります。SはSetAlgebraプロトコルに準拠するあつらえの型、xとyはSのインスタンス、そしてeは型S.Element — 集合が保持する型、と仮定します。

  • S() == [] S() == [] （空の集合は空の配列リテラルと同等です）

  • x.intersection(x) == x

  • x.intersection([]) == []

  • x.union(x) == x

  • x.union([]) == x

  • x.contains(e) implies x.union(y).contains(e) x.contains(e) は暗黙的に x.union(y).contains(e)

  • x.union(y).contains(e) implies x.contains(e) || y.contains(e) x.union(y).contains(e) は暗黙的に x.contains(e) || y.contains(e)

  • x.contains(e) && y.contains(e) if and only if x.intersection(y).contains(e) x.contains(e) && y.contains(e) は次の場合に限ります x.intersection(y).contains(e)

  • x.isSubset(of: y) implies x.union(y) == y x.isSubset(of: y) は暗黙的に x.union(y) == y

  • x.isSuperset(of: y) implies x.union(y) == x x.isSuperset(of: y) は暗黙的に x.union(y) == x

  • x.isSubset(of: y) if and only if y.isSuperset(of: x) x.isSubset(of: y) は次の場合に限ります y.isSuperset(of: x)

  • x.isStrictSuperset(of: y) if and only if x.isSuperset(of: y) && x != y x.isStrictSuperset(of: y) は次の場合に限ります x.isSuperset(of: y) && x != y

  • x.isStrictSubset(of: y) if and only if x.isSubset(of: y) && x != y x.isStrictSubset(of: y) は次の場合に限ります x.isSubset(of: y) && x != y

Topics 話題

Creating a Set 集合の作成

init()
Creates an empty set. 空の集合を作成します。

Required. Default implementation provided. 必須。 省略時の実装の提供。

Testing for Membership 帰属をテストする

func contains(Self.Element) -> Bool
Returns a Boolean value that indicates whether the given element exists in the set. 与えられた要素が集合の中の存在するかどうかを指し示すブール値を返します。

Required. Default implementation provided. 必須。 省略時の実装の提供。

associatedtype Element
A type for which the conforming type provides a containment test. ある型、それに対して準拠しているが格納テストを提供します。

Required. 必須。

Adding and Removing Elements 要素の追加と削除

func insert(Self.Element) -> (inserted: Bool, memberAfterInsert: Self.Element)
Inserts the given element in the set if it is not already present. それが既に存在するのでないならば、与えられた要素を集合へと挿入します。

Required. Default implementation provided. 必須。 省略時の実装の提供。

func update(with: Self.Element) -> Self.Element?
Inserts the given element into the set unconditionally. 与えられた要素を集合へと無条件に挿入します。

Required. Default implementation provided. 必須。 省略時の実装の提供。

func remove(Self.Element) -> Self.Element?
Removes the given element and any elements subsumed by the given element. 与えられた要素と、与えられた要素によって包括されるあらゆる要素を削除します。

Required. Default implementation provided. 必須。 省略時の実装の提供。

Combining Sets 集合を結合する

func union(Self) -> Self
Returns a new set with the elements of both this and the given set. これと与えられた集合の両方の要素を持つ新しい集合を返します。

Required. Default implementation provided. 必須。 省略時の実装の提供。

func formUnion(Self)
Adds the elements of the given set to the set. 与えられた集合の要素をこの集合に加えます。

Required. Default implementation provided. 必須。 省略時の実装の提供。

func intersection(Self) -> Self
Returns a new set with the elements that are common to both this set and the given set. この集合と与えられた集合の両方に共通である要素を持つ新しい集合を返します。

Required. Default implementation provided. 必須。 省略時の実装の提供。

func formIntersection(Self)
Removes the elements of this set that aren’t also in the given set. 与えられた集合の中にはない、この集合の要素を削除します。

Required. Default implementation provided. 必須。 省略時の実装の提供。

func symmetricDifference(Self) -> Self
Returns a new set with the elements that are either in this set or in the given set, but not in both. この集合の中か与えられた集合の中かどちらかの、しかし両方の中にではない要素を持つ新しい集合を返します。

Required. Default implementation provided. 必須。 省略時の実装の提供。

func formSymmetricDifference(Self)
Removes the elements of the set that are also in the given set and adds the members of the given set that are not already in the set. 与えられた集合の中にもあるこの集合の要素を削除します、そして与えられた集合のメンバでこの集合の中にはまだないものを加えます。

Required. Default implementation provided. 必須。 省略時の実装の提供。

Comparing Sets 集合を比較する

func isStrictSubset(of: Self) -> Bool
Returns a Boolean value that indicates whether this set is a strict subset of the given set. この集合は与えられた集合の狭義の下位集合であるかどうかを指し示すブール値を返します。
func isStrictSuperset(of: Self) -> Bool
Returns a Boolean value that indicates whether this set is a strict superset of the given set. この集合は与えられた集合の狭義の上位集合であるかどうかを指し示すブール値を返します。

Initializers イニシャライザ

init<S>(S)
Creates a new set from a finite sequence of items. いくつかの要素からなる有限のシーケンスから集合を作成します。

Required. Default implementation provided. 必須。 省略時の実装の提供。

Instance Properties 様々なインスタンスプロパティ

var isEmpty: Bool
A Boolean value that indicates whether the set has no elements. 集合が要素をひとつも持たないかどうかを指し示すブール値。

Required. Default implementation provided. 必須。 省略時の実装の提供。

Instance Methods インスタンスメソッド

func isDisjoint(with: Self) -> Bool
Returns a Boolean value that indicates whether the set has no members in common with the given set. この集合が、与えられた集合と共通のメンバを１つも持たないかどうかを指し示すブール値を返します。

Required. Default implementation provided. 必須。 省略時の実装の提供。

func isSubset(of: Self) -> Bool
Returns a Boolean value that indicates whether the set is a subset of another set. この集合は別の集合の下位集合であるかどうかを指し示すブール値を返します。

Required. Default implementation provided. 必須。 省略時の実装の提供。

func isSuperset(of: Self) -> Bool
Returns a Boolean value that indicates whether the set is a superset of the given set. この集合が、与えられた集合の上位集合であるかどうかを指し示すブール値を返します。

Required. Default implementation provided. 必須。 省略時の実装の提供。

func subtract(Self)
Removes the elements of the given set from this set. 与えられた集合の要素をこの集合から削除します。

Required. Default implementation provided. 必須。 省略時の実装の提供。

func subtracting(Self) -> Self
Returns a new set containing the elements of this set that do not occur in the given set. 与えられた集合の中の現れないこの集合の要素を含んでいる新しい集合を返します。

Required. Default implementation provided. 必須。 省略時の実装の提供。

Relationships 関係

Inherits From 継承元

Inherited By 継承される先

Conforming Types これらの型が準拠