mathlib documentation

data.​fin

data.​fin

The finite type with n elements

fin n is the type whose elements are natural numbers smaller than n. This file expands on the development in the core library.

Main definitions

Induction principles

Casts

Operation on tuples

We interpret maps Π i : fin n, α i as tuples (α 0, …, α (n-1)). If α i is a constant map, then tuples are isomorphic (but not definitionally equal) to vectors.

We define the following operations:

Misc definitions

def fin_zero_elim {α : fin 0Sort u} (x : fin 0) :
α x

Elimination principle for the empty set fin 0, dependent version.

Equations
theorem fact.​succ.​pos {n : } :
fact (0 < n.succ)

theorem fact.​bit0.​pos {n : } [h : fact (0 < n)] :
fact (0 < bit0 n)

theorem fact.​bit1.​pos {n : } :
fact (0 < bit1 n)

theorem fact.​pow.​pos {p n : } [h : fact (0 < p)] :
fact (0 < p ^ n)

def fin.​of_nat' {n : } [h : fact (0 < n)] :
fin n

convert a to fin n, provided n is positive

Equations
@[simp]
theorem fin.​eta {n : } (a : fin n) (h : a.val < n) :
a.val, h⟩ = a

theorem fin.​ext_iff {n : } (a b : fin n) :
a = b a.val = b.val

theorem fin.​eq_iff_veq {n : } (a b : fin n) :
a = b a.val = b.val

@[simp]
theorem fin.​mk.​inj_iff {n a b : } {ha : a < n} {hb : b < n} :
a, ha⟩ = b, hb⟩ a = b

@[instance]
def fin.​fin_to_nat (n : ) :

Equations
theorem fin.​mk_val {m n : } (h : m < n) :
m, h⟩.val = m

@[simp]
theorem fin.​coe_mk {m n : } (h : m < n) :
m, h⟩ = m

theorem fin.​coe_eq_val {n : } (a : fin n) :
a = a.val

@[simp]
theorem fin.​val_one {n : } :
1.val = 1

@[simp]
theorem fin.​val_two {n : } :
2.val = 2

@[simp]
theorem fin.​coe_zero {n : } :
0 = 0

@[simp]
theorem fin.​coe_one {n : } :
1 = 1

@[simp]
theorem fin.​coe_two {n : } :
2 = 2

@[simp]
theorem fin.​coe_fin_lt {n : } {a b : fin n} :
a < b a < b

a < b as natural numbers if and only if a < b in fin n.

@[simp]
theorem fin.​coe_fin_le {n : } {a b : fin n} :
a b a b

a ≤ b as natural numbers if and only if a ≤ b in fin n.

theorem fin.​val_add {n : } (a b : fin n) :
(a + b).val = (a.val + b.val) % n

theorem fin.​val_mul {n : } (a b : fin n) :
(a * b).val = a.val * b.val % n

theorem fin.​one_val {n : } :
1.val = 1 % (n + 1)

@[simp]
theorem fin.​zero_val (n : ) :
0.val = 0

@[simp]
theorem fin.​of_nat_eq_coe (n a : ) :

theorem fin.​coe_val_of_lt {n a : } :
a < n + 1a.val = a

Converting an in-range number to fin (n + 1) produces a result whose value is the original number.

@[simp]
theorem fin.​coe_val_eq_self {n : } (a : fin (n + 1)) :
(a.val) = a

Converting the value of a fin (n + 1) to fin (n + 1) results in the same value.

theorem fin.​coe_coe_of_lt {n a : } :
a < n + 1a = a

Coercing an in-range number to fin (n + 1), and converting back to , results in that number.

@[simp]
theorem fin.​coe_coe_eq_self {n : } (a : fin (n + 1)) :

Converting a fin (n + 1) to and back results in the same value.

theorem fin.​heq_fun_iff {α : Type u_1} {k l : } (h : k = l) {f : fin k → α} {g : fin l → α} :
f == g ∀ (i : fin k), f i = g i.val, _⟩

Assume k = l. If two functions defined on fin k and fin l are equal on each element, then they coincide (in the heq sense).

theorem fin.​heq_ext_iff {k l : } (h : k = l) {i : fin k} {j : fin l} :
i == j i.val = j.val

theorem fin.​exists_iff {n : } {p : fin n → Prop} :
(∃ (i : fin n), p i) ∃ (i : ) (h : i < n), p i, h⟩

