mathlib documentation

data.sum.basic

Disjoint union of types #

This file proves basic results about the sum type α ⊕ β.

α ⊕ β is the type made of a copy of α and a copy of β. It is also called disjoint union.

Main declarations #

Notes #

The definition of sum takes values in Type*. This effectively forbids Prop- valued sum types. To this effect, we have psum, which takes value in Sort* and carries a more complicated universe signature in consequence. The Prop version is or.

source
@[protected, instance]
def sum.decidable_eq (α : Type u) [a : decidable_eq α] (β : Type v) [a_1 : decidable_eq β] :
decidable_eq (α ⊕ β)
source
@[simp]
theorem sum.forall {α : Type u} {β : Type v} {p : α ⊕ β → Prop} :
(∀ (x : α ⊕ β), p x) ↔ (∀ (a : α), p (sum.inl a)) ∧ ∀ (b : β), p (sum.inr b)
source
@[simp]
theorem sum.exists {α : Type u} {β : Type v} {p : α ⊕ β → Prop} :
(∃ (x : α ⊕ β), p x) ↔ (∃ (a : α), p (sum.inl a)) ∨ ∃ (b : β), p (sum.inr b)
source
theorem sum.inl_injective {α : Type u} {β : Type v} :
function.injective sum.inl
source
theorem sum.inr_injective {α : Type u} {β : Type v} :
function.injective sum.inr
source
@[simp]
def sum.get_left {α : Type u} {β : Type v} :
α ⊕ β → option α

Check if a sum is inl and if so, retrieve its contents.

Equations
source
@[simp]
def sum.get_right {α : Type u} {β : Type v} :
α ⊕ β → option β

Check if a sum is inr and if so, retrieve its contents.

Equations
source
@[simp]
def sum.is_left {α : Type u} {β : Type v} :
α ⊕ β → bool

Check if a sum is inl.

Equations
source
@[simp]
def sum.is_right {α : Type u} {β : Type v} :
α ⊕ β → bool

Check if a sum is inr.

Equations
source
theorem sum.get_left_eq_none_iff {α : Type u} {β : Type v} {x : α ⊕ β} :
x.get_left = none ↔ ↥(x.is_right)
source
theorem sum.get_right_eq_none_iff {α : Type u} {β : Type v} {x : α ⊕ β} :
x.get_right = none ↔ ↥(x.is_left)
source
@[protected]
def sum.map {α : Type u} {α' : Type w} {β : Type v} {β' : Type x} (f : α → α') (g : β → β') :
α ⊕ β → α' ⊕ β'

Map α ⊕ β to α' ⊕ β' sending α to α' and β to β'.

Equations
source
@[simp]
theorem sum.map_inl {α : Type u} {α' : Type w} {β : Type v} {β' : Type x} (f : α → α') (g : β → β') (x : α) :
sum.map f g (sum.inl x) = sum.inl (f x)
source
@[simp]
theorem sum.map_inr {α : Type u} {α' : Type w} {β : Type v} {β' : Type x} (f : α → α') (g : β → β') (x : β) :
sum.map f g (sum.inr x) = sum.inr (g x)
source
@[simp]
theorem sum.map_map {α : Type u} {α' : Type w} {β : Type v} {β' : Type x} {α'' : Type u_1} {β'' : Type u_2} (f' : α' → α'') (g' : β' → β'') (f : α → α') (g : β → β') (x : α ⊕ β) :
sum.map f' g' (sum.map f g x) = sum.map (f' ∘ f) (g' ∘ g) x
source
@[simp]
theorem sum.map_comp_map {α : Type u} {α' : Type w} {β : Type v} {β' : Type x} {α'' : Type u_1} {β'' : Type u_2} (f' : α' → α'') (g' : β' → β'') (f : α → α') (g : β → β') :
sum.map f' g' ∘ sum.map f g = sum.map (f' ∘ f) (g' ∘ g)
source
@[simp]
theorem sum.map_id_id (α : Type u_1) (β : Type u_2) :
sum.map id id = id
source
theorem sum.inl.inj_iff {α : Type u} {β : Type v} {a b : α} :
sum.inl a = sum.inl b ↔ a = b
source
theorem sum.inr.inj_iff {α : Type u} {β : Type v} {a b : β} :
sum.inr a = sum.inr b ↔ a = b
source
theorem sum.inl_ne_inr {α : Type u} {β : Type v} {a : α} {b : β} :
sum.inl a ≠ sum.inr b
source
theorem sum.inr_ne_inl {α : Type u} {β : Type v} {a : α} {b : β} :
sum.inr b ≠ sum.inl a
source
@[protected]
def sum.elim {α : Type u_1} {β : Type u_2} {γ : Sort u_3} (f : α → γ) (g : β → γ) :
α ⊕ β → γ

