Lua
イテレータ

汎用ループ用

反復子は、 汎用forループと呼ばれるforループの形式を使用します 。

forループの汎用形式は3つのパラメータを使用します。

1. 次の値が必要なときに呼び出される反復子関数 。不変状態と制御変数の両方をパラメータとして受け取る。 nilシグナルの終了を戻す。
2. 不変状態は反復中に変化しない値である。これは、通常、イテレータの対象（表、文字列、またはユーザーデータなど）です。
3. 制御変数は、反復の初期値を表す。

次の関数を使用して、 forループを記述して、すべてのキーと値のペアをテーブルに反復することができます。

local t = {a=1, b=2, c=3, d=4, e=5}

-- next is the iterator function
-- t is the invariant state
-- nil is the control variable (calling next with a nil gets the first key)
for key, value in next, t, nil do
  -- key is the new value for the control variable
  print(key, value) 
  -- Lua calls: next(t, key)  
end

標準イテレータ

Lua標準ライブラリには、テーブル内のキーと値のペアをトラバースするforループで使用できる2つのイテレータ関数が用意されてforます。

シーケンステーブルを反復するために、ライブラリ関数ipairsを使用することができます。

for index, value in ipairs {'a', 'b', 'c', 'd', 'e'} do
  print(index, value)  --> 1 a, 2 b, 3 c, 4 d, 5 e
end

任意のテーブルのすべてのキーと値に対するイテレータに、ライブラリ関数のペアを使用できます。

for key, value in pairs {a=1, b=2, c=3, d=4, e=5} do
  print(key, value)  --> e 5, c 3, a 1, b 2, d 4  (order not specified)
end

ステートレスイテレータ

ペアとipairsの両方は、ステートレスイテレータを表します。ステートレスイテレータは、 汎用forループの制御変数と不変状態のみを使用して反復値を計算します。

ペアイテレータ

next関数を使用してステートレスpairs反復子を実装できます。

-- generator function which initializes the generic for loop
local function pairs(t)
  -- next is the iterator function
  -- t is the invariant state
  -- control variable is nil
  return next, t, nil
end

Ipairs Iterator

私たちは、ステートレスのipairsイテレータを2つの別々の関数で実装することができます。

-- function which performs the actual iteration
local function ipairs_iter(t, i)
  local i = i + 1  -- next index in the sequence (i is the control variable)
  local v = t[i]   -- next value (t is the invariant state)
  if v ~= nil then
    return i, v    -- index, value
  end
  return nil       -- no more values (termination)
end

-- generator function which initializes the generic for loop
local function ipairs(t)
  -- ipairs_iter is the iterator function
  -- t is the invariant state (table to be iterated)
  -- 0 is the control variable (first index)
  return ipairs_iter, t, 0
end

文字イテレータ

generic forループの契約を満たすことで、新しいステートレスイテレータを作成できます。

-- function which performs the actual iteration
local function chars_iter(s, i)
  if i < #s then
    i = i + 1
    return i, s:sub(i, i)
  end
end

-- generator function which initializes the generic for loop
local function chars(s)
  return chars_iter, s, 0
end

-- used like pairs and ipairs
for i, c in chars 'abcde' do
    print(i, c) --> 1 a, 2 b, 3 c, 4 f, 5 e
end

素数イテレータ

これは、ステートレスイテレータのもう少し簡単な例です。

-- prime numbers iterator
local incr = {4, 1, 2, 0, 2}
function primes(s, p, d)
   s, p, d = s or math.huge, p and p + incr[p % 6] or 2, 1
   while p <= s do
      repeat
         d = d + incr[d % 6]
         if d*d > p then return p end
      until p % d == 0
      p, d = p + incr[p % 6], 1
   end
end

-- print all prime numbers <= 100
for p in primes, 100 do  -- passing in the iterator (do not call the iterator here)
   print(p)  -->  2  3  5  7  11 ... 97
end

-- print all primes in endless loop
for p in primes do  -- please note: "in primes", not "in primes()"
   print(p)
end

ステートフルイテレータ

ステートフルイテレータには、イテレータの現在の状態に関する追加情報があります。

表の使用

追加状態は汎用forループの不変状態にパックすることができます。

  local function chars_iter(t, i)
    local i = i + 1
    if i <= t.len then
      return i, t.s:sub(i, i)
    end
  end

  local function chars(s)
    -- the iterators state
    local t = {
      s = s,    -- the subject
      len = #s  -- cached length
    }
    return chars_iter, t, 0
  end

  for i, c in chars 'abcde' do
    print(i, c) --> 1 a, 2 b, 3 c, 4 d, 5 e
  end

クロージャを使用する

追加の状態は、関数クロージャ内でラップすることができます。状態はクロージャの範囲に完全に含まれているので、不変状態および制御変数は必要ではない。

  local function chars(s)
    local i, len = 0, #s
    return function() -- iterator function
      i = i + 1
      if i <= len then
        return i, s:sub(i, i)
      end
    end
  end

  for i, c in chars 'abcde' do
    print(i, c) --> 1 a, 2 b, 3 c, 4 d, 5 e
  end

コルーチンの使用

コルーチン内に追加の状態を含めることができます。この場合も、不変状態と制御変数は必要ありません。

  local function chars(s)
    return coroutine.wrap(function()
      for i = 1, #s do
        coroutine.yield(s:sub(i, i))
      end
    end)
  end

  for c in chars 'abcde' do
    print(c) --> a, b, c, d, e
  end