theorem fin.​forall_iff {n : } {p : fin n → Prop} :
(∀ (i : fin n), p i) ∀ (i : ) (h : i < n), p i, h⟩

theorem fin.​zero_le {n : } (a : fin (n + 1)) :
0 a

theorem fin.​lt_iff_val_lt_val {n : } {a b : fin n} :
a < b a.val < b.val

theorem fin.​le_iff_val_le_val {n : } {a b : fin n} :
a b a.val b.val

@[simp]
theorem fin.​succ_val {n : } (j : fin n) :

theorem fin.​succ.​inj {n : } {a b : fin n} :
a.succ = b.succa = b

@[simp]
theorem fin.​succ_inj {n : } {a b : fin n} :
a.succ = b.succ a = b

theorem fin.​succ_ne_zero {n : } (k : fin n) :
k.succ 0

@[simp]
theorem fin.​pred_val {n : } (j : fin (n + 1)) (h : j 0) :
(j.pred h).val = j.val.pred

@[simp]
theorem fin.​succ_pred {n : } (i : fin (n + 1)) (h : i 0) :
(i.pred h).succ = i

@[simp]
theorem fin.​pred_succ {n : } (i : fin n) {h : i.succ 0} :
i.succ.pred h = i

@[simp]
theorem fin.​pred_inj {n : } {a b : fin (n + 1)} {ha : a 0} {hb : b 0} :
a.pred ha = b.pred hb a = b

def fin.​last (n : ) :
fin (n + 1)

The greatest value of fin (n+1)

Equations
def fin.​cast_lt {n m : } (i : fin m) :
i.val < nfin n

cast_lt i h embeds i into a fin where h proves it belongs into.

Equations
def fin.​cast_le {n m : } :
n mfin nfin m

cast_le h i embeds i into a larger fin type.

Equations
def fin.​cast {n m : } :
n = mfin nfin m

cast eq i embeds i into a equal fin type.

Equations
def fin.​cast_add {n : } (m : ) :
fin nfin (n + m)

cast_add m i embeds i : fin n in fin (n+m).

Equations
def fin.​cast_succ {n : } :
fin nfin (n + 1)

cast_succ i embeds i : fin n in fin (n+1).

Equations
def fin.​succ_above {n : } :
fin (n + 1)fin nfin (n + 1)

succ_above p i embeds fin n into fin (n + 1) with a hole around p.

Equations
def fin.​pred_above {n : } (p i : fin (n + 1)) :
i pfin n

pred_above p i h embeds i : fin (n+1) into fin n by ignoring p.

Equations
def fin.​sub_nat {n : } (m : ) (i : fin (n + m)) :
m i.valfin n

sub_nat i h subtracts m from i, generalizes fin.pred.

Equations
def fin.​add_nat {n : } (m : ) :
fin nfin (n + m)

add_nat i h adds m on i, generalizes fin.succ.

Equations
def fin.​nat_add (n : ) {m : } :
fin mfin (n + m)

nat_add i h adds n on i

Equations
theorem fin.​le_last {n : } (i : fin (n + 1)) :

@[simp]
theorem fin.​cast_val {n m : } (k : fin n) (h : n = m) :
(fin.cast h k).val = k.val

@[simp]
theorem fin.​cast_succ_val {n : } (k : fin n) :

@[simp]
theorem fin.​cast_lt_val {n m : } (k : fin m) (h : k.val < n) :
(k.cast_lt h).val = k.val

@[simp]
theorem fin.​cast_le_val {n m : } (k : fin m) (h : m n) :

@[simp]
theorem fin.​cast_add_val {n m : } (k : fin m) :

@[simp]
theorem fin.​last_val (n : ) :
(fin.last n).val = n

@[simp]
theorem fin.​coe_last {n : } :

@[simp]
theorem fin.​succ_last (n : ) :

@[simp]
theorem fin.​cast_succ_cast_lt {n : } (i : fin (n + 1)) (h : i.val < n) :

@[simp]
theorem fin.​cast_lt_cast_succ {n : } (a : fin n) (h : a.val < n) :

@[simp]
theorem fin.​sub_nat_val {n m : } (i : fin (n + m)) (h : m i.val) :
(fin.sub_nat m i h).val = i.val - m

@[simp]
theorem fin.​add_nat_val {n m : } (i : fin (n + m)) :
(fin.add_nat m i).val = i.val + m

@[simp]
theorem fin.​cast_succ_inj {n : } {a b : fin n} :

