Set.prototype.symmetricDifference()

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The symmetricDifference() method of Set instances takes a set and returns a new set containing elements which are in either this set or the given set, but not in both.

Syntax

js

symmetricDifference(other)

Parameters

other

A Set object, or set-like object.

Return value

A new Set object containing elements which are in either this set or the other set, but not in both.

Description

In mathematical notation, symmetric difference is defined as:

A B = ( A B ) ( B A ) A\ominus B = (A\setminus B)\cup(B\setminus A)

And using Venn diagram:

A Venn diagram where two circles overlap. The symmetric difference of A and B is the region contained by either circle but not both.

symmetricDifference() accepts set-like objects as the other parameter. It requires this to be an actual Set instance, because it directly retrieves the underlying data stored in this without invoking any user code. Then, it iterates over other by calling its keys() method, and constructs a new set with all elements in this that are not seen in other, and all elements in other that are not seen in this.

The order of elements in the returned set is first those in this followed by those in other.

Examples

Using symmetricDifference()

The following example computes the symmetric difference between the set of even numbers (<10) and the set of perfect squares (<10). The result is the set of numbers that are either even or a perfect square, but not both.

js

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

Specifications

Specification
Set methods
# sec-set.prototype.symmetricDifference

Browser compatibility

BCD tables only load in the browser

See also