Lua 迭代器

迭代器（iterator）是一種對象，它能夠用來遍曆標準範本庫容器中的部分或全部元素，每個迭代器對象代表容器中的確定的地址。

在 Lua 中迭代器是一種支持指針類型的結構，它可以遍曆集合的每一個元素。

泛型 for 迭代器

泛型 for 在自己內部保存迭代函數，實際上它保存三個值：迭代函數、狀態常量、控制變數。

泛型 for 迭代器提供了集合的 key/value 對，語法格式如下：

for k, v in pairs(t) do
    print(k, v)
end

上面代碼中，k, v為變數列表；pairs(t)為運算式列表。

查看以下實例:

實例

array = {"Google", "zaixian"}

for key,value in ipairs(array)
do
   print(key, value)
end

以上代碼執行輸出結果為：

1  Google
2  zaixian

以上實例中我們使用了 Lua 默認提供的迭代函數 ipairs。

下麵我們看看泛型 for 的執行過程：

  • 首先，初始化，計算 in 後面運算式的值，運算式應該返回泛型 for 需要的三個值：迭代函數、狀態常量、控制變數；與多值賦值一樣，如果運算式返回的結果個數不足三個會自動用 nil 補足，多出部分會被忽略。
  • 第二，將狀態常量和控制變數作為參數調用迭代函數（注意：對於 for 結構來說，狀態常量沒有用處，僅僅在初始化時獲取他的值並傳遞給迭代函數）。
  • 第三，將迭代函數返回的值賦給變數列表。
  • 第四，如果返回的第一個值為nil迴圈結束，否則執行循環體。
  • 第五，回到第二步再次調用迭代函數

在Lua中我們常常使用函數來描述迭代器，每次調用該函數就返回集合的下一個元素。Lua 的迭代器包含以下兩種類型：

  • 無狀態的迭代器
  • 多狀態的迭代器

無狀態的迭代器

無狀態的迭代器是指不保留任何狀態的迭代器，因此在迴圈中我們可以利用無狀態迭代器避免創建閉包花費額外的代價。

每一次迭代，迭代函數都是用兩個變數（狀態常量和控制變數）的值作為參數被調用，一個無狀態的迭代器只利用這兩個值可以獲取下一個元素。

這種無狀態迭代器的典型的簡單的例子是 ipairs，它遍歷數組的每一個元素。

以下實例我們使用了一個簡單的函數來實現迭代器，實現 數字 n 的平方：

實例

function square(iteratorMaxCount,currentNumber)
   if currentNumber<iteratorMaxCount
   then
      currentNumber = currentNumber+1
   return currentNumber, currentNumber*currentNumber
   end
end

for i,n in square,3,0
do
   print(i,n)
end

以上實例輸出結果為：

1    1
2    4
3    9

迭代的狀態包括被遍曆的表（迴圈過程中不會改變的狀態常量）和當前的索引下標（控制變數），ipairs 和迭代函數都很簡單，我們在 Lua 中可以這樣實現：

實例

function iter (a, i)
    i = i + 1
    local v = a[i]
    if v then
       return i, v
    end
end
 
function ipairs (a)
    return iter, a, 0
end

當 Lua 調用 ipairs(a) 開始迴圈時，他獲取三個值：迭代函數 iter、狀態常量 a、控制變數初始值 0；然後 Lua 調用 iter(a,0) 返回 1, a[1]（除非 a[1]=nil）；第二次迭代調用 iter(a,1) 返回 2, a[2]……直到第一個 nil 元素。

多狀態的迭代器

很多情況下，迭代器需要保存多個狀態資訊而不是簡單的狀態常量和控制變數，最簡單的方法是使用閉包，還有一種方法就是將所有的狀態資訊封裝到 table 內，將 table 作為迭代器的狀態常量，因為這種情況下可以將所有的資訊存放在 table 內，所以迭代函數通常不需要第二個參數。

以下實例我們創建了自己的迭代器：

實例

array = {"Google", "zaixian"}

function elementIterator (collection)
   local index = 0
   local count = #collection
   -- 閉包函數
   return function ()
      index = index + 1
      if index <= count
      then
         --  返回迭代器的當前元素
         return collection[index]
      end
   end
end

for element in elementIterator(array)
do
   print(element)
end

以上實例輸出結果為：

Google
zaixian

以上實例中我們可以看到，elementIterator 內使用了閉包函數，實現計算集合大小並輸出各個元素。