Set.prototype.symmetricDifference()

構文

symmetricDifference(other)

引数

other

Set オブジェクト、または Set 風オブジェクトです。

返値

新しい Set オブジェクトで、この Set と other の集合のどちらかにあるものの、両方にはない要素が入ったものです。

解説

数学的な記法では、対称差分 (symmetric difference) は次のように定義されます。

ベン図を使うとこうなります。

symmetricDifference() は、Set 風オブジェクトを other 引数として受け入れます。this は、ユーザーコードを呼び出すことなく、this オブジェクトに格納されているデータに直接アクセスするため、実際の Set インスタンスであることが要求されます。次に、other の keys() メソッドを呼び出して繰り返し処理を行い、this に存在し、other に存在しないすべての要素と、other に存在し、this に存在しないすべての要素をすべて含む新しい Set を構築します。

返される Set 内の要素の順序は、まず this の要素、次に other の要素となります。

例

symmetricDifference() の使用

次の例では、偶数（10 未満）と完全平方（10 未満）の集合の対称差分を計算します。結果は、完全平方または偶数のどちらかで、両方にはない数の集合となります。

const evens = new Set([2, 4, 6, 8]);
const squares = new Set([1, 4, 9]);
console.log(evens.symmetricDifference(squares)); // Set(5) { 2, 6, 8, 1, 9 }

仕様書

ブラウザーの互換性

関連情報

• Set.prototype.symmetricDifference のポリフィル (core-js)
• es-shims による Set.prototype.symmetricDifference のポリフィル
• Set.prototype.difference()
• Set.prototype.intersection()
• Set.prototype.isDisjointFrom()
• Set.prototype.isSubsetOf()
• Set.prototype.isSupersetOf()
• Set.prototype.union()