Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【JavaScript ECMAScript】Set::Set.prototype.symmetricDifferenceインスタンスメソッドの使い方

Set.prototype.symmetricDifference()インスタンスメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

Set.prototype.symmetricDifference()メソッドは、現在のSetオブジェクトと引数で指定された別のSetオブジェクトの対称差を計算し、その結果を新しいSetオブジェクトとして返すメソッドです。

対称差とは、2つの集合において、どちらか一方にのみ存在する要素を集めたものです。具体的には、両方の集合に共通して存在する要素をすべて取り除いた後に残る、すべての要素からなる集合を指します。これは、例えば2つのデータ集合間で固有の要素だけを抽出したい場合や、共通部分を除いた差分を特定したい場合に非常に有効です。

このメソッドは、比較対象となるSetオブジェクトを1つ引数として受け取ります。引数にSetオブジェクト以外の値を渡すと、TypeErrorが発生しますので注意が必要です。メソッドが実行されると、呼び出し元のSetオブジェクトと引数のSetオブジェクトの内容は変更されず、新しいSetオブジェクトが生成されて返されます。この新しいSetオブジェクトには、元の2つのSetオブジェクトのいずれか一方にのみ存在する要素が含まれます。

この機能は、データセットの比較やフィルタリングにおいて、集合論的な操作を簡潔に、かつ効率的に行うための標準的な手段を提供します。

公式リファレンス: Set.prototype.symmetricDifference()

構文(syntax)

1const set1 = new Set([1, 2, 3]);
2const set2 = new Set([2, 3, 4]);
3const symmetricDifferenceSet = set1.symmetricDifference(set2);

引数(parameters)

other

  • other: Set: 比較対象となる別のSetオブジェクト

戻り値(return)

Set

このメソッドは、元のSetと、引数として渡された別のSetとの対称差(symmetric difference)を計算し、その結果を新しいSetとして返します。対称差とは、どちらか一方のSetにのみ存在する要素の集合のことです。

関連コンテンツ

関連プログラミング言語