Red-black trees

This module implements a type RBMap α β cmp which is a functional data structure for storing a key-value store in a binary search tree.

It is built on the simpler RBSet α cmp type, which stores a set of values of type α using the function cmp : α → α → Ordering for determining the ordering relation. The tree will never store two elements that compare .eq under the cmp function, but the function does not have to satisfy cmp x y = .eq → x = y, and in the map case α is a key-value pair and the cmp function only compares the keys.

inductive Batteries.RBColor : Type

In a red-black tree, every node has a color which is either "red" or "black" (this particular choice of colors is conventional). A nil node is considered black.

• red: Batteries.RBColor

  A red node is required to have black children.

• black: Batteries.RBColor

  Every path from the root to a leaf must pass through the same number of black nodes.

instance Batteries.instReprRBColor : Repr Batteries.RBColor

Equations

• Batteries.instReprRBColor = { reprPrec := Batteries.reprRBColor✝ }

inductive Batteries.RBNode (α : Type u) : Type u

A red-black tree. (This is an internal implementation detail of the RBSet type, which includes the invariants of the tree.) This is a binary search tree augmented with a "color" field which is either red or black for each node and used to implement the re-balancing operations. See: Red–black tree

• nil: {α : Type u} → Batteries.RBNode α

  An empty tree.

• node: {α : Type u} → Batteries.RBColor → Batteries.RBNode α → α → Batteries.RBNode α → Batteries.RBNode α

  A node consists of a value v, a subtree l of smaller items, and a subtree r of larger items. The color c is either red or black and participates in the red-black balance invariant (see Balanced).

instance Batteries.instReprRBNode : {α : Type u_1} → [inst : Repr α] → Repr (Batteries.RBNode α)

Equations

• Batteries.instReprRBNode = { reprPrec := Batteries.reprRBNode✝ }

instance Batteries.RBNode.instEmptyCollection {α : Type u_1} : EmptyCollection (Batteries.RBNode α)

Equations

• Batteries.RBNode.instEmptyCollection = { emptyCollection := Batteries.RBNode.nil }

def Batteries.RBNode.min? {α : Type u_1} : Batteries.RBNode α → Option α

The minimum element of a tree is the left-most value.

Equations

• Batteries.RBNode.nil.min? = none
• (Batteries.RBNode.node c Batteries.RBNode.nil v r).min? = some v
• (Batteries.RBNode.node c l v r).min? = l.min?

def Batteries.RBNode.max? {α : Type u_1} : Batteries.RBNode α → Option α

The maximum element of a tree is the right-most value.

Equations

• Batteries.RBNode.nil.max? = none
• (Batteries.RBNode.node c l v Batteries.RBNode.nil).max? = some v
• (Batteries.RBNode.node c l v r).max? = r.max?

@[deprecated Batteries.RBNode.min?]

def Batteries.RBNode.min {α : Type u_1} : Batteries.RBNode α → Option α

Alias of Batteries.RBNode.min?.

---

The minimum element of a tree is the left-most value.

Equations

• @Batteries.RBNode.min = @Batteries.RBNode.min?

@[deprecated Batteries.RBNode.max?]

def Batteries.RBNode.max {α : Type u_1} : Batteries.RBNode α → Option α

Alias of Batteries.RBNode.max?.

---

The maximum element of a tree is the right-most value.

Equations

• @Batteries.RBNode.max = @Batteries.RBNode.max?

