Set

Set オブジェクトは、プリミティブ値やオブジェクト参照を問わず、あらゆる型で一意の値を格納できます。

解説

Set オブジェクトは値のコレクションです。挿入順に要素を反復することができます。Set に重複する値は格納出来ません。Set 内の値はコレクション内で一意となります。

値の等価性

Set オブジェクト内の各値は一意でなければならないので、値の等価性が調べられます。初期の ECMAScript では === 演算子とは違うアルゴリズムが用いられていました。特に +0 (厳密に言えば -0 と等価です) と -0 が区別されていた点は重要です。しかしこの振る舞いは ECMAScript 2015 で変更されました。ブラウザーの互換性の「-0 と +0 の等価性」を参照してください。

また、 NaN と undefined も Set 内に格納できます。NaN は (NaN !== NaN として扱われますが) NaN と同じと扱われます。

コンストラクター

Set()

新しい Set オブジェクトを生成します。

静的プロパティ

get Set[@@species]

派生オブジェクトを生成するために使用されるコンストラクター関数。

インスタンスプロパティ

Set.prototype.size

Set オブジェクト内の値の数を返します。

インスタンスメソッド

Set.prototype.add(value)

value を Set オブジェクトに追加します。Set オブジェクトを返します。

Set.prototype.clear()

すべての要素を Set オブジェクトから取り除きます。

Set.prototype.delete(value)

value に関連した要素を取り除き、Set.prototype.has(value) が以前に返していたはずの値を返します。Set.prototype.has(value) はその後に false を返します。

Set.prototype.has(value)

Set オブジェクト内に引数で与えられた値をもつ要素が存在するかどうかを示す真偽値を返します。

反復処理メソッド

Set.prototype[@@iterator]()

挿入順に Set オブジェクト内の各要素に対する values を生み出す新しい Iterator オブジェクトを返します。

Set.prototype.keys()

挿入順に Set オブジェクト内の各要素に対する値を含む新しい Iterator オブジェクトを返します。 (Set においては、これはvalues() メソッドと同じです。)

Set.prototype.values()