Define a function on α ⊕ β by giving separate definitions on α and β.

Equations
source
@[simp]
theorem sum.elim_inl {α : Type u_1} {β : Type u_2} {γ : Sort u_3} (f : α → γ) (g : β → γ) (x : α) :
sum.elim f g (sum.inl x) = f x
source
@[simp]
theorem sum.elim_inr {α : Type u_1} {β : Type u_2} {γ : Sort u_3} (f : α → γ) (g : β → γ) (x : β) :
sum.elim f g (sum.inr x) = g x
source
@[simp]
theorem sum.elim_comp_inl {α : Type u_1} {β : Type u_2} {γ : Sort u_3} (f : α → γ) (g : β → γ) :
sum.elim f g ∘ sum.inl = f
source
@[simp]
theorem sum.elim_comp_inr {α : Type u_1} {β : Type u_2} {γ : Sort u_3} (f : α → γ) (g : β → γ) :
sum.elim f g ∘ sum.inr = g
source
@[simp]
theorem sum.elim_inl_inr {α : Type u_1} {β : Type u_2} :
sum.elim sum.inl sum.inr = id
source
theorem sum.comp_elim {α : Type u_1} {β : Type u_2} {γ : Sort u_3} {δ : Sort u_4} (f : γ → δ) (g : α → γ) (h : β → γ) :
f ∘ sum.elim g h = sum.elim (f ∘ g) (f ∘ h)
source
@[simp]
theorem sum.elim_comp_inl_inr {α : Type u_1} {β : Type u_2} {γ : Sort u_3} (f : α ⊕ β → γ) :
sum.elim (f ∘ sum.inl) (f ∘ sum.inr) = f
source
theorem sum.elim_comp_map {α : Type u_1} {β : Type u_2} {γ : Type u_3} {δ : Type u_4} {ε : Sort u_5} {f₁ : α → β} {f₂ : β → ε} {g₁ : γ → δ} {g₂ : δ → ε} :
sum.elim f₂ g₂ ∘ sum.map f₁ g₁ = sum.elim (f₂ ∘ f₁) (g₂ ∘ g₁)
source
@[simp]
theorem sum.update_elim_inl {α : Type u} {β : Type v} {γ : Type u_1} [decidable_eq α] [decidable_eq (α ⊕ β)] {f : α → γ} {g : β → γ} {i : α} {x : γ} :
function.update (sum.elim f g) (sum.inl i) x = sum.elim (function.update f i x) g
source
@[simp]
theorem sum.update_elim_inr {α : Type u} {β : Type v} {γ : Type u_1} [decidable_eq β] [decidable_eq (α ⊕ β)] {f : α → γ} {g : β → γ} {i : β} {x : γ} :
function.update (sum.elim f g) (sum.inr i) x = sum.elim f (function.update g i x)
source
@[simp]
theorem sum.update_inl_comp_inl {α : Type u} {β : Type v} {γ : Type u_1} [decidable_eq α] [decidable_eq (α ⊕ β)] {f : α ⊕ β → γ} {i : α} {x : γ} :
function.update f (sum.inl i) x ∘ sum.inl = function.update (f ∘ sum.inl) i x
source
@[simp]
theorem sum.update_inl_apply_inl {α : Type u} {β : Type v} {γ : Type u_1} [decidable_eq α] [decidable_eq (α ⊕ β)] {f : α ⊕ β → γ} {i j : α} {x : γ} :
function.update f (sum.inl i) x (sum.inl j) = function.update (f ∘ sum.inl) i x j
source
@[simp]
theorem sum.update_inl_comp_inr {α : Type u} {β : Type v} {γ : Type u_1} [decidable_eq (α ⊕ β)] {f : α ⊕ β → γ} {i : α} {x : γ} :
function.update f (sum.inl i) x ∘ sum.inr = f ∘ sum.inr
source
@[simp]
theorem sum.update_inl_apply_inr {α : Type u} {β : Type v} {γ : Type u_1} [decidable_eq (α ⊕ β)] {f : α ⊕ β → γ} {i : α} {j : β} {x : γ} :
function.update f (sum.inl i) x (sum.inr j) = f (sum.inr j)
source
@[simp]
theorem sum.update_inr_comp_inl {α : Type u} {β : Type v} {γ : Type u_1} [decidable_eq (α ⊕ β)] {f : α ⊕ β → γ} {i : β} {x : γ} :
function.update f (sum.inr i) x ∘ sum.inl = f ∘ sum.inl
source
@[simp]
theorem sum.update_inr_apply_inl {α : Type u} {β : Type v} {γ : Type u_1} [decidable_eq (α ⊕ β)] {f : α ⊕ β → γ} {i : α} {j : β} {x : γ} :
function.update f (sum.inr j) x (sum.inl i) = f (sum.inl i)
source
@[simp]
theorem sum.update_inr_comp_inr {α : Type u} {β : Type v} {γ : Type u_1} [decidable_eq β] [decidable_eq (α ⊕ β)] {f : α ⊕ β → γ} {i : β} {x : γ} :
function.update f (sum.inr i) x ∘ sum.inr = function.update (f ∘ sum.inr) i x
source
@[simp]
theorem sum.update_inr_apply_inr {α : Type u} {β : Type v} {γ : Type u_1} [decidable_eq β] [decidable_eq (α ⊕ β)] {f : α ⊕ β → γ} {i j : β} {x : γ} :
function.update f (sum.inr i) x (sum.inr j) = function.update (f ∘ sum.inr) i x j
source
@[simp]
def sum.swap {α : Type u} {β : Type v} :
α ⊕ β → β ⊕ α

