イテレータ

イテレータは、コンテナの要素を取り出すためのオブジェクトです。

for! 0..9, i =>
    print! i

このコードは0から9までの数字を出力します。それぞれの数字(=Intオブジェクト)はiに代入され、=>以下の動作(=print! i)が実行されます。このような繰り返し実行のことを イテレーション といいます。

ではここでfor!プロシージャの型シグネチャを見てみましょう。

for!: |T: Type, I <: Iterable T| (I, T => None) => None

第一引数はIterableという型のオブジェクトを受け付けるようです。

Iterableは.Iterator属性, .iterメソッドを要求メソッドに持つ型です。

Iterable T = Trait {
    .Iterator = {Iterator}
    .iter = (self: Self) -> Self.Iterator T
}

.Iterator属性の型{Iterator}はいわゆるセットカインド(カインドはこちらで説明されています)です。

assert [1, 2, 3] in Iterable(Int)
assert 1..3 in Iterable(Int)
assert [1, 2, 3].Iterator == ArrayIterator
assert (1..3).Iterator == RangeIterator

log [1, 2, 3].iter() # <ArrayIterator object>
log (1..3).iter() # <RangeIterator object>

ArrayIteratorとRangeIteratorはどちらもIteratorを実装するクラスで、Array, Rangeにイテレーション機能を与えるためだけに存在します。このようなデザインパターンをコンパニオンクラス¹と呼びます。そしてIteratorImplパッチがイテレーション機能のコアです。Iteratorは.nextメソッド1つだけを要求し、IteratorImplは実に数十個のメソッドを提供します。ArrayIteratorやRangeIteratorは.nextメソッドを実装するだけでIteratorImplの実装メソッドを使うことができるわけです。この利便性から、標準ライブラリでは多数のイテレータが実装されています。

classDiagram
    class Array~T~ {
        ...
        iter() ArrayIterator~T~
    }
    class Range~T~ {
        ...
        iter() RangeIterator~T~
    }
    class Iterable~T~ {
        <<trait>>
        iter() Iterator~T~
    }
    Iterable~T~ <|.. Array~T~: Impl
    Iterable~T~ <|.. Range~T~: Impl
    class ArrayIterator~T~ {
        array: Array~T~
        next() T
    }
    class RangeIterator~T~ {
        range: Range~T~
        next() T
    }
    class Iterator~T~ {
        <<trait>>
        next() T
    }
    Iterator~T~ <|.. ArrayIterator~T~: Impl
    Iterator~T~ <|.. RangeIterator~T~: Impl

    Array <-- ArrayIterator
    Range <-- RangeIterator

Iterableのような、トレイト(この場合はIterator)を静的ディスパッチでありながら統一的に扱えるインターフェースを提供する型をコンパニオンクラスアダプターと呼びます。

¹ このパターンには統一された名前がないようであるが、Rustでは[companion struct pattern](https://gist.github.com/qnighy/be99c2ece6f3f4b1248608a04e104b38# :~:text=%E3%82%8F%E3%82%8C%E3%81%A6%E3%81%84%E3%82%8B%E3%80%82-,companion%20struct,-%E3%83%A1%E3%82%BD%E3%83%83%E3%83%89%E3%81%A8%E3%80%81%E3%81%9D%E3%81%AE)と呼ばれており、それになぞらえて命名した。↩

The Erg Book

イテレータ