Set.prototype.difference()

構文

difference(other)

引数

other

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

返値

新しい Set オブジェクトで、この Set に含まれる要素で、other 集合には含まれない要素が入ったものです。

解説

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

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

difference() は、Set 風オブジェクトを other 引数として受け入れます。this は、ユーザーコードを呼び出すことなく、this オブジェクトに格納されているデータに直接アクセスするため、実際の Set インスタンスであることが要求されます。その後、その動作は this と other のサイズに依存します。

• this の中の要素が other.size よりも多かった場合、other を keys() メソッドを呼び出すことで走査し、this の中のすべての要素のうち other にない要素で新しい Set を構築します。
• そうでなければ、this の要素を走査し、this の要素 e のうち、other.has(e) が偽値を返すすべてを含む新しい Set を構築します。

返される Set の要素の順序は、this の順序と同じです。

例

difference() の使用

次の例では、奇数（10 未満）と完全平方（10 未満）の集合の差を計算します。結果は、完全平方ではない奇数の集合となります。

const odds = new Set([1, 3, 5, 7, 9]);
const squares = new Set([1, 4, 9]);
console.log(odds.difference(squares)); // Set(3) { 3, 5, 7 }

仕様書

ブラウザーの互換性

関連情報

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