Set.prototype.isSupersetOf()

構文

isSupersetOf(other)

引数

other

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

返値

other の集合にあるあるすべての要素がこの Set にもあれば true、そうでなければ false です。

解説

数学的な記法では、上位集合は次のように定義されます。

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

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

• this の要素数が other.size より少ない場合は、直接 false を返します。
• そうでなければ、other の keys() メソッドを呼び出して走査し、other の要素が this に存在しない場合は false を返します（そして、return() メソッドを呼び出して keys() イテレータを終了します）。 そうでなければ、true を返します。

例

isSupersetOf() の使用

偶数（20 未満）の集合は、4 の倍数（20 未満）の集合の上位集合です。

const evens = new Set([2, 4, 6, 8, 10, 12, 14, 16, 18]);
const fours = new Set([4, 8, 12, 16]);
console.log(evens.isSupersetOf(fours)); // true

すべての奇数（20 未満）の集合は、素数（20 未満）の集合の上位集合ではありません。なぜなら、2 は素数ですが、奇数ではないからです。

const primes = new Set([2, 3, 5, 7, 11, 13, 17, 19]);
const odds = new Set([3, 5, 7, 9, 11, 13, 15, 17, 19]);
console.log(odds.isSupersetOf(primes)); // false

同値集合は互いに上位集合です。

const set1 = new Set([1, 2, 3]);
const set2 = new Set([1, 2, 3]);
console.log(set1.isSupersetOf(set2)); // true
console.log(set2.isSupersetOf(set1)); // true

仕様書

ブラウザーの互換性

関連情報

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