Swap the factors of a sum type

Equations
source
@[simp]
theorem sum.swap_swap {α : Type u} {β : Type v} (x : α ⊕ β) :
x.swap.swap = x
source
@[simp]
theorem sum.swap_swap_eq {α : Type u} {β : Type v} :
sum.swap ∘ sum.swap = id
source
@[simp]
theorem sum.swap_left_inverse {α : Type u} {β : Type v} :
function.left_inverse sum.swap sum.swap
source
@[simp]
theorem sum.swap_right_inverse {α : Type u} {β : Type v} :
function.right_inverse sum.swap sum.swap
source
inductive sum.lift_rel {α : Type u} {β : Type v} {γ : Type u_1} {δ : Type u_2} (r : α → γ → Prop) (s : β → δ → Prop) :
α ⊕ β → γ ⊕ δ → Prop
  • inl : ∀ {α : Type u} {β : Type v} {γ : Type u_1} {δ : Type u_2} {r : α → γ → Prop} {s : β → δ → Prop} {a : α} {c : γ}, r a c → sum.lift_rel r s (sum.inl a) (sum.inl c)
  • inr : ∀ {α : Type u} {β : Type v} {γ : Type u_1} {δ : Type u_2} {r : α → γ → Prop} {s : β → δ → Prop} {b : β} {d : δ}, s b d → sum.lift_rel r s (sum.inr b) (sum.inr d)

Lifts pointwise two relations between α and γ and between β and δ to a relation between α ⊕ β and γ ⊕ δ.

