Lua 迭代器 - Lua 5.3 基础教程 - 简单教程，简单编程

迭代器（iterator）是一种对象，它能够用来遍历标准模板库容器中的部分或全部元素，每个迭代器对象代表容器中的确定的地址

Lua 中的迭代器是一种支持指针类型的结构，它可以遍历集合的每一个元素

泛型 for 迭代器

泛型 for 在自己内部保存迭代函数，实际上它保存三个值：迭代函数、状态常量、控制变量

泛型 for 迭代器提供了集合的 key/value 对

泛型 for 语法格式如下

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

k, v 为变量列表，表示一个键值对
pair(t) 为表达式列表，返回 t 集合中的一个键值对

ipairs 是一个迭代函数

范例

-- !/usr/bin/lua
-- -*- encoding:utf-8 -*-
-- filename: main.lua
-- author: 简单教程(www.twle.cn)
-- Copyright © 2015-2065 www.twle.cn. All rights reserved.


array = {"QQ", "Baidu",'Ali','Sina','Meituan'}

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

运行以上 Lua 脚本，输出结果如下

$ lua main.lua
1 QQ
2 Baidu
3 Ali
4 Sina
5 Meituan

范性 for 的执行过程：

首先，初始化，计算 in 后面表达式的值，表达式应该返回范性 for 需要的三个值：迭代函数、状态常量、控制变量

与多值赋值一样，如果表达式返回的结果个数不足三个会自动用 nil 补足，多出部分会被忽略
其次，将状态常量和控制变量作为参数调用迭代函数（注意：对于for结构来说，状态常量没有用处，仅仅在初始化时获取他的值并传递给迭代函数）
再次，将迭代函数返回的值赋给变量列表
第四，如果返回的第一个值为 nil 循环结束，否则执行循环体
第五，回到第二步再次调用迭代函数

Lua 中常常使用函数来描述迭代器，每次调用该函数就返回集合的下一个元素。

Lua 的迭代器包含以下两种类型：

无状态的迭代器
多状态的迭代器

无状态的迭代器

无状态的迭代器是指不保留任何状态的迭代器

使用无状态迭代器避免创建闭包花费额外的代价

一般情况下，每一次迭代，迭代函数都是用两个变量（状态常量和控制变量）的值作为参数被调用。一个无状态的迭代器只利用这两个值可以获取下一个元素。

无状态迭代器的典型例子就是 ipairs，它遍历数组的每一个元素

范例：定义了一个函数来实现迭代器，实现列出数字 0~n 的平方

-- !/usr/bin/lua
-- -*- encoding:utf-8 -*-
-- filename: main.lua
-- author: 简单教程(www.twle.cn)
-- Copyright © 2015-2065 www.twle.cn. All rights reserved.


function square(d,n)
   if n < d
   then
      n = n + 1
   return n, n*n
   end
end

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

运行以上 Lua 脚本，输出结果如下：

$ lua main.lua
1 1
2 4
3 9
4 16
5 25

迭代的状态包括被遍历的表（循环过程中不会改变的状态常量）和当前的索引下标（控制变量

ipairs和迭代函数都很简单，我们可以自己来实现

-- !/usr/bin/lua
-- -*- encoding:utf-8 -*-
-- filename: main.lua
-- author: 简单教程(www.twle.cn)
-- Copyright © 2015-2065 www.twle.cn. All rights reserved.


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

array = {"QQ", "Baidu",'Ali','Sina','Meituan'}

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

调用 ipairs(a)开始循环时，他获取三个值：迭代函数iter、状态常量a、控制变量初始值0；
然后调用iter(a,0)返回1,a[1]（除非a[1]=nil）；
第二次迭代调用iter(a,1)返回2,a[2]...直到第一个nil元素

运行以上 Lua 脚本，输出结果如下:

$ lua main.lua
1 QQ
2 Baidu
3 Ali
4 Sina
5 Meituan

多状态的迭代器

很多情况下，迭代器需要保存多个状态信息而不是简单的状态常量和控制变量，实现的方法有两种：

使用闭包
将所有的状态信息封装到 table 内，将 table 作为迭代器的状态常量因为这种情况下可以将所有的信息存放在 table 内，所以迭代函数通常不需要第二个参数

下面的范例，我们自己实现了一个多状态的迭代器

-- !/usr/bin/lua
-- -*- encoding:utf-8 -*-
-- filename: main.lua
-- author: 简单教程(www.twle.cn)
-- Copyright © 2015-2065 www.twle.cn. All rights reserved.


function walk_it( collection )
   local index = 0
   local count = #collection
   -- 闭包函数
   return function ()
      index = index + 1
      if index <= count
      then
         --  返回迭代器的当前元素
         return collection[index]
      end
   end
end



array = {"QQ", "Baidu",'Ali','Sina','Meituan'}

for value in walk_it(array) 
do
   print(value)
end

运行以上 Lua 脚本，输出结果如下

$ lua main.lua
QQ
Baidu
Ali
Sina
Meituan

walk_it 迭代器的实现使用了闭包函数，实现计算集合大小并输出各个元素