The type List.Vector represents lists with fixed length.

TODO: The API of List.Vector is quite incomplete relative to Vector, and in particular does not use x[i] (that is GetElem notation) as the preferred accessor. Any combination of reducing the use of List.Vector in Mathlib, or modernising its API, would be welcome.

def List.Vector (α : Type u) (n : ℕ) : Type u

List.Vector α n is the type of lists of length n with elements of type α.

Note that there is also Vector α n in the root namespace, which is the type of arrays of length n with elements of type α.

Typically, if you are doing programming or verification, you will primarily use Vector α n, and if you are doing mathematics, you may want to use List.Vector α n instead.

Equations

• List.Vector α n = { l : List α // l.length = n }

instance List.Vector.instDecidableEq {α : Type u_1} {n : ℕ} [DecidableEq α] : DecidableEq (List.Vector α n)

Equations

• List.Vector.instDecidableEq = inferInstanceAs (DecidableEq { l : List α // l.length = n })

@[match_pattern]

def List.Vector.nil {α : Type u_1} : List.Vector α 0

The empty vector with elements of type α

Equations

• List.Vector.nil = ⟨[], ⋯⟩

@[match_pattern]

def List.Vector.cons {α : Type u_1} {n : ℕ} : α → List.Vector α n → List.Vector α n.succ

If a : α and l : Vector α n, then cons a l, is the vector of length n + 1 whose first element is a and with l as the rest of the list.

Equations

• List.Vector.cons x✝ ⟨v, h⟩ = ⟨x✝ :: v, ⋯⟩

@[reducible]

def List.Vector.length {α : Type u_1} {n : ℕ} : List.Vector α n → ℕ

The length of a vector.

Equations

• x✝.length = n

def List.Vector.head {α : Type u_1} {n : ℕ} : List.Vector α n.succ → α

The first element of a vector with length at least 1.

Equations

• List.Vector.head ⟨a :: tail, property⟩ = a

theorem List.Vector.head_cons {α : Type u_1} {n : ℕ} (a : α) (v : List.Vector α n) : (List.Vector.cons a v).head = a

The head of a vector obtained by prepending is the element prepended.

def List.Vector.tail {α : Type u_1} {n : ℕ} : List.Vector α n → List.Vector α (n - 1)

The tail of a vector, with an empty vector having empty tail.

Equations

• List.Vector.tail ⟨[], h⟩ = ⟨[], ⋯⟩
• List.Vector.tail ⟨head :: v, h⟩ = ⟨v, ⋯⟩

theorem List.Vector.tail_cons {α : Type u_1} {n : ℕ} (a : α) (v : List.Vector α n) : (List.Vector.cons a v).tail = v

The tail of a vector obtained by prepending is the vector prepended. to

@[simp]

theorem List.Vector.cons_head_tail {α : Type u_1} {n : ℕ} (v : List.Vector α n.succ) : List.Vector.cons v.head v.tail = v

Prepending the head of a vector to its tail gives the vector.

def List.Vector.toList {α : Type u_1} {n : ℕ} (v : List.Vector α n) : List α

The list obtained from a vector.

Equations

• v.toList = ↑v

def List.Vector.get {α : Type u_1} {n : ℕ} (l : List.Vector α n) (i : Fin n) : α

nth element of a vector, indexed by a Fin type.

Equations

• l.get i = (↑l).get (Fin.cast ⋯ i)

def List.Vector.append {α : Type u_1} {n m : ℕ} : List.Vector α n → List.Vector α m → List.Vector α (n + m)

Appending a vector to another.

Equations

• List.Vector.append ⟨l₁, h₁⟩ ⟨l₂, h₂⟩ = ⟨l₁ ++ l₂, ⋯⟩

def List.Vector.elim {α : Type u_5} {C : {n : ℕ} → List.Vector α n → Sort u} (H : (l : List α) → C ⟨l, ⋯⟩) {n : ℕ} (v : List.Vector α n) : C v

Elimination rule for Vector.

Equations

• List.Vector.elim H ⟨l, ⋯⟩ = H l

def List.Vector.map {α : Type u_1} {β : Type u_2} {n : ℕ} (f : α → β) : List.Vector α n → List.Vector β n

Map a vector under a function.

Equations

• List.Vector.map f ⟨l, h⟩ = ⟨List.map f l, ⋯⟩

@[simp]

theorem List.Vector.map_nil {α : Type u_1} {β : Type u_2} (f : α → β) : List.Vector.map f List.Vector.nil = List.Vector.nil

A nil vector maps to a nil vector.

@[simp]

theorem List.Vector.map_cons {α : Type u_1} {β : Type u_2} {n : ℕ} (f : α → β) (a : α) (v : List.Vector α n) : List.Vector.map f (List.Vector.cons a v) = List.Vector.cons (f a) (List.Vector.map f v)

map is natural with respect to cons.

def List.Vector.pmap {α : Type u_1} {β : Type u_2} {n : ℕ} {p : α → Prop} (f : (a : α) → p a → β) (v : List.Vector α n) : (∀ (x : α), x ∈ v.toList → p x) → List.Vector β n

Map a vector under a partial function.

Equations

• List.Vector.pmap f ⟨l, h⟩ hp = ⟨List.pmap f l hp, ⋯⟩

@[simp]

theorem List.Vector.pmap_nil {α : Type u_1} {β : Type u_2} {p : α → Prop} (f : (a : α) → p a → β) (hp : ∀ (x : α), x ∈ List.Vector.nil.toList → p x) : List.Vector.pmap f List.Vector.nil hp = List.Vector.nil

def List.Vector.map₂ {α : Type u_1} {β : Type u_2} {φ : Type u_4} {n : ℕ} (f : α → β → φ) : List.Vector α n → List.Vector β n → List.Vector φ n

Mapping two vectors under a curried function of two variables.

Equations

• List.Vector.map₂ f ⟨x_2, property⟩ ⟨y, property_1⟩ = ⟨List.zipWith f x_2 y, ⋯⟩

def List.Vector.replicate {α : Type u_1} (n : ℕ) (a : α) : List.Vector α n

Vector obtained by repeating an element.

Equations

• List.Vector.replicate n a = ⟨List.replicate n a, ⋯⟩

def List.Vector.drop {α : Type u_1} {n : ℕ} (i : ℕ) : List.Vector α n → List.Vector α (n - i)

Drop i elements from a vector of length n; we can have i > n.

Equations

• List.Vector.drop i ⟨l, h⟩ = ⟨List.drop i l, ⋯⟩

def List.Vector.take {α : Type u_1} {n : ℕ} (i : ℕ) : List.Vector α n → List.Vector α (min i n)

Take i elements from a vector of length n; we can have i > n.

Equations

• List.Vector.take i ⟨l, h⟩ = ⟨List.take i l, ⋯⟩

def List.Vector.eraseIdx {α : Type u_1} {n : ℕ} (i : Fin n) : List.Vector α n → List.Vector α (n - 1)

Remove the element at position i from a vector of length n.

Equations

• List.Vector.eraseIdx i ⟨l, h⟩ = ⟨l.eraseIdx ↑i, ⋯⟩

@[deprecated List.Vector.eraseIdx (since := "2024-05-04")]

def List.Vector.removeNth {α : Type u_1} {n : ℕ} (i : Fin n) : List.Vector α n → List.Vector α (n - 1)

Alias of List.Vector.eraseIdx.

---

Remove the element at position i from a vector of length n.

Equations

• @List.Vector.removeNth = @List.Vector.eraseIdx

def List.Vector.ofFn {α : Type u_1} {n : ℕ} : (Fin n → α) → List.Vector α n

Vector of length n from a function on Fin n.

Equations

• List.Vector.ofFn x_2 = List.Vector.nil
• List.Vector.ofFn f = List.Vector.cons (f 0) (List.Vector.ofFn fun (i : Fin n) => f i.succ)

def List.Vector.congr {α : Type u_1} {n m : ℕ} (h : n = m) : List.Vector α n → List.Vector α m

Create a vector from another with a provably equal length.

Equations

• List.Vector.congr h ⟨l, h_1⟩ = ⟨l, ⋯⟩

def List.Vector.mapAccumr {α : Type u_1} {β : Type u_2} {σ : Type u_3} {n : ℕ} (f : α → σ → σ × β) : List.Vector α n → σ → σ × List.Vector β n

Runs a function over a vector returning the intermediate results and a final result.

Equations

• List.Vector.mapAccumr f ⟨x_2, px⟩ x✝ = ((List.mapAccumr f x_2 x✝).fst, ⟨(List.mapAccumr f x_2 x✝).snd, ⋯⟩)

def List.Vector.mapAccumr₂ {α : Type u_1} {β : Type u_2} {σ : Type u_3} {φ : Type u_4} {n : ℕ} (f : α → β → σ → σ × φ) : List.Vector α n → List.Vector β n → σ → σ × List.Vector φ n

Runs a function over a pair of vectors returning the intermediate results and a final result.

Equations

• List.Vector.mapAccumr₂ f ⟨x_3, px⟩ ⟨y, py⟩ x✝ = ((List.mapAccumr₂ f x_3 y x✝).fst, ⟨(List.mapAccumr₂ f x_3 y x✝).snd, ⋯⟩)

Shift Primitives

def List.Vector.shiftLeftFill {α : Type u_1} {n : ℕ} (v : List.Vector α n) (i : ℕ) (fill : α) : List.Vector α n

shiftLeftFill v i is the vector obtained by left-shifting v i times and padding with the fill argument. If v.length < i then this will return replicate n fill.

Equations

• v.shiftLeftFill i fill = List.Vector.congr ⋯ ((List.Vector.drop i v).append (List.Vector.replicate (min n i) fill))

def List.Vector.shiftRightFill {α : Type u_1} {n : ℕ} (v : List.Vector α n) (i : ℕ) (fill : α) : List.Vector α n

shiftRightFill v i is the vector obtained by right-shifting v i times and padding with the fill argument. If v.length < i then this will return replicate n fill.

Equations

• v.shiftRightFill i fill = List.Vector.congr ⋯ ((List.Vector.replicate (min n i) fill).append (List.Vector.take (n - i) v))

Basic Theorems

theorem List.Vector.eq {α : Type u_1} {n : ℕ} (a1 a2 : List.Vector α n) : a1.toList = a2.toList → a1 = a2

Vector is determined by the underlying list.

theorem List.Vector.eq_nil {α : Type u_1} (v : List.Vector α 0) : v = List.Vector.nil

A vector of length 0 is a nil vector.

@[simp]

theorem List.Vector.toList_mk {α : Type u_1} {n : ℕ} (v : List α) (P : v.length = n) : List.Vector.toList ⟨v, P⟩ = v

Vector of length from a list v with witness that v has length n maps to v under toList.

@[simp]

theorem List.Vector.toList_nil {α : Type u_1} : List.Vector.nil.toList = []

A nil vector maps to a nil list.

@[simp]

theorem List.Vector.toList_length {α : Type u_1} {n : ℕ} (v : List.Vector α n) : v.toList.length = n

The length of the list to which a vector of length n maps is n.

@[simp]

theorem List.Vector.toList_cons {α : Type u_1} {n : ℕ} (a : α) (v : List.Vector α n) : (List.Vector.cons a v).toList = a :: v.toList

toList of cons of a vector and an element is the cons of the list obtained by toList and the element

@[simp]

theorem List.Vector.toList_append {α : Type u_1} {n m : ℕ} (v : List.Vector α n) (w : List.Vector α m) : (v.append w).toList = v.toList ++ w.toList

Appending of vectors corresponds under toList to appending of lists.

@[simp]

theorem List.Vector.toList_drop {α : Type u_1} {n m : ℕ} (v : List.Vector α m) : (List.Vector.drop n v).toList = List.drop n v.toList

drop of vectors corresponds under toList to drop of lists.

@[simp]

theorem List.Vector.toList_take {α : Type u_1} {n m : ℕ} (v : List.Vector α m) : (List.Vector.take n v).toList = List.take n v.toList

take of vectors corresponds under toList to take of lists.

instance List.Vector.instGetElemNatLt {α : Type u_1} {n : ℕ} : GetElem (List.Vector α n) ℕ α fun (x : List.Vector α n) (i : ℕ) => i < n

Equations

• List.Vector.instGetElemNatLt = { getElem := fun (x : List.Vector α n) (i : ℕ) (h : i < n) => x.get ⟨i, h⟩ }

theorem List.Vector.getElem_def {α : Type u_1} {n : ℕ} (v : List.Vector α n) (i : ℕ) {hi : i < n} : v[i] = v.toList[i]

theorem List.Vector.toList_getElem {α : Type u_1} {n : ℕ} (v : List.Vector α n) (i : ℕ) {hi : i < v.toList.length} : v.toList[i] = v[i]