source
@[simp]
theorem sum.lift_rel_inl_inl {α : Type u} {β : Type v} {γ : Type u_1} {δ : Type u_2} {r : α → γ → Prop} {s : β → δ → Prop} {a : α} {c : γ} :
sum.lift_rel r s (sum.inl a) (sum.inl c) ↔ r a c
source
@[simp]
theorem sum.not_lift_rel_inl_inr {α : Type u} {β : Type v} {γ : Type u_1} {δ : Type u_2} {r : α → γ → Prop} {s : β → δ → Prop} {a : α} {d : δ} :
¬sum.lift_rel r s (sum.inl a) (sum.inr d)
source
@[simp]
theorem sum.not_lift_rel_inr_inl {α : Type u} {β : Type v} {γ : Type u_1} {δ : Type u_2} {r : α → γ → Prop} {s : β → δ → Prop} {b : β} {c : γ} :
¬sum.lift_rel r s (sum.inr b) (sum.inl c)
source
@[simp]
theorem sum.lift_rel_inr_inr {α : Type u} {β : Type v} {γ : Type u_1} {δ : Type u_2} {r : α → γ → Prop} {s : β → δ → Prop} {b : β} {d : δ} :
sum.lift_rel r s (sum.inr b) (sum.inr d) ↔ s b d
source
@[protected, instance]
def sum.lift_rel.decidable {α : Type u} {β : Type v} {γ : Type u_1} {δ : Type u_2} {r : α → γ → Prop} {s : β → δ → Prop} [Π (a : α) (c : γ), decidable (r a c)] [Π (b : β) (d : δ), decidable (s b d)] (ab : α ⊕ β) (cd : γ ⊕ δ) :
decidable (sum.lift_rel r s ab cd)
Equations
source
theorem sum.lift_rel.mono {α : Type u} {β : Type v} {γ : Type u_1} {δ : Type u_2} {r₁ r₂ : α → γ → Prop} {s₁ s₂ : β → δ → Prop} {x : α ⊕ β} {y : γ ⊕ δ} (hr : ∀ (a : α) (b : γ), r₁ a b → r₂ a b) (hs : ∀ (a : β) (b : δ), s₁ a b → s₂ a b) (h : sum.lift_rel r₁ s₁ x y) :
sum.lift_rel r₂ s₂ x y
source
theorem sum.lift_rel.mono_left {α : Type u} {β : Type v} {γ : Type u_1} {δ : Type u_2} {r₁ r₂ : α → γ → Prop} {s : β → δ → Prop} {x : α ⊕ β} {y : γ ⊕ δ} (hr : ∀ (a : α) (b : γ), r₁ a b → r₂ a b) (h : sum.lift_rel r₁ s x y) :
sum.lift_rel r₂ s x y
source
theorem sum.lift_rel.mono_right {α : Type u} {β : Type v} {γ : Type u_1} {δ : Type u_2} {r : α → γ → Prop} {s₁ s₂ : β → δ → Prop} {x : α ⊕ β} {y : γ ⊕ δ} (hs : ∀ (a : β) (b : δ), s₁ a b → s₂ a b) (h : sum.lift_rel r s₁ x y) :
sum.lift_rel r s₂ x y
source
@[protected]
theorem sum.lift_rel.swap {α : Type u} {β : Type v} {γ : Type u_1} {δ : Type u_2} {r : α → γ → Prop} {s : β → δ → Prop} {x : α ⊕ β} {y : γ ⊕ δ} (h : sum.lift_rel r s x y) :
sum.lift_rel s r x.swap y.swap
source
@[simp]
theorem sum.lift_rel_swap_iff {α : Type u} {β : Type v} {γ : Type u_1} {δ : Type u_2} {r : α → γ → Prop} {s : β → δ → Prop} {x : α ⊕ β} {y : γ ⊕ δ} :
sum.lift_rel s r x.swap y.swap ↔ sum.lift_rel r s x y
source
inductive sum.lex {α : Type u} {β : Type v} (r : α → α → Prop) (s : β → β → Prop) :
α ⊕ β → α ⊕ β → Prop
  • inl : ∀ {α : Type u} {β : Type v} {r : α → α → Prop} {s : β → β → Prop} {a₁ a₂ : α}, r a₁ a₂ → sum.lex r s (sum.inl a₁) (sum.inl a₂)
  • inr : ∀ {α : Type u} {β : Type v} {r : α → α → Prop} {s : β → β → Prop} {b₁ b₂ : β}, s b₁ b₂ → sum.lex r s (sum.inr b₁) (sum.inr b₂)
  • sep : ∀ {α : Type u} {β : Type v} {r : α → α → Prop} {s : β → β → Prop} (a : α) (b : β), sum.lex r s (sum.inl a) (sum.inr b)

