Index.symmetric_difference(other, result_name=None, sort=None)[source]#

Compute the symmetric difference of two Index objects.

  • other (Index or array-like) –

  • result_name (str) –

  • sort (bool or None, default None) –

    Whether to sort the resulting index. By default, the values are attempted to be sorted, but any TypeError from incomparable elements is caught by pandas.

    • None : Attempt to sort the result, but catch any TypeErrors from comparing incomparable elements.

    • False : Do not sort the result.

    • True : Sort the result (which may raise TypeError).

Return type



symmetric_difference contains elements that appear in either idx1 or idx2 but not both. Equivalent to the Index created by idx1.difference(idx2) | idx2.difference(idx1) with duplicates dropped.


>>> idx1 = pd.Index([1, 2, 3, 4])  
>>> idx2 = pd.Index([2, 3, 4, 5])  
>>> idx1.symmetric_difference(idx2)  
Index([1, 5], dtype='int64')


This method has not been implemented yet. Xorbits will try to execute it with pandas.

This docstring was copied from pandas.core.indexes.base.Index.