挿入順に Set オブジェクト内の各要素に対する values を含む新しい Iterator オブジェクトを返します。 (Set においては、これは keys() メソッドと同じです。

Set.prototype.entries()

挿入順に Set オブジェクト内の各要素に対して [value, value] の配列を含む新しい Iterator オブジェクトを返します。

これは Map オブジェクトに似させています。そのため、 Set においては各項目が key と value が同じ値になります。

Set.prototype.forEach(callbackFn[, thisArg])

挿入順に Set オブジェクト内に存在する各値に対して一度 callbackFn を呼びます。thisArg 引数が forEach に渡されたら、各コールバックに対して this 値として使用されます。

例

Set オブジェクトの使用

let mySet = new Set()

mySet.add(1)           // Set [ 1 ]
mySet.add(5)           // Set [ 1, 5 ]
mySet.add(5)           // Set [ 1, 5 ]
mySet.add('some text') // Set [ 1, 5, 'some text' ]
let o = {a: 1, b: 2}
mySet.add(o)

mySet.add({a: 1, b: 2})   // o is referencing a different object, so this is okay

mySet.has(1)              // true
mySet.has(3)              // 3 は集合にないため、false
mySet.has(5)              // true
mySet.has(Math.sqrt(25))  // true
mySet.has('Some Text'.toLowerCase()) // true
mySet.has(o)       // true

mySet.size         // 5

mySet.delete(5)    // Set から 5 を削除
mySet.has(5)       // 5 が削除されているため false 

mySet.size         // 要素を 1 つ削除しているため 4

console.log(mySet)
// logs Set(4) [ 1, "some text", {…}, {…} ] in Firefox
// logs Set(4) { 1, "some text", {…}, {…} } in Chrome

Set の反復操作

// iterate over items in set
// logs the items in the order: 1, "some text", {"a": 1, "b": 2}, {"a": 1, "b": 2} 
for (let item of mySet) console.log(item)

// logs the items in the order: 1, "some text", {"a": 1, "b": 2}, {"a": 1, "b": 2} 
for (let item of mySet.keys()) console.log(item)
 
// logs the items in the order: 1, "some text", {"a": 1, "b": 2}, {"a": 1, "b": 2} 
for (let item of mySet.values()) console.log(item)

// logs the items in the order: 1, "some text", {"a": 1, "b": 2}, {"a": 1, "b": 2} 
// (key and value are the same here)
for (let [key, value] of mySet.entries()) console.log(key)

// convert Set object to an Array object, with Array.from
let myArr = Array.from(mySet) // [1, "some text", {"a": 1, "b": 2}, {"a": 1, "b": 2}]

// the following will also work if run in an HTML document
mySet.add(document.body)
mySet.has(document.querySelector('body')) // true

// converting between Set and Array
mySet2 = new Set([1, 2, 3, 4])
mySet2.size                    // 4
[...mySet2]                    // [1, 2, 3, 4]

// intersect can be simulated via 
let intersection = new Set([...set1].filter(x => set2.has(x)))

// difference can be simulated via
let difference = new Set([...set1].filter(x => !set2.has(x)))

// Iterate set entries with forEach()
mySet.forEach(function(value) {
  console.log(value)
})

// 1
// 2
// 3
// 4

基本的な集合演算の実装

function isSuperset(set, subset) {
    for (let elem of subset) {
        if (!set.has(elem)) {
            return false
        }
    }
    return true
}

function union(setA, setB) {
    let _union = new Set(setA)
    for (let elem of setB) {
        _union.add(elem)
    }
    return _union
}

function intersection(setA, setB) {
    let _intersection = new Set()
    for (let elem of setB) {
        if (setA.has(elem)) {
            _intersection.add(elem)
        }
    }
    return _intersection
}

function symmetricDifference(setA, setB) {
    let _difference = new Set(setA)
    for (let elem of setB) {
        if (_difference.has(elem)) {
            _difference.delete(elem)
        } else {
            _difference.add(elem)
        }
    }
    return _difference
}

function difference(setA, setB) {
    let _difference = new Set(setA)
    for (let elem of setB) {
        _difference.delete(elem)
    }
    return _difference
}

// Examples
let setA = new Set([1, 2, 3, 4])
let setB = new Set([2, 3])
let setC = new Set([3, 4, 5, 6])

isSuperset(setA, setB)          // => true
union(setA, setC)               // => Set [1, 2, 3, 4, 5, 6]
intersection(setA, setC)        // => Set [3, 4]
symmetricDifference(setA, setC) // => Set [1, 2, 5, 6]
difference(setA, setC)          // => Set [1, 2]

Array オブジェクトとの関係

let myArray = ['value1', 'value2', 'value3']

// Use the regular Set constructor to transform an Array into a Set
let mySet = new Set(myArray)

mySet.has('value1')     // returns true

// Use the spread operator to transform a set into an Array.
console.log([...mySet]) // Will show you exactly the same Array as myArray

配列から重複した要素を取り除く

// Use to remove duplicate elements from the array 

const numbers = [2,3,4,4,2,3,3,4,4,5,5,6,6,7,5,32,3,4,5]

console.log([...new Set(numbers)]) 

// [2, 3, 4, 5, 6, 7, 32]

String との関係

let text = 'India'

let mySet = new Set(text)  // Set ['I', 'n', 'd', 'i', 'a']
mySet.size  // 5

//case sensitive & duplicate ommision
new Set("Firefox")  // Set(7) [ "F", "i", "r", "e", "f", "o", "x" ]
new Set("firefox")  // Set(6) [ "f", "i", "r", "e", "o", "x" ]

仕様書

ブラウザーの互換性

関連情報

• Map
• WeakMap
• WeakSet