Skip to content

Compute the set symmetric difference between elements of a list and other elements

Description

This returns all elements that are in only one of the two lists. To get only elements that are in the first list but not in the second one, use $set_difference().

Usage

<Expr>$list$set_symmetric_difference(other)

Arguments

other Other list variable. Can be an Expr or something coercible to an Expr.

Details

Note that the datatypes inside the list must have a common supertype. For example, the first column can be list[i32] and the second one can be list[i8] because it can be cast to list[i32]. However, the second column cannot be e.g list[f32].

Value

A polars expression

Examples

library("polars")

df <- pl$DataFrame(
  a = list(1:3, NA, c(NA, 3L), 5:7),
  b = list(2:4, 3L, c(3L, 4L, NA), c(6L, 8L))
)

df$with_columns(
  symmetric_difference = pl$col("a")$list$set_symmetric_difference("b")
)

#> shape: (4, 3)
#> ┌───────────┬──────────────┬──────────────────────┐
#> │ a         ┆ b            ┆ symmetric_difference │
#> │ ---       ┆ ---          ┆ ---                  │
#> │ list[i32] ┆ list[i32]    ┆ list[i32]            │
#> ╞═══════════╪══════════════╪══════════════════════╡
#> │ [1, 2, 3] ┆ [2, 3, 4]    ┆ [1, 4]               │
#> │ [null]    ┆ [3]          ┆ [null, 3]            │
#> │ [null, 3] ┆ [3, 4, null] ┆ [4]                  │
#> │ [5, 6, 7] ┆ [6, 8]       ┆ [5, 7, 8]            │
#> └───────────┴──────────────┴──────────────────────┘