@[specialize #[]]

def Batteries.RBNode.fold {σ : Sort u_1} {α : Type u_2} (v₀ : σ) (f : σ → α → σ → σ) : Batteries.RBNode α → σ

Fold a function in tree order along the nodes. v₀ is used at nil nodes and f is used to combine results at branching nodes.

Equations

• Batteries.RBNode.fold v₀ f Batteries.RBNode.nil = v₀
• Batteries.RBNode.fold v₀ f (Batteries.RBNode.node a a_1 a_2 a_3) = f (Batteries.RBNode.fold v₀ f a_1) a_2 (Batteries.RBNode.fold v₀ f a_3)

@[specialize #[]]

def Batteries.RBNode.foldl {σ : Sort u_1} {α : Type u_2} (f : σ → α → σ) (init : σ) : Batteries.RBNode α → σ

Fold a function on the values from left to right (in increasing order).

Equations

• Batteries.RBNode.foldl f x Batteries.RBNode.nil = x
• Batteries.RBNode.foldl f x (Batteries.RBNode.node c l v r) = Batteries.RBNode.foldl f (f (Batteries.RBNode.foldl f x l) v) r

@[specialize #[]]

def Batteries.RBNode.foldr {α : Type u_1} {σ : Sort u_2} (f : α → σ → σ) : Batteries.RBNode α → σ → σ

Fold a function on the values from right to left (in decreasing order).

Equations

• Batteries.RBNode.foldr f Batteries.RBNode.nil x = x
• Batteries.RBNode.foldr f (Batteries.RBNode.node c l v r) x = Batteries.RBNode.foldr f l (f v (Batteries.RBNode.foldr f r x))

def Batteries.RBNode.toList {α : Type u_1} (t : Batteries.RBNode α) : List α

O(n). Convert the tree to a list in ascending order.

Equations

• t.toList = Batteries.RBNode.foldr (fun (x1 : α) (x2 : List α) => x1 :: x2) t []

@[specialize #[]]

def Batteries.RBNode.forM {m : Type u_1 → Type u_2} {α : Type u_3} [Monad m] (f : α → m PUnit) : Batteries.RBNode α → m PUnit

Run monadic function f on each element of the tree (in increasing order).

Equations

• Batteries.RBNode.forM f Batteries.RBNode.nil = pure PUnit.unit
• Batteries.RBNode.forM f (Batteries.RBNode.node a a_1 a_2 a_3) = do Batteries.RBNode.forM f a_1 f a_2 Batteries.RBNode.forM f a_3

@[specialize #[]]

def Batteries.RBNode.foldlM {m : Type u_1 → Type u_2} {σ : Type u_1} {α : Type u_3} [Monad m] (f : σ → α → m σ) (init : σ) : Batteries.RBNode α → m σ

Fold a monadic function on the values from left to right (in increasing order).

Equations

• Batteries.RBNode.foldlM f x Batteries.RBNode.nil = pure x
• Batteries.RBNode.foldlM f x (Batteries.RBNode.node c l v r) = do let __do_lift ← Batteries.RBNode.foldlM f x l let __do_lift ← f __do_lift v Batteries.RBNode.foldlM f __do_lift r

@[inline]

def Batteries.RBNode.forIn {m : Type u_1 → Type u_2} {α : Type u_3} {σ : Type u_1} [Monad m] (as : Batteries.RBNode α) (init : σ) (f : α → σ → m (ForInStep σ)) : m σ

Implementation of for x in t loops over a RBNode (in increasing order).

Equations

• as.forIn init f = ForInStep.run <$> Batteries.RBNode.forIn.visit f as init

@[specialize #[]]

def Batteries.RBNode.forIn.visit {m : Type u_1 → Type u_2} {α : Type u_3} {σ : Type u_1} [Monad m] (f : α → σ → m (ForInStep σ)) : Batteries.RBNode α → σ → m (ForInStep σ)

Inner loop of forIn.

Equations

• One or more equations did not get rendered due to their size.
• Batteries.RBNode.forIn.visit f Batteries.RBNode.nil x = pure (ForInStep.yield x)

instance Batteries.RBNode.instForIn {m : Type u_1 → Type u_2} {α : Type u_3} : ForIn m (Batteries.RBNode α) α

Equations

• Batteries.RBNode.instForIn = { forIn := fun {β : Type ?u.21} [Monad m] => Batteries.RBNode.forIn }

inductive Batteries.RBNode.Stream (α : Type u_1) : Type u_1

An auxiliary data structure (an iterator) over an RBNode which lazily pulls elements from the left.

• nil: {α : Type u_1} → Batteries.RBNode.Stream α

  The stream is empty.

• cons: {α : Type u_1} → α → Batteries.RBNode α → Batteries.RBNode.Stream α → Batteries.RBNode.Stream α

  We are ready to deliver element v with right child r, and where tail represents all the subtrees we have yet to destructure.

def Batteries.RBNode.toStream {α : Type u_1} : Batteries.RBNode α → optParam (Batteries.RBNode.Stream α) Batteries.RBNode.Stream.nil → Batteries.RBNode.Stream α

O(log n). Turn a node into a stream, by descending along the left spine.

Equations

• Batteries.RBNode.nil.toStream x = x
• (Batteries.RBNode.node c l v r).toStream x = l.toStream (Batteries.RBNode.Stream.cons v r x)

def Batteries.RBNode.Stream.next? {α : Type u_1} : Batteries.RBNode.Stream α → Option (α × Batteries.RBNode.Stream α)

O(1) amortized, O(log n) worst case: Get the next element from the stream.

Equations

• Batteries.RBNode.Stream.nil.next? = none
• (Batteries.RBNode.Stream.cons v r tail).next? = some (v, r.toStream tail)

@[specialize #[]]

def Batteries.RBNode.Stream.foldl {σ : Sort u_1} {α : Type u_2} (f : σ → α → σ) (init : σ) : Batteries.RBNode.Stream α → σ

Fold a function on the values from left to right (in increasing order).

Equations

• Batteries.RBNode.Stream.foldl f x Batteries.RBNode.Stream.nil = x
• Batteries.RBNode.Stream.foldl f x (Batteries.RBNode.Stream.cons v r tail) = Batteries.RBNode.Stream.foldl f (Batteries.RBNode.foldl f (f x v) r) tail

@[specialize #[]]

def Batteries.RBNode.Stream.foldr {α : Type u_1} {σ : Sort u_2} (f : α → σ → σ) : Batteries.RBNode.Stream α → σ → σ

Fold a function on the values from right to left (in decreasing order).

Equations

• Batteries.RBNode.Stream.foldr f Batteries.RBNode.Stream.nil x = x
• Batteries.RBNode.Stream.foldr f (Batteries.RBNode.Stream.cons v r tail) x = f v (Batteries.RBNode.foldr f r (Batteries.RBNode.Stream.foldr f tail x))

def Batteries.RBNode.Stream.toList {α : Type u_1} (t : Batteries.RBNode.Stream α) : List α

O(n). Convert the stream to a list in ascending order.

Equations

• t.toList = Batteries.RBNode.Stream.foldr (fun (x1 : α) (x2 : List α) => x1 :: x2) t []

instance Batteries.RBNode.instToStreamStream {α : Type u_1} : ToStream (Batteries.RBNode α) (Batteries.RBNode.Stream α)

Equations

• Batteries.RBNode.instToStreamStream = { toStream := fun (x : Batteries.RBNode α) => x.toStream }

instance Batteries.RBNode.instStreamStream {α : Type u_1} : Stream (Batteries.RBNode.Stream α) α

Equations

• Batteries.RBNode.instStreamStream = { next? := Batteries.RBNode.Stream.next? }

@[specialize #[]]

def Batteries.RBNode.all {α : Type u_1} (p : α → Bool) : Batteries.RBNode α → Bool

Returns true iff every element of the tree satisfies p.

Equations

• Batteries.RBNode.all p Batteries.RBNode.nil = true
• Batteries.RBNode.all p (Batteries.RBNode.node a a_1 a_2 a_3) = (p a_2 && Batteries.RBNode.all p a_1 && Batteries.RBNode.all p a_3)

@[specialize #[]]

def Batteries.RBNode.any {α : Type u_1} (p : α → Bool) : Batteries.RBNode α → Bool

Returns true iff any element of the tree satisfies p.

Equations

• Batteries.RBNode.any p Batteries.RBNode.nil = false
• Batteries.RBNode.any p (Batteries.RBNode.node a a_1 a_2 a_3) = (p a_2 || Batteries.RBNode.any p a_1 || Batteries.RBNode.any p a_3)

def Batteries.RBNode.All {α : Type u_1} (p : α → Prop) : Batteries.RBNode α → Prop

Asserts that p holds on every element of the tree.

Equations

• Batteries.RBNode.All p Batteries.RBNode.nil = True
• Batteries.RBNode.All p (Batteries.RBNode.node a a_1 a_2 a_3) = (p a_2 ∧ Batteries.RBNode.All p a_1 ∧ Batteries.RBNode.All p a_3)

theorem Batteries.RBNode.All.imp {α : Type u_1} {p : α → Prop} {q : α → Prop} (H : ∀ {x : α}, p x → q x) {t : Batteries.RBNode α} : Batteries.RBNode.All p t → Batteries.RBNode.All q t

theorem Batteries.RBNode.all_iff {α : Type u_1} {p : α → Bool} {t : Batteries.RBNode α} : Batteries.RBNode.all p t = true ↔ Batteries.RBNode.All (fun (x : α) => p x = true) t

instance Batteries.RBNode.instDecidableAllOfDecidablePred {α : Type u_1} {p : α → Prop} {t : Batteries.RBNode α} [DecidablePred p] : Decidable (Batteries.RBNode.All p t)

Equations

• Batteries.RBNode.instDecidableAllOfDecidablePred = decidable_of_iff (Batteries.RBNode.all (fun (b : α) => decide (p b)) t = true) ⋯

def Batteries.RBNode.Any {α : Type u_1} (p : α → Prop) : Batteries.RBNode α → Prop

Asserts that p holds on some element of the tree.

Equations

• Batteries.RBNode.Any p Batteries.RBNode.nil = False
• Batteries.RBNode.Any p (Batteries.RBNode.node a a_1 a_2 a_3) = (p a_2 ∨ Batteries.RBNode.Any p a_1 ∨ Batteries.RBNode.Any p a_3)

theorem Batteries.RBNode.any_iff {α : Type u_1} {p : α → Bool} {t : Batteries.RBNode α} : Batteries.RBNode.any p t = true ↔ Batteries.RBNode.Any (fun (x : α) => p x = true) t

instance Batteries.RBNode.instDecidableAnyOfDecidablePred {α : Type u_1} {p : α → Prop} {t : Batteries.RBNode α} [DecidablePred p] : Decidable (Batteries.RBNode.Any p t)

Equations

• Batteries.RBNode.instDecidableAnyOfDecidablePred = decidable_of_iff (Batteries.RBNode.any (fun (b : α) => decide (p b)) t = true) ⋯

def Batteries.RBNode.EMem {α : Type u_1} (x : α) (t : Batteries.RBNode α) : Prop

True if x is an element of t "exactly", i.e. up to equality, not the cmp relation.

Equations

• Batteries.RBNode.EMem x t = Batteries.RBNode.Any (fun (x_1 : α) => x = x_1) t

instance Batteries.RBNode.instMembership {α : Type u_1} : Membership α (Batteries.RBNode α)

Equations

• Batteries.RBNode.instMembership = { mem := fun (t : Batteries.RBNode α) (x : α) => Batteries.RBNode.EMem x t }

def Batteries.RBNode.MemP {α : Type u_1} (cut : α → Ordering) (t : Batteries.RBNode α) : Prop

True if the specified cut matches at least one element of of t.

Equations

• Batteries.RBNode.MemP cut t = Batteries.RBNode.Any (fun (x : α) => cut x = Ordering.eq) t

@[reducible]

def Batteries.RBNode.Mem {α : Type u_1} (cmp : α → α → Ordering) (x : α) (t : Batteries.RBNode α) : Prop

True if x is equivalent to an element of t.

Equations

• Batteries.RBNode.Mem cmp x t = Batteries.RBNode.MemP (cmp x) t

def Batteries.RBNode.Slow.instDecidableEMem {α : Type u_1} {x : α} [DecidableEq α] {t : Batteries.RBNode α} : Decidable (Batteries.RBNode.EMem x t)

Equations

• Batteries.RBNode.Slow.instDecidableEMem = inferInstanceAs (Decidable (Batteries.RBNode.Any (fun (x_1 : α) => x = x_1) t))

def Batteries.RBNode.Slow.instDecidableMemP {α : Type u_1} {cut : α → Ordering} {t : Batteries.RBNode α} : Decidable (Batteries.RBNode.MemP cut t)

Equations

• Batteries.RBNode.Slow.instDecidableMemP = inferInstanceAs (Decidable (Batteries.RBNode.Any (fun (x : α) => cut x = Ordering.eq) t))

def Batteries.RBNode.Slow.instDecidableMem {α : Type u_1} {cmp : α → α → Ordering} {x : α} {t : Batteries.RBNode α} : Decidable (Batteries.RBNode.Mem cmp x t)

Equations

• Batteries.RBNode.Slow.instDecidableMem = inferInstanceAs (Decidable (Batteries.RBNode.Any (fun (x_1 : α) => cmp x x_1 = Ordering.eq) t))

@[specialize #[]]

def Batteries.RBNode.all₂ {α : Type u_1} {β : Type u_2} (R : α → β → Bool) (t₁ : Batteries.RBNode α) (t₂ : Batteries.RBNode β) : Bool

Asserts that t₁ and t₂ have the same number of elements in the same order, and R holds pairwise between them. The tree structure is ignored.

Equations

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

instance Batteries.RBNode.instBEq {α : Type u_1} [BEq α] : BEq (Batteries.RBNode α)

Equations

• Batteries.RBNode.instBEq = { beq := fun (a b : Batteries.RBNode α) => Batteries.RBNode.all₂ (fun (x1 x2 : α) => x1 == x2) a b }

def Batteries.RBNode.cmpLT {α : Sort u_1} (cmp : α → α → Ordering) (x : α) (y : α) : Prop

We say that x < y under the comparator cmp if cmp x y = .lt.

• In order to avoid assuming the comparator is always lawful, we use a local ∀ [TransCmp cmp] binder in the relation so that the ordering properties of the tree only need to hold if the comparator is lawful.
• The Nonempty wrapper is a no-op because this is already a proposition, but it prevents the [TransCmp cmp] binder from being introduced when we don't want it.

Equations

• Batteries.RBNode.cmpLT cmp x y = Nonempty (∀ [inst : Batteries.TransCmp cmp], cmp x y = Ordering.lt)

theorem Batteries.RBNode.cmpLT_iff : ∀ {α : Sort u_1} {cmp : α → α → Ordering} {x y : α} [inst : Batteries.TransCmp cmp], Batteries.RBNode.cmpLT cmp x y ↔ cmp x y = Ordering.lt

instance Batteries.RBNode.instDecidableCmpLTOfTransCmp : {α : Sort u_1} → {x y : α} → (cmp : α → α → Ordering) → [inst : Batteries.TransCmp cmp] → Decidable (Batteries.RBNode.cmpLT cmp x y)

Equations

• Batteries.RBNode.instDecidableCmpLTOfTransCmp cmp = decidable_of_iff' (cmp x y = Ordering.lt) ⋯

def Batteries.RBNode.cmpEq {α : Sort u_1} (cmp : α → α → Ordering) (x : α) (y : α) : Prop

We say that x ≈ y under the comparator cmp if cmp x y = .eq. See also cmpLT.

Equations

• Batteries.RBNode.cmpEq cmp x y = Nonempty (∀ [inst : Batteries.TransCmp cmp], cmp x y = Ordering.eq)

theorem Batteries.RBNode.cmpEq_iff : ∀ {α : Sort u_1} {cmp : α → α → Ordering} {x y : α} [inst : Batteries.TransCmp cmp], Batteries.RBNode.cmpEq cmp x y ↔ cmp x y = Ordering.eq

instance Batteries.RBNode.instDecidableCmpEqOfTransCmp : {α : Sort u_1} → {x y : α} → (cmp : α → α → Ordering) → [inst : Batteries.TransCmp cmp] → Decidable (Batteries.RBNode.cmpEq cmp x y)

Equations

• Batteries.RBNode.instDecidableCmpEqOfTransCmp cmp = decidable_of_iff' (cmp x y = Ordering.eq) ⋯

def Batteries.RBNode.isOrdered {α : Type u_1} (cmp : α → α → Ordering) (t : Batteries.RBNode α) (l : optParam (Option α) none) (r : optParam (Option α) none) : Bool

O(n). Verifies an ordering relation on the nodes of the tree.

Equations

• Batteries.RBNode.isOrdered cmp Batteries.RBNode.nil (some l_2) (some r_2) = decide (cmp l_2 r_2 = Ordering.lt)
• Batteries.RBNode.isOrdered cmp Batteries.RBNode.nil l r = true
• Batteries.RBNode.isOrdered cmp (Batteries.RBNode.node a a_1 a_2 a_3) l r = (Batteries.RBNode.isOrdered cmp a_1 l (some a_2) && Batteries.RBNode.isOrdered cmp a_3 (some a_2) r)

@[inline]

def Batteries.RBNode.balance1 {α : Type u_1} : Batteries.RBNode α → α → Batteries.RBNode α → Batteries.RBNode α

The first half of Okasaki's balance, concerning red-red sequences in the left child.

Equations

• One or more equations did not get rendered due to their size.
• x✝¹.balance1 x✝ x = Batteries.RBNode.node Batteries.RBColor.black x✝¹ x✝ x

@[inline]

def Batteries.RBNode.balance2 {α : Type u_1} : Batteries.RBNode α → α → Batteries.RBNode α → Batteries.RBNode α

The second half of Okasaki's balance, concerning red-red sequences in the right child.

Equations

• One or more equations did not get rendered due to their size.
• x✝¹.balance2 x✝ x = Batteries.RBNode.node Batteries.RBColor.black x✝¹ x✝ x

@[inline]

def Batteries.RBNode.isRed {α : Type u_1} : Batteries.RBNode α → Batteries.RBColor

Returns red if the node is red, otherwise black. (Nil nodes are treated as black.)

Equations

• (Batteries.RBNode.node c l v r).isRed = c
• x.isRed = Batteries.RBColor.black

@[inline]

def Batteries.RBNode.isBlack {α : Type u_1} : Batteries.RBNode α → Batteries.RBColor

Returns black if the node is black, otherwise red. (Nil nodes are treated as red, which is not the usual convention but useful for deletion.)

Equations

• (Batteries.RBNode.node c l v r).isBlack = c
• x.isBlack = Batteries.RBColor.red

def Batteries.RBNode.setBlack {α : Type u_1} : Batteries.RBNode α → Batteries.RBNode α

Changes the color of the root to black.

Equations

• Batteries.RBNode.nil.setBlack = Batteries.RBNode.nil
• (Batteries.RBNode.node a a_1 a_2 a_3).setBlack = Batteries.RBNode.node Batteries.RBColor.black a_1 a_2 a_3

def Batteries.RBNode.reverse {α : Type u_1} : Batteries.RBNode α → Batteries.RBNode α

O(n). Reverses the ordering of the tree without any rebalancing.

Equations

• Batteries.RBNode.nil.reverse = Batteries.RBNode.nil
• (Batteries.RBNode.node a a_1 a_2 a_3).reverse = Batteries.RBNode.node a a_3.reverse a_2 a_1.reverse

@[specialize #[]]

def Batteries.RBNode.ins {α : Type u_1} (cmp : α → α → Ordering) (x : α) : Batteries.RBNode α → Batteries.RBNode α

The core of the insert function. This adds an element x to a balanced red-black tree. Importantly, the result of calling ins is not a proper red-black tree, because it has a broken balance invariant. (See Balanced.ins for the balance invariant of ins.) The insert function does the final fixup needed to restore the invariant.

Equations

• One or more equations did not get rendered due to their size.
• Batteries.RBNode.ins cmp x Batteries.RBNode.nil = Batteries.RBNode.node Batteries.RBColor.red Batteries.RBNode.nil x Batteries.RBNode.nil

@[specialize #[]]

def Batteries.RBNode.insert {α : Type u_1} (cmp : α → α → Ordering) (t : Batteries.RBNode α) (v : α) : Batteries.RBNode α

insert cmp t v inserts element v into the tree, using the provided comparator cmp to put it in the right place and automatically rebalancing the tree as necessary.

Equations

• Batteries.RBNode.insert cmp t v = match t.isRed with | Batteries.RBColor.red => (Batteries.RBNode.ins cmp v t).setBlack | Batteries.RBColor.black => Batteries.RBNode.ins cmp v t

def Batteries.RBNode.setRed {α : Type u_1} : Batteries.RBNode α → Batteries.RBNode α

Recolor the root of the tree to red if possible.

Equations

• (Batteries.RBNode.node c a v b).setRed = Batteries.RBNode.node Batteries.RBColor.red a v b
• Batteries.RBNode.nil.setRed = Batteries.RBNode.nil

def Batteries.RBNode.balLeft {α : Type u_1} (l : Batteries.RBNode α) (v : α) (r : Batteries.RBNode α) : Batteries.RBNode α

Rebalancing a tree which has shrunk on the left.

Equations

• One or more equations did not get rendered due to their size.
• (Batteries.RBNode.node Batteries.RBColor.red a x b).balLeft v r = Batteries.RBNode.node Batteries.RBColor.red (Batteries.RBNode.node Batteries.RBColor.black a x b) v r
• l.balLeft v (Batteries.RBNode.node Batteries.RBColor.black a y b) = l.balance2 v (Batteries.RBNode.node Batteries.RBColor.red a y b)
• l.balLeft v r = Batteries.RBNode.node Batteries.RBColor.red l v r

def Batteries.RBNode.balRight {α : Type u_1} (l : Batteries.RBNode α) (v : α) (r : Batteries.RBNode α) : Batteries.RBNode α

Rebalancing a tree which has shrunk on the right.

Equations

• One or more equations did not get rendered due to their size.
• l.balRight v (Batteries.RBNode.node Batteries.RBColor.red a x b) = Batteries.RBNode.node Batteries.RBColor.red l v (Batteries.RBNode.node Batteries.RBColor.black a x b)
• (Batteries.RBNode.node Batteries.RBColor.black a x_1 b).balRight v r = (Batteries.RBNode.node Batteries.RBColor.red a x_1 b).balance1 v r
• l.balRight v r = Batteries.RBNode.node Batteries.RBColor.red l v r

def Batteries.RBNode.size {α : Type u_1} : Batteries.RBNode α → Nat

The number of nodes in the tree.

Equations

• Batteries.RBNode.nil.size = 0
• (Batteries.RBNode.node a a_1 a_2 a_3).size = a_1.size + a_3.size + 1

@[irreducible]

def Batteries.RBNode.append {α : Type u_1} : Batteries.RBNode α → Batteries.RBNode α → Batteries.RBNode α

Concatenate two trees with the same black-height.

Equations

• One or more equations did not get rendered due to their size.
• Batteries.RBNode.nil.append x = x
• x.append Batteries.RBNode.nil = x

erase

@[specialize #[]]

def Batteries.RBNode.del {α : Type u_1} (cut : α → Ordering) : Batteries.RBNode α → Batteries.RBNode α

The core of the erase function. The tree returned from this function has a broken invariant, which is restored in erase.

Equations

• One or more equations did not get rendered due to their size.
• Batteries.RBNode.del cut Batteries.RBNode.nil = Batteries.RBNode.nil

@[specialize #[]]

def Batteries.RBNode.erase {α : Type u_1} (cut : α → Ordering) (t : Batteries.RBNode α) : Batteries.RBNode α

The erase cut t function removes an element from the tree t. The cut function is used to locate an element in the tree: it returns .gt if we go too high and .lt if we go too low; if it returns .eq we will remove the element. (The function cmp k for some key k is a valid cut function, but we can also use cuts that are not of this form as long as they are suitably monotonic.)

Equations

• Batteries.RBNode.erase cut t = (Batteries.RBNode.del cut t).setBlack

@[specialize #[]]

def Batteries.RBNode.find? {α : Type u_1} (cut : α → Ordering) : Batteries.RBNode α → Option α

Finds an element in the tree satisfying the cut function.

Equations

• One or more equations did not get rendered due to their size.
• Batteries.RBNode.find? cut Batteries.RBNode.nil = none

@[specialize #[]]

def Batteries.RBNode.upperBound? {α : Type u_1} (cut : α → Ordering) : Batteries.RBNode α → optParam (Option α) none → Option α

upperBound? cut retrieves the smallest entry larger than or equal to cut, if it exists.

Equations

• One or more equations did not get rendered due to their size.
• Batteries.RBNode.upperBound? cut Batteries.RBNode.nil x = x

@[specialize #[]]

def Batteries.RBNode.lowerBound? {α : Type u_1} (cut : α → Ordering) : Batteries.RBNode α → optParam (Option α) none → Option α

lowerBound? cut retrieves the largest entry smaller than or equal to cut, if it exists.

Equations

• One or more equations did not get rendered due to their size.
• Batteries.RBNode.lowerBound? cut Batteries.RBNode.nil x = x

def Batteries.RBNode.root? {α : Type u_1} : Batteries.RBNode α → Option α

Returns the root of the tree, if any.

Equations

• Batteries.RBNode.nil.root? = none
• (Batteries.RBNode.node a a_1 a_2 a_3).root? = some a_2

@[specialize #[]]

def Batteries.RBNode.map {α : Type u_1} {β : Type u_2} (f : α → β) : Batteries.RBNode α → Batteries.RBNode β

O(n). Map a function on every value in the tree. This requires IsMonotone on the function in order to preserve the order invariant.

Equations

• Batteries.RBNode.map f Batteries.RBNode.nil = Batteries.RBNode.nil
• Batteries.RBNode.map f (Batteries.RBNode.node a a_1 a_2 a_3) = Batteries.RBNode.node a (Batteries.RBNode.map f a_1) (f a_2) (Batteries.RBNode.map f a_3)

def Batteries.RBNode.toArray {α : Type u_1} (n : Batteries.RBNode α) : Array α

Converts the tree into an array in increasing sorted order.

Equations

• n.toArray = Batteries.RBNode.foldl (fun (x1 : Array α) (x2 : α) => x1.push x2) #[] n

inductive Batteries.RBNode.Path (α : Type u) : Type u

A RBNode.Path α is a "cursor" into an RBNode which represents the path from the root to a subtree. Note that the path goes from the target subtree up to the root, which is reversed from the normal way data is stored in the tree. See Zipper for more information.

• root: {α : Type u} → Batteries.RBNode.Path α

  The root of the tree, which is the end of the path of parents.

• left: {α : Type u} → Batteries.RBColor → Batteries.RBNode.Path α → α → Batteries.RBNode α → Batteries.RBNode.Path α

  A path that goes down the left subtree.

• right: {α : Type u} → Batteries.RBColor → Batteries.RBNode α → α → Batteries.RBNode.Path α → Batteries.RBNode.Path α

  A path that goes down the right subtree.

def Batteries.RBNode.Path.fill {α : Type u_1} : Batteries.RBNode.Path α → Batteries.RBNode α → Batteries.RBNode α

Fills the Path with a subtree.

Equations

• Batteries.RBNode.Path.root.fill x = x
• (Batteries.RBNode.Path.left c parent y b).fill x = parent.fill (Batteries.RBNode.node c x y b)
• (Batteries.RBNode.Path.right c a y parent).fill x = parent.fill (Batteries.RBNode.node c a y x)

@[specialize #[]]

def Batteries.RBNode.zoom {α : Type u_1} (cut : α → Ordering) : Batteries.RBNode α → optParam (Batteries.RBNode.Path α) Batteries.RBNode.Path.root → Batteries.RBNode α × Batteries.RBNode.Path α

Like find?, but instead of just returning the element, it returns the entire subtree at the element and a path back to the root for reconstructing the tree.

Equations

• One or more equations did not get rendered due to their size.
• Batteries.RBNode.zoom cut Batteries.RBNode.nil x = (Batteries.RBNode.nil, x)

def Batteries.RBNode.Path.ins {α : Type u_1} : Batteries.RBNode.Path α → Batteries.RBNode α → Batteries.RBNode α

This function does the second part of RBNode.ins, which unwinds the stack and rebuilds the tree.

Equations

• Batteries.RBNode.Path.root.ins x = x.setBlack
• (Batteries.RBNode.Path.left Batteries.RBColor.red parent y b).ins x = parent.ins (Batteries.RBNode.node Batteries.RBColor.red x y b)
• (Batteries.RBNode.Path.right Batteries.RBColor.red a y parent).ins x = parent.ins (Batteries.RBNode.node Batteries.RBColor.red a y x)
• (Batteries.RBNode.Path.left Batteries.RBColor.black parent y b).ins x = parent.ins (x.balance1 y b)
• (Batteries.RBNode.Path.right Batteries.RBColor.black a y parent).ins x = parent.ins (a.balance2 y x)

@[inline]

def Batteries.RBNode.Path.insertNew {α : Type u_1} (path : Batteries.RBNode.Path α) (v : α) : Batteries.RBNode α

path.insertNew v inserts element v into the tree, assuming that path is zoomed in on a nil node such that inserting a new element at this position is valid.

Equations

• path.insertNew v = path.ins (Batteries.RBNode.node Batteries.RBColor.red Batteries.RBNode.nil v Batteries.RBNode.nil)

def Batteries.RBNode.Path.insert {α : Type u_1} (path : Batteries.RBNode.Path α) (t : Batteries.RBNode α) (v : α) : Batteries.RBNode α

path.insert t v inserts element v into the tree, assuming that (t, path) was the result of a previous zoom operation (so either the root of t is equivalent to v or it is empty).

Equations

• path.insert Batteries.RBNode.nil v = path.insertNew v
• path.insert (Batteries.RBNode.node a a_1 a_2 a_3) v = path.fill (Batteries.RBNode.node a a_1 v a_3)

def Batteries.RBNode.Path.del {α : Type u_1} : Batteries.RBNode.Path α → Batteries.RBNode α → Batteries.RBColor → Batteries.RBNode α

path.del t c does the second part of RBNode.del, which unwinds the stack and rebuilds the tree. The c argument is the color of the node before the deletion (we used t₀.isBlack for this in RBNode.del but the original tree is no longer available in this formulation).

Equations

• Batteries.RBNode.Path.root.del x✝ x = x✝.setBlack
• (Batteries.RBNode.Path.left c parent y b).del x Batteries.RBColor.red = parent.del (Batteries.RBNode.node Batteries.RBColor.red x y b) c
• (Batteries.RBNode.Path.right c a y parent).del x Batteries.RBColor.red = parent.del (Batteries.RBNode.node Batteries.RBColor.red a y x) c
• (Batteries.RBNode.Path.left c parent y b).del x Batteries.RBColor.black = parent.del (x.balLeft y b) c
• (Batteries.RBNode.Path.right c a y parent).del x Batteries.RBColor.black = parent.del (a.balRight y x) c

def Batteries.RBNode.Path.erase {α : Type u_1} (path : Batteries.RBNode.Path α) (t : Batteries.RBNode α) : Batteries.RBNode α

path.erase t v removes the root element of t from the tree, assuming that (t, path) was the result of a previous zoom operation.

Equations

• path.erase Batteries.RBNode.nil = path.fill Batteries.RBNode.nil
• path.erase (Batteries.RBNode.node a a_1 a_2 a_3) = path.del (a_1.append a_3) a

@[specialize #[]]

def Batteries.RBNode.modify {α : Type u_1} (cut : α → Ordering) (f : α → α) (t : Batteries.RBNode α) : Batteries.RBNode α

modify cut f t uses cut to find an element, then modifies the element using f and reinserts it into the tree.

Because the tree structure is not modified, f must not modify the ordering properties of the element.

The element in t is used linearly if t is unshared.

Equations

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

@[specialize #[]]

def Batteries.RBNode.alter {α : Type u_1} (cut : α → Ordering) (f : Option α → Option α) (t : Batteries.RBNode α) : Batteries.RBNode α

alter cut f t simultaneously handles inserting, erasing and replacing an element using a function f : Option α → Option α. It is passed the result of t.find? cut and can either return none to remove the element or some a to replace/insert the element with a (which must have the same ordering properties as the original element).

The element is used linearly if t is unshared.

Equations

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

def Batteries.RBNode.Ordered {α : Type u_1} (cmp : α → α → Ordering) : Batteries.RBNode α → Prop

The ordering invariant of a red-black tree, which is a binary search tree. This says that every element of a left subtree is less than the root, and every element in the right subtree is greater than the root, where the less than relation x < y is understood to mean cmp x y = .lt.

Because we do not assume that cmp is lawful when stating this property, we write it in such a way that if cmp is not lawful then the condition holds trivially. That way we can prove the ordering invariants without assuming cmp is lawful.

Equations

• One or more equations did not get rendered due to their size.
• Batteries.RBNode.Ordered cmp Batteries.RBNode.nil = True

def Batteries.RBNode.Slow.instDecidableOrdered {α : Type u_1} (cmp : α → α → Ordering) [Batteries.TransCmp cmp] (t : Batteries.RBNode α) : Decidable (Batteries.RBNode.Ordered cmp t)

Equations

• One or more equations did not get rendered due to their size.
• Batteries.RBNode.Slow.instDecidableOrdered cmp Batteries.RBNode.nil = inferInstanceAs (Decidable True)

inductive Batteries.RBNode.Balanced {α : Type u_1} : Batteries.RBNode α → Batteries.RBColor → Nat → Prop

The red-black balance invariant. Balanced t c n says that the color of the root node is c, and the black-height (the number of black nodes on any path from the root) of the tree is n. Additionally, every red node must have black children.

• nil: ∀ {α : Type u_1}, Batteries.RBNode.nil.Balanced Batteries.RBColor.black 0

  A nil node is balanced with black-height 0, and it is considered black.

• red: ∀ {α : Type u_1} {x : Batteries.RBNode α} {n : Nat} {y : Batteries.RBNode α} {v : α}, x.Balanced Batteries.RBColor.black n → y.Balanced Batteries.RBColor.black n → (Batteries.RBNode.node Batteries.RBColor.red x v y).Balanced Batteries.RBColor.red n

  A red node is balanced with black-height n if its children are both black with with black-height n.

• black: ∀ {α : Type u_1} {x : Batteries.RBNode α} {c₁ : Batteries.RBColor} {n : Nat} {y : Batteries.RBNode α} {c₂ : Batteries.RBColor} {v : α}, x.Balanced c₁ n → y.Balanced c₂ n → (Batteries.RBNode.node Batteries.RBColor.black x v y).Balanced Batteries.RBColor.black (n + 1)

  A black node is balanced with black-height n + 1 if its children both have black-height n.

inductive Batteries.RBNode.WF {α : Type u_1} (cmp : α → α → Ordering) : Batteries.RBNode α → Prop

The well-formedness invariant for a red-black tree. The first constructor is the real invariant, and the others allow us to "cheat" in this file and define insert and erase, which have more complex proofs that are delayed to Batteries.Data.RBMap.Lemmas.

• mk: ∀ {α : Type u_1} {cmp : α → α → Ordering} {t : Batteries.RBNode α} {c : Batteries.RBColor} {n : Nat}, Batteries.RBNode.Ordered cmp t → t.Balanced c n → Batteries.RBNode.WF cmp t

  The actual well-formedness invariant: a red-black tree has the ordering and balance invariants.

• insert: ∀ {α : Type u_1} {cmp : α → α → Ordering} {t : Batteries.RBNode α} {a : α}, Batteries.RBNode.WF cmp t → Batteries.RBNode.WF cmp (Batteries.RBNode.insert cmp t a)

  Inserting into a well-formed tree yields another well-formed tree. (See Ordered.insert and Balanced.insert for the actual proofs.)

• erase: ∀ {α : Type u_1} {cmp : α → α → Ordering} {t : Batteries.RBNode α} {cut : α → Ordering}, Batteries.RBNode.WF cmp t → Batteries.RBNode.WF cmp (Batteries.RBNode.erase cut t)

  Erasing from a well-formed tree yields another well-formed tree. (See Ordered.erase and Balanced.erase for the actual proofs.)

def Batteries.RBSet (α : Type u) (cmp : α → α → Ordering) : Type u

An RBSet is a self-balancing binary search tree. The cmp function is the comparator that will be used for performing searches; it should satisfy the requirements of TransCmp for it to have sensible behavior.

Equations

• Batteries.RBSet α cmp = { t : Batteries.RBNode α // Batteries.RBNode.WF cmp t }

@[inline]

def Batteries.mkRBSet (α : Type u) (cmp : α → α → Ordering) : Batteries.RBSet α cmp

O(1). Construct a new empty tree.

Equations

• Batteries.mkRBSet α cmp = ⟨Batteries.RBNode.nil, ⋯⟩

@[inline]

def Batteries.RBSet.empty {α : Type u_1} {cmp : α → α → Ordering} : Batteries.RBSet α cmp

O(1). Construct a new empty tree.

Equations

• Batteries.RBSet.empty = Batteries.mkRBSet α cmp

instance Batteries.RBSet.instEmptyCollection (α : Type u) (cmp : α → α → Ordering) : EmptyCollection (Batteries.RBSet α cmp)

Equations

• Batteries.RBSet.instEmptyCollection α cmp = { emptyCollection := Batteries.RBSet.empty }

instance Batteries.RBSet.instInhabited (α : Type u) (cmp : α → α → Ordering) : Inhabited (Batteries.RBSet α cmp)

Equations

• Batteries.RBSet.instInhabited α cmp = { default := ∅ }

@[inline]

def Batteries.RBSet.single {α : Type u_1} {cmp : α → α → Ordering} (v : α) : Batteries.RBSet α cmp

O(1). Construct a new tree with one element v.

Equations

• Batteries.RBSet.single v = ⟨Batteries.RBNode.node Batteries.RBColor.red Batteries.RBNode.nil v Batteries.RBNode.nil, ⋯⟩

@[inline]

def Batteries.RBSet.foldl {σ : Sort u_1} {α : Type u_2} {cmp : α → α → Ordering} (f : σ → α → σ) (init : σ) (t : Batteries.RBSet α cmp) : σ

O(n). Fold a function on the values from left to right (in increasing order).

Equations

• Batteries.RBSet.foldl f init t = Batteries.RBNode.foldl f init t.val

@[inline]

def Batteries.RBSet.foldr {α : Type u_1} {σ : Sort u_2} {cmp : α → α → Ordering} (f : α → σ → σ) (init : σ) (t : Batteries.RBSet α cmp) : σ

O(n). Fold a function on the values from right to left (in decreasing order).

Equations

• Batteries.RBSet.foldr f init t = Batteries.RBNode.foldr f t.val init

@[inline]

def Batteries.RBSet.foldlM {m : Type u_1 → Type u_2} {σ : Type u_1} {α : Type u_3} {cmp : α → α → Ordering} [Monad m] (f : σ → α → m σ) (init : σ) (t : Batteries.RBSet α cmp) : m σ

O(n). Fold a monadic function on the values from left to right (in increasing order).

Equations

• Batteries.RBSet.foldlM f init t = Batteries.RBNode.foldlM f init t.val

@[inline]

def Batteries.RBSet.forM {m : Type u_1 → Type u_2} {α : Type u_3} {cmp : α → α → Ordering} [Monad m] (f : α → m PUnit) (t : Batteries.RBSet α cmp) : m PUnit

O(n). Run monadic function f on each element of the tree (in increasing order).

Equations

• Batteries.RBSet.forM f t = Batteries.RBNode.forM f t.val

instance Batteries.RBSet.instForIn {m : Type u_1 → Type u_2} {α : Type u_3} {cmp : α → α → Ordering} : ForIn m (Batteries.RBSet α cmp) α

Equations

• Batteries.RBSet.instForIn = { forIn := fun {β : Type ?u.32} [Monad m] (t : Batteries.RBSet α cmp) => t.val.forIn }

instance Batteries.RBSet.instToStreamStream {α : Type u_1} {cmp : α → α → Ordering} : ToStream (Batteries.RBSet α cmp) (Batteries.RBNode.Stream α)

Equations

• Batteries.RBSet.instToStreamStream = { toStream := fun (x : Batteries.RBSet α cmp) => x.val.toStream }

@[inline]

def Batteries.RBSet.isEmpty {α : Type u_1} {cmp : α → α → Ordering} : Batteries.RBSet α cmp → Bool

O(1). Is the tree empty?

Equations

• Batteries.RBSet.isEmpty ⟨Batteries.RBNode.nil, property⟩ = true
• x.isEmpty = false

@[inline]

def Batteries.RBSet.toList {α : Type u_1} {cmp : α → α → Ordering} (t : Batteries.RBSet α cmp) : List α

O(n). Convert the tree to a list in ascending order.

Equations

• t.toList = t.val.toList

@[inline]

def Batteries.RBSet.min? {α : Type u_1} {cmp : α → α → Ordering} (t : Batteries.RBSet α cmp) : Option α

O(log n). Returns the entry a such that a ≤ k for all keys in the RBSet.

Equations

• t.min? = t.val.min?

@[inline]

def Batteries.RBSet.max? {α : Type u_1} {cmp : α → α → Ordering} (t : Batteries.RBSet α cmp) : Option α

O(log n). Returns the entry a such that a ≥ k for all keys in the RBSet.

Equations

• t.max? = t.val.max?

@[deprecated Batteries.RBSet.min?]

def Batteries.RBSet.min {α : Type u_1} {cmp : α → α → Ordering} (t : Batteries.RBSet α cmp) : Option α

Alias of Batteries.RBSet.min?.

---

O(log n). Returns the entry a such that a ≤ k for all keys in the RBSet.

Equations

• @Batteries.RBSet.min = @Batteries.RBSet.min?

@[deprecated Batteries.RBSet.max?]

def Batteries.RBSet.max {α : Type u_1} {cmp : α → α → Ordering} (t : Batteries.RBSet α cmp) : Option α

Alias of Batteries.RBSet.max?.

---

O(log n). Returns the entry a such that a ≥ k for all keys in the RBSet.

Equations

• @Batteries.RBSet.max = @Batteries.RBSet.max?

instance Batteries.RBSet.instRepr {α : Type u_1} {cmp : α → α → Ordering} [Repr α] : Repr (Batteries.RBSet α cmp)

Equations

• Batteries.RBSet.instRepr = { reprPrec := fun (m : Batteries.RBSet α cmp) (prec : Nat) => Repr.addAppParen (Std.Format.text "RBSet.ofList " ++ repr m.toList) prec }

@[inline]

def Batteries.RBSet.insert {α : Type u_1} {cmp : α → α → Ordering} (t : Batteries.RBSet α cmp) (v : α) : Batteries.RBSet α cmp

O(log n). Insert element v into the tree.

Equations

• t.insert v = ⟨Batteries.RBNode.insert cmp t.val v, ⋯⟩

def Batteries.RBSet.insertMany {ρ : Type u_1} {α : Type u_2} {cmp : α → α → Ordering} [ForIn Id ρ α] (s : Batteries.RBSet α cmp) (as : ρ) : Batteries.RBSet α cmp

Insert all elements from a collection into a RBSet α cmp.

Equations

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

@[inline]

def Batteries.RBSet.erase {α : Type u_1} {cmp : α → α → Ordering} (t : Batteries.RBSet α cmp) (cut : α → Ordering) : Batteries.RBSet α cmp

O(log n). Remove an element from the tree using a cut function. The cut function is used to locate an element in the tree: it returns .gt if we go too high and .lt if we go too low; if it returns .eq we will remove the element. (The function cmp k for some key k is a valid cut function, but we can also use cuts that are not of this form as long as they are suitably monotonic.)

Equations

• t.erase cut = ⟨Batteries.RBNode.erase cut t.val, ⋯⟩

@[inline]

def Batteries.RBSet.findP? {α : Type u_1} {cmp : α → α → Ordering} (t : Batteries.RBSet α cmp) (cut : α → Ordering) : Option α

O(log n). Find an element in the tree using a cut function.

Equations

• t.findP? cut = Batteries.RBNode.find? cut t.val

@[inline]

def Batteries.RBSet.find? {α : Type u_1} {cmp : α → α → Ordering} (t : Batteries.RBSet α cmp) (x : α) : Option α

O(log n). Returns an element in the tree equivalent to x if one exists.

Equations

• t.find? x = Batteries.RBNode.find? (cmp x) t.val

@[inline]

def Batteries.RBSet.findPD {α : Type u_1} {cmp : α → α → Ordering} (t : Batteries.RBSet α cmp) (cut : α → Ordering) (v₀ : α) : α

O(log n). Find an element in the tree, or return a default value v₀.

Equations

• t.findPD cut v₀ = (t.findP? cut).getD v₀

@[inline]

def Batteries.RBSet.upperBoundP? {α : Type u_1} {cmp : α → α → Ordering} (t : Batteries.RBSet α cmp) (cut : α → Ordering) : Option α

O(log n). upperBoundP cut retrieves the smallest entry comparing gt or eq under cut, if it exists. If multiple keys in the map return eq under cut, any of them may be returned.

Equations

• t.upperBoundP? cut = Batteries.RBNode.upperBound? cut t.val

@[inline]

def Batteries.RBSet.upperBound? {α : Type u_1} {cmp : α → α → Ordering} (t : Batteries.RBSet α cmp) (k : α) : Option α

O(log n). upperBound? k retrieves the largest entry smaller than or equal to k, if it exists.

Equations

• t.upperBound? k = t.upperBoundP? (cmp k)

@[inline]

def Batteries.RBSet.lowerBoundP? {α : Type u_1} {cmp : α → α → Ordering} (t : Batteries.RBSet α cmp) (cut : α → Ordering) : Option α

O(log n). lowerBoundP cut retrieves the largest entry comparing lt or eq under cut, if it exists. If multiple keys in the map return eq under cut, any of them may be returned.

Equations

• t.lowerBoundP? cut = Batteries.RBNode.lowerBound? cut t.val

@[inline]

def Batteries.RBSet.lowerBound? {α : Type u_1} {cmp : α → α → Ordering} (t : Batteries.RBSet α cmp) (k : α) : Option α

O(log n). lowerBound? k retrieves the largest entry smaller than or equal to k, if it exists.

Equations

• t.lowerBound? k = t.lowerBoundP? (cmp k)

@[inline]

def Batteries.RBSet.containsP {α : Type u_1} {cmp : α → α → Ordering} (t : Batteries.RBSet α cmp) (cut : α → Ordering) : Bool

O(log n). Returns true if the given cut returns eq for something in the RBSet.

Equations

• t.containsP cut = (t.findP? cut).isSome

@[inline]

def Batteries.RBSet.contains {α : Type u_1} {cmp : α → α → Ordering} (t : Batteries.RBSet α cmp) (a : α) : Bool

O(log n). Returns true if the given key a is in the RBSet.

Equations

• t.contains a = (t.find? a).isSome

@[inline]

def Batteries.RBSet.ofList {α : Type u_1} (l : List α) (cmp : α → α → Ordering) : Batteries.RBSet α cmp

O(n log n). Build a tree from an unsorted list by inserting them one at a time.

Equations

• Batteries.RBSet.ofList l cmp = List.foldl (fun (r : Batteries.RBSet α cmp) (p : α) => r.insert p) (Batteries.mkRBSet α cmp) l

@[inline]

def Batteries.RBSet.ofArray {α : Type u_1} (l : Array α) (cmp : α → α → Ordering) : Batteries.RBSet α cmp

O(n log n). Build a tree from an unsorted array by inserting them one at a time.

Equations

• Batteries.RBSet.ofArray l cmp = Array.foldl (fun (r : Batteries.RBSet α cmp) (p : α) => r.insert p) (Batteries.mkRBSet α cmp) l

@[inline]

def Batteries.RBSet.all {α : Type u_1} {cmp : α → α → Ordering} (t : Batteries.RBSet α cmp) (p : α → Bool) : Bool

O(n). Returns true if the given predicate is true for all items in the RBSet.

Equations

• t.all p = Batteries.RBNode.all p t.val

@[inline]

def Batteries.RBSet.any {α : Type u_1} {cmp : α → α → Ordering} (t : Batteries.RBSet α cmp) (p : α → Bool) : Bool

O(n). Returns true if the given predicate is true for any item in the RBSet.

Equations

• t.any p = Batteries.RBNode.any p t.val

@[inline]

def Batteries.RBSet.all₂ {α : Type u_1} {β : Type u_2} {cmpα : α → α → Ordering} {cmpβ : β → β → Ordering} (R : α → β → Bool) (t₁ : Batteries.RBSet α cmpα) (t₂ : Batteries.RBSet β cmpβ) : Bool

Asserts that t₁ and t₂ have the same number of elements in the same order, and R holds pairwise between them. The tree structure is ignored.

Equations

• Batteries.RBSet.all₂ R t₁ t₂ = Batteries.RBNode.all₂ R t₁.val t₂.val

def Batteries.RBSet.EMem {α : Type u_1} {cmp : α → α → Ordering} (x : α) (t : Batteries.RBSet α cmp) : Prop

True if x is an element of t "exactly", i.e. up to equality, not the cmp relation.

Equations

• Batteries.RBSet.EMem x t = Batteries.RBNode.EMem x t.val

def Batteries.RBSet.MemP {α : Type u_1} {cmp : α → α → Ordering} (cut : α → Ordering) (t : Batteries.RBSet α cmp) : Prop

True if the specified cut matches at least one element of of t.

Equations

• Batteries.RBSet.MemP cut t = Batteries.RBNode.MemP cut t.val

def Batteries.RBSet.Mem {α : Type u_1} {cmp : α → α → Ordering} (x : α) (t : Batteries.RBSet α cmp) : Prop

True if x is equivalent to an element of t.

Equations

• Batteries.RBSet.Mem x t = Batteries.RBSet.MemP (cmp x) t

instance Batteries.RBSet.instMembership {α : Type u_1} {cmp : α → α → Ordering} : Membership α (Batteries.RBSet α cmp)

Equations

• Batteries.RBSet.instMembership = { mem := fun (t : Batteries.RBSet α cmp) (x : α) => Batteries.RBSet.Mem x t }

def Batteries.RBSet.Slow.instDecidableEMem {α : Type u_1} {cmp : α → α → Ordering} {x : α} [DecidableEq α] {t : Batteries.RBSet α cmp} : Decidable (Batteries.RBSet.EMem x t)

Equations

• Batteries.RBSet.Slow.instDecidableEMem = inferInstanceAs (Decidable (Batteries.RBNode.Any (fun (x_1 : α) => x = x_1) t.val))

def Batteries.RBSet.Slow.instDecidableMemP {α : Type u_1} {cmp : α → α → Ordering} {cut : α → Ordering} {t : Batteries.RBSet α cmp} : Decidable (Batteries.RBSet.MemP cut t)

Equations

• Batteries.RBSet.Slow.instDecidableMemP = inferInstanceAs (Decidable (Batteries.RBNode.Any (fun (x : α) => cut x = Ordering.eq) t.val))

def Batteries.RBSet.Slow.instDecidableMem {α : Type u_1} {cmp : α → α → Ordering} {x : α} {t : Batteries.RBSet α cmp} : Decidable (Batteries.RBSet.Mem x t)

Equations

• Batteries.RBSet.Slow.instDecidableMem = inferInstanceAs (Decidable (Batteries.RBNode.Any (fun (x_1 : α) => cmp x x_1 = Ordering.eq) t.val))

instance Batteries.RBSet.instBEq {α : Type u_1} {cmp : α → α → Ordering} [BEq α] : BEq (Batteries.RBSet α cmp)

Returns true if t₁ and t₂ are equal as sets (assuming cmp and == are compatible), ignoring the internal tree structure.

Equations

• Batteries.RBSet.instBEq = { beq := fun (a b : Batteries.RBSet α cmp) => Batteries.RBSet.all₂ (fun (x1 x2 : α) => x1 == x2) a b }

def Batteries.RBSet.size {α : Type u_1} {cmp : α → α → Ordering} (m : Batteries.RBSet α cmp) : Nat

O(n). The number of items in the RBSet.

Equations

• m.size = m.val.size

@[inline]

def Batteries.RBSet.min! {α : Type u_1} {cmp : α → α → Ordering} [Inhabited α] (t : Batteries.RBSet α cmp) : α

O(log n). Returns the minimum element of the tree, or panics if the tree is empty.

Equations

• t.min! = t.min?.getD (panicWithPosWithDecl "Batteries.Data.RBMap.Basic" "Batteries.RBSet.min!" 798 71 "tree is empty")

@[inline]

def Batteries.RBSet.max! {α : Type u_1} {cmp : α → α → Ordering} [Inhabited α] (t : Batteries.RBSet α cmp) : α

O(log n). Returns the maximum element of the tree, or panics if the tree is empty.

Equations

• t.max! = t.max?.getD (panicWithPosWithDecl "Batteries.Data.RBMap.Basic" "Batteries.RBSet.max!" 801 71 "tree is empty")

@[inline]

def Batteries.RBSet.findP! {α : Type u_1} {cmp : α → α → Ordering} [Inhabited α] (t : Batteries.RBSet α cmp) (cut : α → Ordering) : α

O(log n). Attempts to find the value with key k : α in t and panics if there is no such key.

Equations

• t.findP! cut = (t.findP? cut).getD (panicWithPosWithDecl "Batteries.Data.RBMap.Basic" "Batteries.RBSet.findP!" 807 23 "key is not in the tree")

@[inline]

def Batteries.RBSet.find! {α : Type u_1} {cmp : α → α → Ordering} [Inhabited α] (t : Batteries.RBSet α cmp) (k : α) : α

O(log n). Attempts to find the value with key k : α in t and panics if there is no such key.

Equations

• t.find! k = (t.find? k).getD (panicWithPosWithDecl "Batteries.Data.RBMap.Basic" "Batteries.RBSet.find!" 813 20 "key is not in the tree")

class Batteries.RBSet.ModifyWF {α : Type u_1} {cmp : α → α → Ordering} (t : Batteries.RBSet α cmp) (cut : α → Ordering) (f : α → α) : Prop

The predicate asserting that the result of modifyP is safe to construct.

• wf : Batteries.RBNode.WF cmp (Batteries.RBNode.modify cut f t.val)

  The resulting tree is well formed.

theorem Batteries.RBSet.ModifyWF.wf {α : Type u_1} {cmp : α → α → Ordering} {t : Batteries.RBSet α cmp} {cut : α → Ordering} {f : α → α} [self : t.ModifyWF cut f] : Batteries.RBNode.WF cmp (Batteries.RBNode.modify cut f t.val)

The resulting tree is well formed.

def Batteries.RBSet.modifyP {α : Type u_1} {cmp : α → α → Ordering} (t : Batteries.RBSet α cmp) (cut : α → Ordering) (f : α → α) [wf : t.ModifyWF cut f] : Batteries.RBSet α cmp

O(log n). In-place replace an element found by cut. This takes the element out of the tree while f runs, so it uses the element linearly if t is unshared.

The ModifyWF assumption is required because f may change the ordering properties of the element, which would break the invariants.

Equations

• t.modifyP cut f = ⟨Batteries.RBNode.modify cut f t.val, ⋯⟩

class Batteries.RBSet.AlterWF {α : Type u_1} {cmp : α → α → Ordering} (t : Batteries.RBSet α cmp) (cut : α → Ordering) (f : Option α → Option α) : Prop

The predicate asserting that the result of alterP is safe to construct.

• wf : Batteries.RBNode.WF cmp (Batteries.RBNode.alter cut f t.val)

  The resulting tree is well formed.

theorem Batteries.RBSet.AlterWF.wf {α : Type u_1} {cmp : α → α → Ordering} {t : Batteries.RBSet α cmp} {cut : α → Ordering} {f : Option α → Option α} [self : t.AlterWF cut f] : Batteries.RBNode.WF cmp (Batteries.RBNode.alter cut f t.val)

The resulting tree is well formed.

def Batteries.RBSet.alterP {α : Type u_1} {cmp : α → α → Ordering} (t : Batteries.RBSet α cmp) (cut : α → Ordering) (f : Option α → Option α) [wf : t.AlterWF cut f] : Batteries.RBSet α cmp

O(log n). alterP cut f t simultaneously handles inserting, erasing and replacing an element using a function f : Option α → Option α. It is passed the result of t.findP? cut and can either return none to remove the element or some a to replace/insert the element with a (which must have the same ordering properties as the original element).

The element is used linearly if t is unshared.

The AlterWF assumption is required because f may change the ordering properties of the element, which would break the invariants.

Equations

• t.alterP cut f = ⟨Batteries.RBNode.alter cut f t.val, ⋯⟩

def Batteries.RBSet.union {α : Type u_1} {cmp : α → α → Ordering} (t₁ : Batteries.RBSet α cmp) (t₂ : Batteries.RBSet α cmp) : Batteries.RBSet α cmp

O(n₂ * log (n₁ + n₂)). Merges the maps t₁ and t₂. If equal keys exist in both, the key from t₂ is preferred.

Equations

• t₁.union t₂ = Batteries.RBSet.foldl Batteries.RBSet.insert t₁ t₂

instance Batteries.RBSet.instUnion {α : Type u_1} {cmp : α → α → Ordering} : Union (Batteries.RBSet α cmp)

Equations

• Batteries.RBSet.instUnion = { union := Batteries.RBSet.union }

def Batteries.RBSet.mergeWith {α : Type u_1} {cmp : α → α → Ordering} (mergeFn : α → α → α) (t₁ : Batteries.RBSet α cmp) (t₂ : Batteries.RBSet α cmp) : Batteries.RBSet α cmp

O(n₂ * log (n₁ + n₂)). Merges the maps t₁ and t₂. If equal keys exist in both, then use mergeFn a₁ a₂ to produce the new merged value.

Equations

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

def Batteries.RBSet.intersectWith {α : Type u_1} {β : Type u_2} {γ : Type u_3} {cmpα : α → α → Ordering} {cmpβ : β → β → Ordering} {cmpγ : γ → γ → Ordering} (cmp : α → β → Ordering) (mergeFn : α → β → γ) (t₁ : Batteries.RBSet α cmpα) (t₂ : Batteries.RBSet β cmpβ) : Batteries.RBSet γ cmpγ

O(n₁ * log (n₁ + n₂)). Intersects the maps t₁ and t₂ using mergeFn a b to produce the new value.

Equations

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

def Batteries.RBSet.filter {α : Type u_1} {cmp : α → α → Ordering} (t : Batteries.RBSet α cmp) (p : α → Bool) : Batteries.RBSet α cmp

O(n * log n). Constructs the set of all elements satisfying p.

Equations

• t.filter p = Batteries.RBSet.foldl (fun (acc : Batteries.RBSet α cmp) (a : α) => bif p a then acc.insert a else acc) ∅ t

def Batteries.RBSet.map {α : Type u_1} {cmpα : α → α → Ordering} {β : Type u_2} {cmpβ : β → β → Ordering} (t : Batteries.RBSet α cmpα) (f : α → β) : Batteries.RBSet β cmpβ

O(n * log n). Map a function on every value in the set. If the function is monotone, consider using the more efficient RBSet.mapMonotone instead.

Equations

• t.map f = Batteries.RBSet.foldl (fun (acc : Batteries.RBSet β cmpβ) (a : α) => acc.insert (f a)) ∅ t

def Batteries.RBSet.sdiff {α : Type u_1} {cmp : α → α → Ordering} (t₁ : Batteries.RBSet α cmp) (t₂ : Batteries.RBSet α cmp) : Batteries.RBSet α cmp

O(n₁ * (log n₁ + log n₂)). Constructs the set of all elements of t₁ that are not in t₂.

Equations

• t₁.sdiff t₂ = t₁.filter fun (x : α) => !t₂.contains x

instance Batteries.RBSet.instSDiff {α : Type u_1} {cmp : α → α → Ordering} : SDiff (Batteries.RBSet α cmp)

Equations

• Batteries.RBSet.instSDiff = { sdiff := Batteries.RBSet.sdiff }

def Batteries.RBMap (α : Type u) (β : Type v) (cmp : α → α → Ordering) : Type (max u v)

An RBMap is a self-balancing binary search tree, used to store a key-value map. The cmp function is the comparator that will be used for performing searches; it should satisfy the requirements of TransCmp for it to have sensible behavior.

Equations

• Batteries.RBMap α β cmp = Batteries.RBSet (α × β) (Ordering.byKey Prod.fst cmp)

@[inline]

def Batteries.mkRBMap (α : Type u) (β : Type v) (cmp : α → α → Ordering) : Batteries.RBMap α β cmp

O(1). Construct a new empty map.

Equations

• Batteries.mkRBMap α β cmp = Batteries.mkRBSet (α × β) (Ordering.byKey Prod.fst cmp)

@[inline]

def Batteries.RBMap.empty {α : Type u} {β : Type v} {cmp : α → α → Ordering} : Batteries.RBMap α β cmp

O(1). Construct a new empty map.

Equations

• Batteries.RBMap.empty = Batteries.mkRBMap α β cmp

instance Batteries.instEmptyCollectionRBMap (α : Type u) (β : Type v) (cmp : α → α → Ordering) : EmptyCollection (Batteries.RBMap α β cmp)

Equations

• Batteries.instEmptyCollectionRBMap α β cmp = { emptyCollection := Batteries.RBMap.empty }

instance Batteries.instInhabitedRBMap (α : Type u) (β : Type v) (cmp : α → α → Ordering) : Inhabited (Batteries.RBMap α β cmp)

Equations

• Batteries.instInhabitedRBMap α β cmp = { default := ∅ }

@[inline]

def Batteries.RBMap.single {α : Type u_1} {β : Type u_2} {cmp : α → α → Ordering} (k : α) (v : β) : Batteries.RBMap α β cmp

O(1). Construct a new tree with one key-value pair k, v.

Equations

• Batteries.RBMap.single k v = Batteries.RBSet.single (k, v)

@[inline]

def Batteries.RBMap.foldl {α : Type u} {β : Type v} {σ : Type w} {cmp : α → α → Ordering} (f : σ → α → β → σ) (init : σ) : Batteries.RBMap α β cmp → σ

O(n). Fold a function on the values from left to right (in increasing order).

Equations

• Batteries.RBMap.foldl f x ⟨t, property⟩ = Batteries.RBNode.foldl (fun (s : σ) (x : α × β) => match x with | (a, b) => f s a b) x t

@[inline]

def Batteries.RBMap.foldr {α : Type u} {β : Type v} {σ : Type w} {cmp : α → α → Ordering} (f : α → β → σ → σ) (init : σ) : Batteries.RBMap α β cmp → σ

O(n). Fold a function on the values from right to left (in decreasing order).

Equations

• Batteries.RBMap.foldr f x ⟨t, property⟩ = Batteries.RBNode.foldr (fun (x : α × β) (s : σ) => match x with | (a, b) => f a b s) t x

@[inline]

def Batteries.RBMap.foldlM {α : Type u} {β : Type v} {σ : Type w} {cmp : α → α → Ordering} {m : Type w → Type u_1} [Monad m] (f : σ → α → β → m σ) (init : σ) : Batteries.RBMap α β cmp → m σ

O(n). Fold a monadic function on the values from left to right (in increasing order).

Equations

• Batteries.RBMap.foldlM f x ⟨t, property⟩ = Batteries.RBNode.foldlM (fun (s : σ) (x : α × β) => match x with | (a, b) => f s a b) x t

@[inline]

def Batteries.RBMap.forM {α : Type u} {β : Type v} {cmp : α → α → Ordering} {m : Type u_1 → Type u_2} [Monad m] (f : α → β → m PUnit) (t : Batteries.RBMap α β cmp) : m PUnit

O(n). Run monadic function f on each element of the tree (in increasing order).

Equations

• Batteries.RBMap.forM f t = Batteries.RBNode.forM (fun (x : α × β) => match x with | (a, b) => f a b) t.val

instance Batteries.RBMap.instForInProd {α : Type u} {β : Type v} {cmp : α → α → Ordering} {m : Type u_1 → Type u_2} : ForIn m (Batteries.RBMap α β cmp) (α × β)

Equations

• Batteries.RBMap.instForInProd = inferInstanceAs (ForIn m (Batteries.RBSet (α × β) (Ordering.byKey Prod.fst cmp)) (α × β))

instance Batteries.RBMap.instToStreamStreamProd {α : Type u} {β : Type v} {cmp : α → α → Ordering} : ToStream (Batteries.RBMap α β cmp) (Batteries.RBNode.Stream (α × β))

Equations

• Batteries.RBMap.instToStreamStreamProd = inferInstanceAs (ToStream (Batteries.RBSet (α × β) (Ordering.byKey Prod.fst cmp)) (Batteries.RBNode.Stream (α × β)))

@[inline]

def Batteries.RBMap.keysArray {α : Type u} {β : Type v} {cmp : α → α → Ordering} (t : Batteries.RBMap α β cmp) : Array α

O(n). Constructs the array of keys of the map.

Equations

• t.keysArray = Batteries.RBNode.foldl (fun (x1 : Array α) (x2 : α × β) => x1.push x2.fst) #[] t.val

@[inline]

def Batteries.RBMap.keysList {α : Type u} {β : Type v} {cmp : α → α → Ordering} (t : Batteries.RBMap α β cmp) : List α

O(n). Constructs the list of keys of the map.

Equations

• t.keysList = Batteries.RBNode.foldr (fun (x1 : α × β) (x2 : List α) => x1.fst :: x2) t.val []

def Batteries.RBMap.Keys (α : Type u_1) (β : Type u_2) (cmp : α → α → Ordering) : Type (max u_1 u_2)

An "iterator" over the keys of the map. This is a trivial wrapper over the underlying map, but it comes with a small API to use it in a for loop or convert it to an array or list.

Equations

• Batteries.RBMap.Keys α β cmp = Batteries.RBMap α β cmp

@[inline]

def Batteries.RBMap.keys {α : Type u} {β : Type v} {cmp : α → α → Ordering} (t : Batteries.RBMap α β cmp) : Batteries.RBMap.Keys α β cmp

The keys of the map. This is an O(1) wrapper operation, which can be used in for loops or converted to an array or list.

Equations

• t.keys = t

@[inline]

def Batteries.RBMap.Keys.toArray {α : Type u_1} {β : Type u_2} {cmp : α → α → Ordering} (t : Batteries.RBMap α β cmp) : Array α

O(n). Constructs the array of keys of the map.

Equations

• @Batteries.RBMap.Keys.toArray = @Batteries.RBMap.keysArray

@[inline]

def Batteries.RBMap.Keys.toList {α : Type u_1} {β : Type u_2} {cmp : α → α → Ordering} (t : Batteries.RBMap α β cmp) : List α

O(n). Constructs the list of keys of the map.

Equations

• @Batteries.RBMap.Keys.toList = @Batteries.RBMap.keysList

instance Batteries.RBMap.instCoeHeadKeysArray {α : Type u} {β : Type v} {cmp : α → α → Ordering} : CoeHead (Batteries.RBMap.Keys α β cmp) (Array α)

Equations

• Batteries.RBMap.instCoeHeadKeysArray = { coe := Batteries.RBMap.keysArray }

instance Batteries.RBMap.instCoeHeadKeysList {α : Type u} {β : Type v} {cmp : α → α → Ordering} : CoeHead (Batteries.RBMap.Keys α β cmp) (List α)

Equations

• Batteries.RBMap.instCoeHeadKeysList = { coe := Batteries.RBMap.keysList }

instance Batteries.RBMap.instForInKeys {α : Type u} {β : Type v} {cmp : α → α → Ordering} {m : Type u_1 → Type u_2} : ForIn m (Batteries.RBMap.Keys α β cmp) α

Equations

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

instance Batteries.RBMap.instForMKeys {α : Type u} {β : Type v} {cmp : α → α → Ordering} {m : Type u_1 → Type u_2} : ForM m (Batteries.RBMap.Keys α β cmp) α

Equations

• Batteries.RBMap.instForMKeys = { forM := fun [Monad m] (t : Batteries.RBMap.Keys α β cmp) (f : α → m PUnit) => Batteries.RBNode.forM (fun (x : α × β) => f x.fst) t.val }

def Batteries.RBMap.Keys.Stream (α : Type u_1) (β : Type u_2) : Type (max u_2 u_1)

The result of toStream on a Keys.

Equations

• Batteries.RBMap.Keys.Stream α β = Batteries.RBNode.Stream (α × β)

def Batteries.RBMap.Keys.toStream {α : Type u} {β : Type v} {cmp : α → α → Ordering} (t : Batteries.RBMap.Keys α β cmp) : Batteries.RBMap.Keys.Stream α β

A stream over the iterator.

Equations

• t.toStream = t.val.toStream

def Batteries.RBMap.Keys.Stream.next? {α : Type u} {β : Type v} (t : Batteries.RBMap.Keys.Stream α β) : Option (α × Batteries.RBMap.Keys.Stream α β)

O(1) amortized, O(log n) worst case: Get the next element from the stream.

Equations

• t.next? = match inline (Batteries.RBNode.Stream.next? t) with | none => none | some ((a, snd), t) => some (a, t)

instance Batteries.RBMap.instToStreamKeysStream {α : Type u} {β : Type v} {cmp : α → α → Ordering} : ToStream (Batteries.RBMap.Keys α β cmp) (Batteries.RBMap.Keys.Stream α β)

Equations

• Batteries.RBMap.instToStreamKeysStream = { toStream := Batteries.RBMap.Keys.toStream }

instance Batteries.RBMap.instStreamStream {α : Type u} {β : Type v} : Stream (Batteries.RBMap.Keys.Stream α β) α

Equations

• Batteries.RBMap.instStreamStream = { next? := Batteries.RBMap.Keys.Stream.next? }

@[inline]

def Batteries.RBMap.valuesArray {α : Type u} {β : Type v} {cmp : α → α → Ordering} (t : Batteries.RBMap α β cmp) : Array β

O(n). Constructs the array of values of the map.

Equations

• t.valuesArray = Batteries.RBNode.foldl (fun (x1 : Array β) (x2 : α × β) => x1.push x2.snd) #[] t.val

@[inline]

def Batteries.RBMap.valuesList {α : Type u} {β : Type v} {cmp : α → α → Ordering} (t : Batteries.RBMap α β cmp) : List β

O(n). Constructs the list of values of the map.

Equations

• t.valuesList = Batteries.RBNode.foldr (fun (x1 : α × β) (x2 : List β) => x1.snd :: x2) t.val []

def Batteries.RBMap.Values (α : Type u_1) (β : Type u_2) (cmp : α → α → Ordering) : Type (max u_1 u_2)

An "iterator" over the values of the map. This is a trivial wrapper over the underlying map, but it comes with a small API to use it in a for loop or convert it to an array or list.

Equations

• Batteries.RBMap.Values α β cmp = Batteries.RBMap α β cmp

@[inline]

def Batteries.RBMap.values {α : Type u} {β : Type v} {cmp : α → α → Ordering} (t : Batteries.RBMap α β cmp) : Batteries.RBMap.Values α β cmp

The "keys" of the map. This is an O(1) wrapper operation, which can be used in for loops or converted to an array or list.

Equations

• t.values = t

@[inline]

def Batteries.RBMap.Values.toArray {α : Type u_1} {β : Type u_2} {cmp : α → α → Ordering} (t : Batteries.RBMap α β cmp) : Array β

O(n). Constructs the array of values of the map.

Equations

• @Batteries.RBMap.Values.toArray = @Batteries.RBMap.valuesArray

@[inline]

def Batteries.RBMap.Values.toList {α : Type u_1} {β : Type u_2} {cmp : α → α → Ordering} (t : Batteries.RBMap α β cmp) : List β

O(n). Constructs the list of values of the map.

Equations

• @Batteries.RBMap.Values.toList = @Batteries.RBMap.valuesList

instance Batteries.RBMap.instCoeHeadValuesArray {α : Type u} {β : Type v} {cmp : α → α → Ordering} : CoeHead (Batteries.RBMap.Values α β cmp) (Array β)

Equations

• Batteries.RBMap.instCoeHeadValuesArray = { coe := Batteries.RBMap.valuesArray }

instance Batteries.RBMap.instCoeHeadValuesList {α : Type u} {β : Type v} {cmp : α → α → Ordering} : CoeHead (Batteries.RBMap.Values α β cmp) (List β)

Equations

• Batteries.RBMap.instCoeHeadValuesList = { coe := Batteries.RBMap.valuesList }

instance Batteries.RBMap.instForInValues {α : Type u} {β : Type v} {cmp : α → α → Ordering} {m : Type u_1 → Type u_2} : ForIn m (Batteries.RBMap.Values α β cmp) β

Equations

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

instance Batteries.RBMap.instForMValues {α : Type u} {β : Type v} {cmp : α → α → Ordering} {m : Type u_1 → Type u_2} : ForM m (Batteries.RBMap.Values α β cmp) β

Equations

• Batteries.RBMap.instForMValues = { forM := fun [Monad m] (t : Batteries.RBMap.Values α β cmp) (f : β → m PUnit) => Batteries.RBNode.forM (fun (x : α × β) => f x.snd) t.val }

def Batteries.RBMap.Values.Stream (α : Type u_1) (β : Type u_2) : Type (max u_2 u_1)

The result of toStream on a Values.

Equations

• Batteries.RBMap.Values.Stream α β = Batteries.RBNode.Stream (α × β)

def Batteries.RBMap.Values.toStream {α : Type u} {β : Type v} {cmp : α → α → Ordering} (t : Batteries.RBMap.Values α β cmp) : Batteries.RBMap.Values.Stream α β

A stream over the iterator.

Equations

• t.toStream = t.val.toStream

def Batteries.RBMap.Values.Stream.next? {α : Type u} {β : Type v} (t : Batteries.RBMap.Values.Stream α β) : Option (β × Batteries.RBMap.Values.Stream α β)

O(1) amortized, O(log n) worst case: Get the next element from the stream.

Equations

• t.next? = match inline (Batteries.RBNode.Stream.next? t) with | none => none | some ((fst, b), t) => some (b, t)

instance Batteries.RBMap.instToStreamValuesStream {α : Type u} {β : Type v} {cmp : α → α → Ordering} : ToStream (Batteries.RBMap.Values α β cmp) (Batteries.RBMap.Values.Stream α β)

Equations

• Batteries.RBMap.instToStreamValuesStream = { toStream := Batteries.RBMap.Values.toStream }

instance Batteries.RBMap.instStreamStream_1 {α : Type u} {β : Type v} : Stream (Batteries.RBMap.Values.Stream α β) β

Equations

• Batteries.RBMap.instStreamStream_1 = { next? := Batteries.RBMap.Values.Stream.next? }

@[inline]

def Batteries.RBMap.isEmpty {α : Type u} {β : Type v} {cmp : α → α → Ordering} : Batteries.RBMap α β cmp → Bool

O(1). Is the tree empty?

Equations

• Batteries.RBMap.isEmpty = Batteries.RBSet.isEmpty

@[inline]

def Batteries.RBMap.toList {α : Type u} {β : Type v} {cmp : α → α → Ordering} : Batteries.RBMap α β cmp → List (α × β)

O(n). Convert the tree to a list in ascending order.

Equations

• Batteries.RBMap.toList = Batteries.RBSet.toList

@[inline]

def Batteries.RBMap.min? {α : Type u} {β : Type v} {cmp : α → α → Ordering} : Batteries.RBMap α β cmp → Option (α × β)

O(log n). Returns the key-value pair (a, b) such that a ≤ k for all keys in the RBMap.

Equations

• Batteries.RBMap.min? = Batteries.RBSet.min?

@[inline]

def Batteries.RBMap.max? {α : Type u} {β : Type v} {cmp : α → α → Ordering} : Batteries.RBMap α β cmp → Option (α × β)

O(log n). Returns the key-value pair (a, b) such that a ≥ k for all keys in the RBMap.

Equations

• Batteries.RBMap.max? = Batteries.RBSet.max?

@[deprecated Batteries.RBMap.min?]

def Batteries.RBMap.min {α : Type u} {β : Type v} {cmp : α → α → Ordering} : Batteries.RBMap α β cmp → Option (α × β)

Alias of Batteries.RBMap.min?.

---

O(log n). Returns the key-value pair (a, b) such that a ≤ k for all keys in the RBMap.

Equations

• @Batteries.RBMap.min = @Batteries.RBMap.min?

@[deprecated Batteries.RBMap.max?]

def Batteries.RBMap.max {α : Type u} {β : Type v} {cmp : α → α → Ordering} : Batteries.RBMap α β cmp → Option (α × β)

Alias of Batteries.RBMap.max?.

---

O(log n). Returns the key-value pair (a, b) such that a ≥ k for all keys in the RBMap.

Equations

• @Batteries.RBMap.max = @Batteries.RBMap.max?

instance Batteries.RBMap.instRepr {α : Type u} {β : Type v} {cmp : α → α → Ordering} [Repr α] [Repr β] : Repr (Batteries.RBMap α β cmp)

Equations

• Batteries.RBMap.instRepr = { reprPrec := fun (m : Batteries.RBMap α β cmp) (prec : Nat) => Repr.addAppParen (Std.Format.text "RBMap.ofList " ++ repr m.toList) prec }

@[inline]

def Batteries.RBMap.insert {α : Type u} {β : Type v} {cmp : α → α → Ordering} (t : Batteries.RBMap α β cmp) (k : α) (v : β) : Batteries.RBMap α β cmp

O(log n). Insert key-value pair (k, v) into the tree.

Equations

• t.insert k v = Batteries.RBSet.insert t (k, v)

@[inline]

def Batteries.RBMap.erase {α : Type u} {β : Type v} {cmp : α → α → Ordering} (t : Batteries.RBMap α β cmp) (k : α) : Batteries.RBMap α β cmp

O(log n). Remove an element k from the map.

Equations

• t.erase k = Batteries.RBSet.erase t fun (x : α × β) => cmp k x.fst

@[inline]

def Batteries.RBMap.ofList {α : Type u} {β : Type v} (l : List (α × β)) (cmp : α → α → Ordering) : Batteries.RBMap α β cmp

O(n log n). Build a tree from an unsorted list by inserting them one at a time.

Equations

• Batteries.RBMap.ofList l cmp = Batteries.RBSet.ofList l (Ordering.byKey Prod.fst cmp)

@[inline]

def Batteries.RBMap.ofArray {α : Type u} {β : Type v} (l : Array (α × β)) (cmp : α → α → Ordering) : Batteries.RBMap α β cmp

O(n log n). Build a tree from an unsorted array by inserting them one at a time.

Equations

• Batteries.RBMap.ofArray l cmp = Batteries.RBSet.ofArray l (Ordering.byKey Prod.fst cmp)

@[inline]

def Batteries.RBMap.findEntry? {α : Type u} {β : Type v} {cmp : α → α → Ordering} (t : Batteries.RBMap α β cmp) (k : α) : Option (α × β)

O(log n). Find an entry in the tree with key equal to k.

Equations

• t.findEntry? k = Batteries.RBSet.findP? t fun (x : α × β) => cmp k x.fst

@[inline]

def Batteries.RBMap.find? {α : Type u} {β : Type v} {cmp : α → α → Ordering} (t : Batteries.RBMap α β cmp) (k : α) : Option β

O(log n). Find the value corresponding to key k.

Equations

• t.find? k = Option.map (fun (x : α × β) => x.snd) (t.findEntry? k)

@[inline]

def Batteries.RBMap.findD {α : Type u} {β : Type v} {cmp : α → α → Ordering} (t : Batteries.RBMap α β cmp) (k : α) (v₀ : β) : β

O(log n). Find the value corresponding to key k, or return v₀ if it is not in the map.

Equations

• t.findD k v₀ = (t.find? k).getD v₀

@[inline]

def Batteries.RBMap.lowerBound? {α : Type u} {β : Type v} {cmp : α → α → Ordering} (t : Batteries.RBMap α β cmp) (k : α) : Option (α × β)

O(log n). lowerBound? k retrieves the key-value pair of the largest key smaller than or equal to k, if it exists.

Equations

• t.lowerBound? k = Batteries.RBSet.lowerBoundP? t fun (x : α × β) => cmp k x.fst

@[inline]

def Batteries.RBMap.contains {α : Type u} {β : Type v} {cmp : α → α → Ordering} (t : Batteries.RBMap α β cmp) (a : α) : Bool

O(log n). Returns true if the given key a is in the RBMap.

Equations

• t.contains a = (t.findEntry? a).isSome

@[inline]

def Batteries.RBMap.all {α : Type u} {β : Type v} {cmp : α → α → Ordering} (t : Batteries.RBMap α β cmp) (p : α → β → Bool) : Bool

O(n). Returns true if the given predicate is true for all items in the RBMap.

Equations

• t.all p = Batteries.RBSet.all t fun (x : α × β) => match x with | (a, b) => p a b

@[inline]

def Batteries.RBMap.any {α : Type u} {β : Type v} {cmp : α → α → Ordering} (t : Batteries.RBMap α β cmp) (p : α → β → Bool) : Bool

O(n). Returns true if the given predicate is true for any item in the RBMap.

Equations

• t.any p = Batteries.RBSet.any t fun (x : α × β) => match x with | (a, b) => p a b

@[inline]

def Batteries.RBMap.all₂ {α : Type u} {β : Type v} {γ : Type u_1} {δ : Type u_2} {cmpα : α → α → Ordering} {cmpγ : γ → γ → Ordering} (R : α × β → γ × δ → Bool) (t₁ : Batteries.RBMap α β cmpα) (t₂ : Batteries.RBMap γ δ cmpγ) : Bool

Asserts that t₁ and t₂ have the same number of elements in the same order, and R holds pairwise between them. The tree structure is ignored.

Equations

• Batteries.RBMap.all₂ R t₁ t₂ = Batteries.RBSet.all₂ R t₁ t₂

@[inline]

def Batteries.RBMap.eqKeys {α : Type u} {β : Type v} {cmp : α → α → Ordering} {γ : Type u_1} (t₁ : Batteries.RBMap α β cmp) (t₂ : Batteries.RBMap α γ cmp) : Bool

Asserts that t₁ and t₂ have the same set of keys (up to equality).

Equations

• t₁.eqKeys t₂ = Batteries.RBMap.all₂ (fun (x1 : α × β) (x2 : α × γ) => decide (cmp x1.fst x2.fst = Ordering.eq)) t₁ t₂

instance Batteries.RBMap.instBEq {α : Type u} {β : Type v} {cmp : α → α → Ordering} [BEq α] [BEq β] : BEq (Batteries.RBMap α β cmp)

Returns true if t₁ and t₂ have the same keys and values (assuming cmp and == are compatible), ignoring the internal tree structure.

Equations

• Batteries.RBMap.instBEq = inferInstanceAs (BEq (Batteries.RBSet (α × β) (Ordering.byKey Prod.fst cmp)))

def Batteries.RBMap.size {α : Type u} {β : Type v} {cmp : α → α → Ordering} : Batteries.RBMap α β cmp → Nat

O(n). The number of items in the RBMap.

Equations

• Batteries.RBMap.size = Batteries.RBSet.size

@[inline]

def Batteries.RBMap.min! {α : Type u} {β : Type v} {cmp : α → α → Ordering} [Inhabited α] [Inhabited β] : Batteries.RBMap α β cmp → α × β

O(log n). Returns the minimum element of the map, or panics if the map is empty.

Equations

• Batteries.RBMap.min! = Batteries.RBSet.min!

@[inline]

def Batteries.RBMap.max! {α : Type u} {β : Type v} {cmp : α → α → Ordering} [Inhabited α] [Inhabited β] : Batteries.RBMap α β cmp → α × β

O(log n). Returns the maximum element of the map, or panics if the map is empty.

Equations

• Batteries.RBMap.max! = Batteries.RBSet.max!

@[inline]

def Batteries.RBMap.find! {α : Type u} {β : Type v} {cmp : α → α → Ordering} [Inhabited β] (t : Batteries.RBMap α β cmp) (k : α) : β

Attempts to find the value with key k : α in t and panics if there is no such key.

Equations

• t.find! k = (t.find? k).getD (panicWithPosWithDecl "Batteries.Data.RBMap.Basic" "Batteries.RBMap.find!" 1131 20 "key is not in the map")

def Batteries.RBMap.mergeWith {α : Type u} {β : Type v} {cmp : α → α → Ordering} (mergeFn : α → β → β → β) (t₁ : Batteries.RBMap α β cmp) (t₂ : Batteries.RBMap α β cmp) : Batteries.RBMap α β cmp

O(n₂ * log (n₁ + n₂)). Merges the maps t₁ and t₂, if a key a : α exists in both, then use mergeFn a b₁ b₂ to produce the new merged value.

Equations

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

def Batteries.RBMap.intersectWith {α : Type u} {β : Type v} {cmp : α → α → Ordering} {γ : Type u_1} {δ : Type u_2} (mergeFn : α → β → γ → δ) (t₁ : Batteries.RBMap α β cmp) (t₂ : Batteries.RBMap α γ cmp) : Batteries.RBMap α δ cmp

O(n₁ * log (n₁ + n₂)). Intersects the maps t₁ and t₂ using mergeFn a b to produce the new value.

Equations

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

def Batteries.RBMap.filter {α : Type u} {β : Type v} {cmp : α → α → Ordering} (t : Batteries.RBMap α β cmp) (p : α → β → Bool) : Batteries.RBMap α β cmp

O(n * log n). Constructs the set of all elements satisfying p.

Equations

• t.filter p = Batteries.RBSet.filter t fun (x : α × β) => match x with | (a, b) => p a b

def Batteries.RBMap.sdiff {α : Type u} {β : Type v} {cmp : α → α → Ordering} (t₁ : Batteries.RBMap α β cmp) (t₂ : Batteries.RBMap α β cmp) : Batteries.RBMap α β cmp

O(n₁ * (log n₁ + log n₂)). Constructs the set of all elements of t₁ that are not in t₂.

Equations

• t₁.sdiff t₂ = t₁.filter fun (a : α) (x : β) => !t₂.contains a

@[reducible, inline]

abbrev List.toRBMap {α : Type u_1} {β : Type u_2} (l : List (α × β)) (cmp : α → α → Ordering) : Batteries.RBMap α β cmp

O(n log n). Build a tree from an unsorted list by inserting them one at a time.

Equations

• l.toRBMap cmp = Batteries.RBMap.ofList l cmp