Lexicographic order for sum. Sort all the inl a before the inr b, otherwise use the respective order on α or β.

source
@[simp]
theorem sum.lex_inl_inl {α : Type u} {β : Type v} {r : α → α → Prop} {s : β → β → Prop} {a₁ a₂ : α} :
sum.lex r s (sum.inl a₁) (sum.inl a₂) ↔ r a₁ a₂
source
@[simp]
theorem sum.lex_inr_inr {α : Type u} {β : Type v} {r : α → α → Prop} {s : β → β → Prop} {b₁ b₂ : β} :
sum.lex r s (sum.inr b₁) (sum.inr b₂) ↔ s b₁ b₂
source
@[simp]
theorem sum.lex_inr_inl {α : Type u} {β : Type v} {r : α → α → Prop} {s : β → β → Prop} {a : α} {b : β} :
¬sum.lex r s (sum.inr b) (sum.inl a)
source
@[protected, instance]
def sum.lex.decidable_rel {α : Type u} {β : Type v} {r : α → α → Prop} {s : β → β → Prop} [decidable_rel r] [decidable_rel s] :
decidable_rel (sum.lex r s)
Equations
source
@[protected]
theorem sum.lift_rel.lex {α : Type u} {β : Type v} {r : α → α → Prop} {s : β → β → Prop} {a b : α ⊕ β} (h : sum.lift_rel r s a b) :
sum.lex r s a b
source
theorem sum.lex.mono {α : Type u} {β : Type v} {r₁ r₂ : α → α → Prop} {s₁ s₂ : β → β → Prop} {x y : α ⊕ β} (hr : ∀ (a b : α), r₁ a b → r₂ a b) (hs : ∀ (a b : β), s₁ a b → s₂ a b) (h : sum.lex r₁ s₁ x y) :
sum.lex r₂ s₂ x y
source
theorem sum.lex.mono_left {α : Type u} {β : Type v} {r₁ r₂ : α → α → Prop} {s : β → β → Prop} {x y : α ⊕ β} (hr : ∀ (a b : α), r₁ a b → r₂ a b) (h : sum.lex r₁ s x y) :
sum.lex r₂ s x y
source
theorem sum.lex.mono_right {α : Type u} {β : Type v} {r : α → α → Prop} {s₁ s₂ : β → β → Prop} {x y : α ⊕ β} (hs : ∀ (a b : β), s₁ a b → s₂ a b) (h : sum.lex r s₁ x y) :
sum.lex r s₂ x y
source
theorem sum.lex_acc_inl {α : Type u} {β : Type v} {r : α → α → Prop} {s : β → β → Prop} {a : α} (aca : acc r a) :
acc (sum.lex r s) (sum.inl a)
source
theorem sum.lex_acc_inr {α : Type u} {β : Type v} {r : α → α → Prop} {s : β → β → Prop} (aca : ∀ (a : α), acc (sum.lex r s) (sum.inl a)) {b : β} (acb : acc s b) :
acc (sum.lex r s) (sum.inr b)
source
theorem sum.lex_wf {α : Type u} {β : Type v} {r : α → α → Prop} {s : β → β → Prop} (ha : well_founded r) (hb : well_founded s) :
well_founded (sum.lex r s)
source
theorem function.injective.sum_elim {α : Type u} {β : Type v} {γ : Type u_1} {f : α → γ} {g : β → γ} (hf : function.injective f) (hg : function.injective g) (hfg : ∀ (a : α) (b : β), f a ≠ g b) :
function.injective (sum.elim f g)
source
theorem function.injective.sum_map {α : Type u} {α' : Type w} {β : Type v} {β' : Type x} {f : α → β} {g : α' → β'} (hf : function.injective f) (hg : function.injective g) :
function.injective (sum.map f g)
source
theorem function.surjective.sum_map {α : Type u} {α' : Type w} {β : Type v} {β' : Type x} {f : α → β} {g : α' → β'} (hf : function.surjective f) (hg : function.surjective g) :
function.surjective (sum.map f g)