Extra definitions on Option

This file defines more operations involving Option α. Lemmas about them are located in other files under Mathlib.Data.Option. Other basic operations on Option are defined in the core library.

inductive Option.rel {α : Type u_1} {β : Type u_2} (r : α → β → Prop) : Option α → Option β → Prop

• some: ∀ {α : Type u_1} {β : Type u_2} {r : α → β → Prop} {a : α} {b : β}, r a b → Option.rel r (some a) (some b)

  If a ~ b, then some a ~ some b

• none: ∀ {α : Type u_1} {β : Type u_2} {r : α → β → Prop}, Option.rel r none none

  none ~ none

Lifts a relation α → β → Prop to a relation Option α → Option β → Prop by just adding none ~ none.

def Option.traverse {F : Type u → Type v} [Applicative F] {α : Type u_1} {β : Type u} (f : α → F β) : Option α → F (Option β)

Traverse an object of Option α with a function f : α → F β for an applicative F.

def Option.maybe {m : Type u → Type v} [Monad m] {α : Type u} : Option (m α) → m (Option α)

If you maybe have a monadic computation in a [Monad m] which produces a term of type α, then there is a naturally associated way to always perform a computation in m which maybe produces a result.

@[deprecated Option.getDM]

def Option.getDM' {m : Type u_1 → Type u_2} {α : Type u_1} [Monad m] (x : m (Option α)) (y : m α) : m α

def Option.elim' {α : Type u_1} {β : Type u_2} (b : β) (f : α → β) : Option α → β

An elimination principle for Option. It is a nondependent version of Option.rec.

@[simp]

theorem Option.elim'_none {α : Type u_1} {β : Type u_2} (b : β) (f : α → β) : Option.elim' b f none = b

@[simp]

theorem Option.elim'_some {α : Type u_1} {β : Type u_2} {a : α} (b : β) (f : α → β) : Option.elim' b f (some a) = f a

theorem Option.elim'_eq_elim {α : Type u_3} {β : Type u_4} (b : β) (f : α → β) (a : Option α) : Option.elim' b f a = Option.elim a b f

theorem Option.mem_some_iff {α : Type u_3} {a : α} {b : α} : a ∈ some b ↔ b = a

@[inline]

def Option.decidableEqNone {α : Type u_1} {o : Option α} : Decidable (o = none)

o = none is decidable even if the wrapped type does not have decidable equality. This is not an instance because it is not definitionally equal to Option.decidableEq. Try to use o.isNone or o.isSome instead.

instance Option.decidableForallMem {α : Type u_1} {p : α → Prop} [DecidablePred p] (o : Option α) : Decidable ((a : α) → a ∈ o → p a)

instance Option.decidableExistsMem {α : Type u_1} {p : α → Prop} [DecidablePred p] (o : Option α) : Decidable (∃ a, a ∈ o ∧ p a)

@[reducible]

def Option.iget {α : Type u_1} [Inhabited α] : Option α → α

Inhabited get function. Returns a if the input is some a, otherwise returns default.

theorem Option.iget_some {α : Type u_1} [Inhabited α] {a : α} : Option.iget (some a) = a

@[simp]

theorem Option.mem_toList {α : Type u_1} {a : α} {o : Option α} : a ∈ Option.toList o ↔ a ∈ o

instance Option.liftOrGet_isCommutative {α : Type u_1} (f : α → α → α) [IsCommutative α f] : IsCommutative (Option α) (Option.liftOrGet f)

instance Option.liftOrGet_isAssociative {α : Type u_1} (f : α → α → α) [IsAssociative α f] : IsAssociative (Option α) (Option.liftOrGet f)

instance Option.liftOrGet_isIdempotent {α : Type u_1} (f : α → α → α) [IsIdempotent α f] : IsIdempotent (Option α) (Option.liftOrGet f)

instance Option.liftOrGet_isLeftId {α : Type u_1} (f : α → α → α) : IsLeftId (Option α) (Option.liftOrGet f) none

instance Option.liftOrGet_isRightId {α : Type u_1} (f : α → α → α) : IsRightId (Option α) (Option.liftOrGet f) none

def Lean.LOption.toOption {α : Type u_3} : Lean.LOption α → Option α

Convert undef to none to make an LOption into an Option.