theorem fin.​eq_last_of_not_lt {n : } {i : fin (n + 1)} :
¬i.val < ni = fin.last n

def fin.​clamp (n m : ) :
fin (m + 1)

min n m as an element of fin (m + 1)

Equations
@[simp]
theorem fin.​clamp_val (n m : ) :
(fin.clamp n m).val = min n m

theorem fin.​cast_le_injective {n₁ n₂ : } (h : n₁ n₂) :

theorem fin.​succ_above_ne {n : } (p : fin (n + 1)) (i : fin n) :

@[simp]
theorem fin.​succ_above_descend {n : } (p i : fin (n + 1)) (h : i p) :
p.succ_above (p.pred_above i h) = i

@[simp]
theorem fin.​pred_above_succ_above {n : } (p : fin (n + 1)) (i : fin n) (h : p.succ_above i p) :
p.pred_above (p.succ_above i) h = i

theorem fin.​strict_mono_iff_lt_succ {n : } {α : Type u_1} [preorder α] {f : fin n → α} :
strict_mono f ∀ (i : ) (h : i + 1 < n), f i, _⟩ < f i + 1, h⟩

A function f on fin n is strictly monotone if and only if f i < f (i+1) for all i.

def fin.​succ_rec {C : Π (n : ), fin nSort u_1} (H0 : Π (n : ), C n.succ 0) (Hs : Π (n : ) (i : fin n), C n iC n.succ i.succ) {n : } (i : fin n) :
C n i

Define C n i by induction on i : fin n interpreted as (0 : fin (n - i)).succ.succ…. This function has two arguments: H0 n defines 0-th element C (n+1) 0 of an (n+1)-tuple, and Hs n i defines (i+1)-st element of (n+1)-tuple based on n, i, and i-th element of n-tuple.

Equations
def fin.​succ_rec_on {n : } (i : fin n) {C : Π (n : ), fin nSort u_1} :
(Π (n : ), C n.succ 0)(Π (n : ) (i : fin n), C n iC n.succ i.succ)C n i

Define C n i by induction on i : fin n interpreted as (0 : fin (n - i)).succ.succ…. This function has two arguments: H0 n defines 0-th element C (n+1) 0 of an (n+1)-tuple, and Hs n i defines (i+1)-st element of (n+1)-tuple based on n, i, and i-th element of n-tuple.

A version of fin.succ_rec taking i : fin n as the first argument.

Equations
@[simp]
theorem fin.​succ_rec_on_zero {C : Π (n : ), fin nSort u_1} {H0 : Π (n : ), C n.succ 0} {Hs : Π (n : ) (i : fin n), C n iC n.succ i.succ} (n : ) :
0.succ_rec_on H0 Hs = H0 n

@[simp]
theorem fin.​succ_rec_on_succ {C : Π (n : ), fin nSort u_1} {H0 : Π (n : ), C n.succ 0} {Hs : Π (n : ) (i : fin n), C n iC n.succ i.succ} {n : } (i : fin n) :
i.succ.succ_rec_on H0 Hs = Hs n i (i.succ_rec_on H0 Hs)

def fin.​cases {n : } {C : fin n.succSort u_1} (H0 : C 0) (Hs : Π (i : fin n), C i.succ) (i : fin n.succ) :
C i

Define f : Π i : fin n.succ, C i by separately handling the cases i = 0 and i = j.succ, j : fin n.

Equations
@[simp]
theorem fin.​cases_zero {n : } {C : fin n.succSort u_1} {H0 : C 0} {Hs : Π (i : fin n), C i.succ} :
fin.cases H0 Hs 0 = H0

@[simp]
theorem fin.​cases_succ {n : } {C : fin n.succSort u_1} {H0 : C 0} {Hs : Π (i : fin n), C i.succ} (i : fin n) :
fin.cases H0 Hs i.succ = Hs i

theorem fin.​forall_fin_succ {n : } {P : fin (n + 1) → Prop} :
(∀ (i : fin (n + 1)), P i) P 0 ∀ (i : fin n), P i.succ

theorem fin.​exists_fin_succ {n : } {P : fin (n + 1) → Prop} :
(∃ (i : fin (n + 1)), P i) P 0 ∃ (i : fin n), P i.succ

Tuples

We can think of the type Π(i : fin n), α i as n-tuples of elements of possibly varying type α i. A particular case is fin n → α of elements with all the same type. Here are some relevant operations, first about adding or removing elements at the beginning of a tuple.

