Remark: we considered using the following alternative design

structure Stream (α : Type u) where
  stream : Type u
  next? : stream → Option (α × stream)

class ToStream (collection : Type u) (value : outParam (Type v)) where
  toStream : collection → Stream value

where Stream is not a class, and its state is encapsulated. The key problem is that the type Stream α "lives" in a universe higher than α. This is a problem because we want to use Streams in monadic code.

class ToStream (collection : Type u) (stream : outParam (Type u)) : Type u

Streams are used to implement parallel for statements. Example:

for x in xs, y in ys do
  ...

is expanded into

let mut s := toStream ys
for x in xs do
  match Stream.next? s with
  | none => break
  | some (y, s') =>
    s := s'
    ...

• toStream : collection → stream

Instances

• Batteries.RBMap.instToStreamKeysStream
• Batteries.RBMap.instToStreamStreamProd
• Batteries.RBMap.instToStreamValuesStream
• Batteries.RBNode.instToStreamStream
• Batteries.RBSet.instToStreamStream
• instToStreamArraySubarray
• instToStreamList
• instToStreamRange
• instToStreamStringSubstring
• instToStreamSubarray

class Stream (stream : Type u) (value : outParam (Type v)) : Type (max u v)

• next? : stream → Option (value × stream)

Instances

• Batteries.BinomialHeap.instStream
• Batteries.RBMap.instStreamStream
• Batteries.RBMap.instStreamStream_1
• Batteries.RBNode.instStreamStream
• instStreamList
• instStreamProd
• instStreamRangeNat
• instStreamSubarray
• instStreamSubstringChar

def Stream.forIn {ρ : Type u_1} {α : Type u_2} {m : Type u_3 → Type u_4} {β : Type u_3} [Stream ρ α] [Monad m] (s : ρ) (b : β) (f : α → β → m (ForInStep β)) : m β

Equations

• Stream.forIn s b f = Stream.forIn.visit f s b

partial def Stream.forIn.visit {ρ : Type u_1} {α : Type u_2} {m : Type u_3 → Type u_4} {β : Type u_3} [Stream ρ α] [Monad m] (f : α → β → m (ForInStep β)) (s : ρ) (b : β) : m β

@[instance 100]

instance instForInOfStream {ρ : Type u_1} {α : Type u_2} {m : Type u_3 → Type u_4} [Stream ρ α] : ForIn m ρ α

Equations

• instForInOfStream = { forIn := fun {β : Type ?u.29} [Monad m] => Stream.forIn }

instance instToStreamList {α : Type u_1} : ToStream (List α) (List α)

Equations

• instToStreamList = { toStream := fun (c : List α) => c }

instance instToStreamArraySubarray {α : Type u_1} : ToStream (Array α) (Subarray α)

Equations

• instToStreamArraySubarray = { toStream := fun (a : Array α) => a.toSubarray }

instance instToStreamSubarray {α : Type u_1} : ToStream (Subarray α) (Subarray α)

Equations

• instToStreamSubarray = { toStream := fun (a : Subarray α) => a }

instance instToStreamStringSubstring : ToStream String Substring

Equations

• instToStreamStringSubstring = { toStream := fun (s : String) => s.toSubstring }

instance instToStreamRange : ToStream Std.Range Std.Range

Equations

• instToStreamRange = { toStream := fun (r : Std.Range) => r }

instance instStreamProd {ρ : Type u_1} {α : Type u_2} {γ : Type u_3} {β : Type u_4} [Stream ρ α] [Stream γ β] : Stream (ρ × γ) (α × β)

Equations

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

instance instStreamList {α : Type u_1} : Stream (List α) α

Equations

• instStreamList = { next? := fun (x : List α) => match x with | [] => none | a :: as => some (a, as) }

instance instStreamSubarray {α : Type u_1} : Stream (Subarray α) α

Equations

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

instance instStreamRangeNat : Stream Std.Range Nat

Equations

• instStreamRangeNat = { next? := fun (r : Std.Range) => if r.start < r.stop then some (r.start, { start := r.start + r.step, stop := r.stop, step := r.step }) else none }

instance instStreamSubstringChar : Stream Substring Char

Equations

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