The type Vector represents lists with fixed length.

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

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

Equations

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

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

Equations

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

@[match_pattern]

def Vector.nil {α : Type u} : Vector α 0

The empty vector with elements of type α

Equations

• Vector.nil = ⟨[], ⋯⟩

@[match_pattern]

def Vector.cons {α : Type u} {n : ℕ} : α → Vector α n → 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

• Vector.cons x✝ x = match x✝, x with | a, ⟨v, h⟩ => ⟨a :: v, ⋯⟩

@[reducible]

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

The length of a vector.

Equations

• x.length = n

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

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

Equations

• x.head = match x with | ⟨a :: tail, property⟩ => a

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

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

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

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

Equations

• x.tail = match x with | ⟨[], h⟩ => ⟨[], ⋯⟩ | ⟨head :: v, h⟩ => ⟨v, ⋯⟩

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

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

@[simp]

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

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

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

The list obtained from a vector.

Equations

• v.toList = ↑v

def Vector.get {α : Type u} {n : ℕ} (l : 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 Vector.append {α : Type u} {n : ℕ} {m : ℕ} : Vector α n → Vector α m → Vector α (n + m)

Appending a vector to another.

Equations

• x✝.append x = match x✝, x with | ⟨l₁, h₁⟩, ⟨l₂, h₂⟩ => ⟨l₁ ++ l₂, ⋯⟩

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

Elimination rule for Vector.

Equations

• Vector.elim H x = match x with | ⟨l, h⟩ => match n, h with | .(l.length), ⋯ => H l

def Vector.map {α : Type u} {β : Type v} {n : ℕ} (f : α → β) : Vector α n → Vector β n

Map a vector under a function.

Equations

• Vector.map f x = match x with | ⟨l, h⟩ => ⟨List.map f l, ⋯⟩

@[simp]

theorem Vector.map_nil {α : Type u} {β : Type v} (f : α → β) : Vector.map f Vector.nil = Vector.nil

A nil vector maps to a nil vector.

@[simp]

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

map is natural with respect to cons.

def Vector.map₂ {α : Type u} {β : Type v} {φ : Type w} {n : ℕ} (f : α → β → φ) : Vector α n → Vector β n → Vector φ n

Mapping two vectors under a curried function of two variables.

Equations

• Vector.map₂ f x✝ x = match x✝, x with | ⟨x, property⟩, ⟨y, property_1⟩ => ⟨List.zipWith f x y, ⋯⟩

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

Vector obtained by repeating an element.

Equations

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

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

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

Equations

• Vector.drop i x = match x with | ⟨l, p⟩ => ⟨List.drop i l, ⋯⟩

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

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

Equations

• Vector.take i x = match x with | ⟨l, p⟩ => ⟨List.take i l, ⋯⟩

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

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

Equations

• Vector.eraseIdx i x = match x with | ⟨l, p⟩ => ⟨l.eraseIdx ↑i, ⋯⟩

@[deprecated Vector.eraseIdx]

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

Alias of Vector.eraseIdx.

---

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

Equations

• @Vector.removeNth = @Vector.eraseIdx

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

Vector of length n from a function on Fin n.

Equations

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

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

Create a vector from another with a provably equal length.

Equations

• Vector.congr h x = match x with | ⟨x, p⟩ => ⟨x, ⋯⟩

def Vector.mapAccumr {α : Type u} {β : Type v} {n : ℕ} {σ : Type} (f : α → σ → σ × β) : Vector α n → σ → σ × Vector β n

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

Equations

• Vector.mapAccumr f x✝ x = match x✝, x with | ⟨x, px⟩, c => let res := List.mapAccumr f x c; (res.1, ⟨res.2, ⋯⟩)

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

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

Equations

• Vector.mapAccumr₂ f x✝¹ x✝ x = match x✝¹, x✝, x with | ⟨x, px⟩, ⟨y, py⟩, c => let res := List.mapAccumr₂ f x y c; (res.1, ⟨res.2, ⋯⟩)

Shift Primitives

def Vector.shiftLeftFill {α : Type u} {n : ℕ} (v : Vector α n) (i : ℕ) (fill : α) : 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 = Vector.congr ⋯ ((Vector.drop i v).append (Vector.replicate (min n i) fill))

def Vector.shiftRightFill {α : Type u} {n : ℕ} (v : Vector α n) (i : ℕ) (fill : α) : 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 = Vector.congr ⋯ ((Vector.replicate (min n i) fill).append (Vector.take (n - i) v))

Basic Theorems

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

Vector is determined by the underlying list.

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

A vector of length 0 is a nil vector.

@[simp]

theorem Vector.toList_mk {α : Type u} {n : ℕ} (v : List α) (P : v.length = n) : 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 Vector.toList_nil {α : Type u} : Vector.nil.toList = []

A nil vector maps to a nil list.

@[simp]

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

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

@[simp]

theorem Vector.toList_cons {α : Type u} {n : ℕ} (a : α) (v : Vector α n) : (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 Vector.toList_append {α : Type u} {n : ℕ} {m : ℕ} (v : Vector α n) (w : Vector α m) : (v.append w).toList = v.toList ++ w.toList

Appending of vectors corresponds under toList to appending of lists.

@[simp]

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

drop of vectors corresponds under toList to drop of lists.

@[simp]

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

take of vectors corresponds under toList to take of lists.

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

Equations

• One or more equations did not get rendered due to their size.