@[instance]
def fin.​tuple0_unique (α : fin 0Type u) :
unique (Π (i : fin 0), α i)

There is exactly one tuple of size zero.

Equations
def fin.​tail {n : } {α : fin (n + 1)Type u} (q : Π (i : fin (n + 1)), α i) (i : fin n) :
α i.succ

The tail of an n+1 tuple, i.e., its last n entries

Equations
def fin.​cons {n : } {α : fin (n + 1)Type u} (x : α 0) (p : Π (i : fin n), α i.succ) (i : fin (n + 1)) :
α i

Adding an element at the beginning of an n-tuple, to get an n+1-tuple

Equations
@[simp]
theorem fin.​tail_cons {n : } {α : fin (n + 1)Type u} (x : α 0) (p : Π (i : fin n), α i.succ) :

@[simp]
theorem fin.​cons_succ {n : } {α : fin (n + 1)Type u} (x : α 0) (p : Π (i : fin n), α i.succ) (i : fin n) :
fin.cons x p i.succ = p i

@[simp]
theorem fin.​cons_zero {n : } {α : fin (n + 1)Type u} (x : α 0) (p : Π (i : fin n), α i.succ) :
fin.cons x p 0 = x

@[simp]
theorem fin.​cons_update {n : } {α : fin (n + 1)Type u} (x : α 0) (p : Π (i : fin n), α i.succ) (i : fin n) (y : α i.succ) :

Updating a tuple and adding an element at the beginning commute.

theorem fin.​update_cons_zero {n : } {α : fin (n + 1)Type u} (x : α 0) (p : Π (i : fin n), α i.succ) (z : α 0) :

Adding an element at the beginning of a tuple and then updating it amounts to adding it directly.

@[simp]
theorem fin.​cons_self_tail {n : } {α : fin (n + 1)Type u} (q : Π (i : fin (n + 1)), α i) :
fin.cons (q 0) (fin.tail q) = q

Concatenating the first element of a tuple with its tail gives back the original tuple

@[simp]
theorem fin.​tail_update_zero {n : } {α : fin (n + 1)Type u} (q : Π (i : fin (n + 1)), α i) (z : α 0) :

Updating the first element of a tuple does not change the tail.

@[simp]
theorem fin.​tail_update_succ {n : } {α : fin (n + 1)Type u} (q : Π (i : fin (n + 1)), α i) (i : fin n) (y : α i.succ) :

Updating a nonzero element and taking the tail commute.

theorem fin.​comp_cons {n : } {α : Type u_1} {β : Type u_2} (g : α → β) (y : α) (q : fin n → α) :
g fin.cons y q = fin.cons (g y) (g q)

theorem fin.​comp_tail {n : } {α : Type u_1} {β : Type u_2} (g : α → β) (q : fin n.succ → α) :

In the previous section, we have discussed inserting or removing elements on the left of a tuple. In this section, we do the same on the right. A difference is that fin (n+1) is constructed inductively from fin n starting from the left, not from the right. This implies that Lean needs more help to realize that elements belong to the right types, i.e., we need to insert casts at several places.

def fin.​init {n : } {α : fin (n + 1)Type u} (q : Π (i : fin (n + 1)), α i) (i : fin n) :

The beginning of an n+1 tuple, i.e., its first n entries

Equations
def fin.​snoc {n : } {α : fin (n + 1)Type u} (p : Π (i : fin n), α i.cast_succ) (x : α (fin.last n)) (i : fin (n + 1)) :
α i

Adding an element at the end of an n-tuple, to get an n+1-tuple. The name snoc comes from cons (i.e., adding an element to the left of a tuple) read in reverse order.

Equations
@[simp]
theorem fin.​init_snoc {n : } {α : fin (n + 1)Type u} (x : α (fin.last n)) (p : Π (i : fin n), α i.cast_succ) :

@[simp]
theorem fin.​snoc_cast_succ {n : } {α : fin (n + 1)Type u} (x : α (fin.last n)) (p : Π (i : fin n), α i.cast_succ) (i : fin n) :
fin.snoc p x i.cast_succ = p i

@[simp]
theorem fin.​snoc_last {n : } {α : fin (n + 1)Type u} (x : α (fin.last n)) (p : Π (i : fin n), α i.cast_succ) :
fin.snoc p x (fin.last n) = x

@[simp]
theorem fin.​snoc_update {n : } {α : fin (n + 1)Type u} (x : α (fin.last n)) (p : Π (i : fin n), α i.cast_succ) (i : fin n) (y : α i.cast_succ) :

Updating a tuple and adding an element at the end commute.

theorem fin.​update_snoc_last {n : } {α : fin (n + 1)Type u} (x : α (fin.last n)) (p : Π (i : fin n), α i.cast_succ) (z : α (fin.last n)) :

Adding an element at the beginning of a tuple and then updating it amounts to adding it directly.

@[simp]
theorem fin.​snoc_init_self {n : } {α : fin (n + 1)Type u} (q : Π (i : fin (n + 1)), α i) :
fin.snoc (fin.init q) (q (fin.last n)) = q

Concatenating the first element of a tuple with its tail gives back the original tuple

@[simp]
theorem fin.​init_update_last {n : } {α : fin (n + 1)Type u} (q : Π (i : fin (n + 1)), α i) (z : α (fin.last n)) :

Updating the last element of a tuple does not change the beginning.

@[simp]
theorem fin.​init_update_cast_succ {n : } {α : fin (n + 1)Type u} (q : Π (i : fin (n + 1)), α i) (i : fin n) (y : α i.cast_succ) :

Updating an element and taking the beginning commute.

theorem fin.​tail_init_eq_init_tail {n : } {β : Type u_1} (q : fin (n + 2) → β) :

tail and init commute. We state this lemma in a non-dependent setting, as otherwise it would involve a cast to convince Lean that the two types are equal, making it harder to use.

theorem fin.​cons_snoc_eq_snoc_cons {n : } {β : Type u_1} (a : β) (q : fin n → β) (b : β) :

cons and snoc commute. We state this lemma in a non-dependent setting, as otherwise it would involve a cast to convince Lean that the two types are equal, making it harder to use.

theorem fin.​comp_snoc {n : } {α : Type u_1} {β : Type u_2} (g : α → β) (q : fin n → α) (y : α) :
g fin.snoc q y = fin.snoc (g q) (g y)

theorem fin.​comp_init {n : } {α : Type u_1} {β : Type u_2} (g : α → β) (q : fin n.succ → α) :

def fin.​find {n : } (p : fin n → Prop) [decidable_pred p] :

find p returns the first index n where p n is satisfied, and none if it is never satisfied.

Equations
theorem fin.​find_spec {n : } (p : fin n → Prop) [decidable_pred p] {i : fin n} :
i fin.find pp i

If find p = some i, then p i holds

theorem fin.​is_some_find_iff {n : } {p : fin n → Prop} [decidable_pred p] :
((fin.find p).is_some) ∃ (i : fin n), p i

find p does not return none if and only if p i holds at some index i.

theorem fin.​find_eq_none_iff {n : } {p : fin n → Prop} [decidable_pred p] :
fin.find p = option.none ∀ (i : fin n), ¬p i

find p returns none if and only if p i never holds.

theorem fin.​find_min {n : } {p : fin n → Prop} [decidable_pred p] {i : fin n} (hi : i fin.find p) {j : fin n} :
j < i¬p j

If find p returns some i, then p j does not hold for j < i, i.e., i is minimal among the indices where p holds.

theorem fin.​find_min' {n : } {p : fin n → Prop} [decidable_pred p] {i : fin n} (h : i fin.find p) {j : fin n} :
p ji j

theorem fin.​nat_find_mem_find {n : } {p : fin n → Prop} [decidable_pred p] (h : ∃ (i : ) (hin : i < n), p i, hin⟩) :

theorem fin.​mem_find_iff {n : } {p : fin n → Prop} [decidable_pred p] {i : fin n} :
i fin.find p p i ∀ (j : fin n), p ji j

theorem fin.​find_eq_some_iff {n : } {p : fin n → Prop} [decidable_pred p] {i : fin n} :
fin.find p = option.some i p i ∀ (j : fin n), p ji j

theorem fin.​mem_find_of_unique {n : } {p : fin n → Prop} [decidable_pred p] (h : ∀ (i j : fin n), p ip ji = j) {i : fin n} :
p ii fin.find p

@[simp]
theorem fin.​val_of_nat_eq_mod (m n : ) :
n = n % m.succ

@[simp]
theorem fin.​val_of_nat_eq_mod' (m n : ) [I : fact (0 < m)] :
(fin.of_nat' n).val = n % m

Embedding of fin n into .

Equations