API/transforms/zh: Difference between revisions
Jump to navigation
Jump to search
imported>OCDoc Import Imported from legacy OpenComputers documentation at ocdoc.cil.li |
Clean up Markdown artifacts from DokuWiki migration |
||
| Line 1: | Line 1: | ||
= Transforms(变换) = | = Transforms(变换) = | ||
transforms(变换)库提供了一套用于带索引表的实用工具。此运行库提供了高度可复用的特殊迭代器,这些迭代器是 | transforms(变换)库提供了一套用于带索引表的实用工具。此运行库提供了高度可复用的特殊迭代器,这些迭代器是<code>text</code>与<code>sh</code>命令解析的核心。 | ||
== Transforms(变换) API == | == Transforms(变换) API == | ||
| Line 7: | Line 7: | ||
* '''Transforms工作于序列之上''' | * '''Transforms工作于序列之上''' | ||
<pre>所有transform方法都预期在序列上迭代,参见https://www.lua.org/manual/5.2/manual.html#3.4.6。 | <pre>所有transform方法都预期在序列上迭代,参见https://www.lua.org/manual/5.2/manual.html#3.4.6。 | ||
</pre> | </pre> | ||
* '''first 与 last''' | * '''first 与 last''' | ||
<pre> | <pre>此API中所有的first和last参数均与string方法(例如string.sub)中的first与last参数工作方式一致。也就是可以接收负值,负值为从后向前数。first(当选择时)默认相当于 1,而 last 默认相当于 -1。 | ||
</pre> | </pre> | ||
* '''判断函数(predicate)''' | * '''判断函数(predicate)''' | ||
<pre>译者注:此处的predicate通用的译名是“谓词”,指根据条件返回布尔值的函数。但译者认为这是相当糟糕的译名,不利于理解。因此译为“判断函数”。 | <pre>译者注:此处的predicate通用的译名是“谓词”,指根据条件返回布尔值的函数。但译者认为这是相当糟糕的译名,不利于理解。因此译为“判断函数”。 | ||
所有接收判断函数的transform方法均使用以下的判断函数定义: | 所有接收判断函数的transform方法均使用以下的判断函数定义: | ||
</pre> | </pre> | ||
* | * <code>predicate(element: value, index: number, tbl: table): number, number</code> | ||
<pre> | <pre>此判断函数会在tbl的每个索引值上依次调用。element为tbl[index]的值。 | ||
通常而言,判断函数将会忽略index与tbl,仅处理element。但一些判断函数可能会需要检查tbl中在index之前或之后的值。 | |||
</pre> | </pre> | ||
'''应注意''',传递给判断函数的 | '''应注意''',传递给判断函数的<code>tbl</code>实际上只是传递给transform api的原始表的一个'''视图(view)'''。此处的'''视图'''不是原生的序列,而是只有<code>tbl</code>中[<code>first</code>, <code>last</code>]范围内的值。 | ||
换言之,判断函数处理“一组元素”,并返回代表所满足条件的值。 | 换言之,判断函数处理“一组元素”,并返回代表所满足条件的值。 | ||
<pre> * **元素组** | <pre> * **元素组** | ||
"元素组"一词代指下列之一: | "元素组"一词代指下列之一: | ||
A) | A)传递给判断函数的单个element。与tbl[index]的值为同一个。 | ||
或者 | 或者 | ||
B) | B)tbl中自index起的元素序列。判断函数可能会从index处开始迭代,数量为其需要检查的元素数,直到#tbl为止。 | ||
</pre> | </pre> | ||
* '''返回值''' | * '''返回值''' | ||
<pre> 返回值的可能情况: | <pre> 返回值的可能情况: | ||
参数1:若为false 或 nil,代表这组元素不满足判断函数的条件。若为index,代表满足条件。函数应当直接返回给定函数的索引号,也就是元素组的起始元素索引号。 | |||
参数2:满足判断函数的元素组大小,或nil。 | |||
一些tranform方法可能会将第二个参数指定为可选,例如transforms.first()。 | |||
</pre> | </pre> | ||
| Line 48: | Line 48: | ||
=== 方法 === | === 方法 === | ||
* | * <code>transforms.sub(tbl: table, first: number, last: number or nil): table</code> | ||
<pre> | <pre>与string.sub作用类似,返回tbl从first到last的子表。 | ||
</pre> | </pre> | ||
* | * <code>transforms.first(tbl: table, predicate: function or table, first: number or nil, last: number or nil): number, number</code> | ||
<pre> | <pre>返回tbl中(范围在first与last索引值之间,包含首尾)满足predicate的首个元素的索引值。第二个返回值为连续匹配的元素最后一个的索引值。一般而言会返回两个同样的值,即匹配的连续元素为1个。predicate可以返回第二个返回值(可选),代表匹配的连续元素序列长度。 | ||
</pre> | </pre> | ||
当 | 当<code>predicate</code>为表时,<code>transforms.first()</code>将会返回<code>tbl</code>中首个满足条件的子表的首尾索引值,这种情况下的匹配指匹配<code>predicate</code>表中的任一元素。 | ||
样例: | 样例: | ||
<syntaxhighlight lang="lua"> | |||
local tx = require("transforms") print( tx.first ( { 1, 1, 3, 2, 4, 7 }, function(e, i, tbl) | local tx = require("transforms") print( tx.first ( { 1, 1, 3, 2, 4, 7 }, function(e, i, tbl) | ||
local evens = 0 | |||
for i=i,#tbl do | for i=i,#tbl do | ||
if tbl[i] % 2 == 0 then | if tbl[i] % 2 == 0 then | ||
| Line 74: | Line 73: | ||
end | end | ||
return evens > 0, evens | return evens > 0, evens | ||
end)) | |||
</syntaxhighlight> | |||
输出: <pre> | |||
4 5 | |||
</pre> | </pre> | ||
<syntaxhighlight lang="lua"> | |||
local tx = require("transforms") print( tx.first ( { 1, 1, 3, 2, 4, 7 }, { {1, 2}, {3, 2, 4} }) ) | |||
</syntaxhighlight> | |||
输出 <pre> | |||
3 5 | |||
</pre> | |||
* <code>transforms.partition(tbl: table, partioner: function, first: number or nil, last: number or nil): table of tables</code> | |||
<pre>返回一个子表的列表,子表来自tbl,由partioner生成,来源范围为从first到last。partioner为判断函数,定义见前文。 | |||
<pre> | |||
</pre> | </pre> | ||
传递给 | 传递给<code>partitioner</code>的<code>index</code>参数将会跳过子表的范围,即此参数会增加<code>n</code>,<code>n</code>即为分区大小。 | ||
此方法的 | 此方法的<code>partitioner</code>判断函数必须同时返回匹配的元素组的开始与结束索引。请再次参见前文的<code>predicate</code>相关信息。 | ||
* | * <code>transforms.begins(tbl: table, sub: table, first: number or nil, last: number or nil)</code> | ||
<pre> | <pre>若tbl从first到last的子表能完全组成v(自首个元素对齐),则返回true。first与last元素可以正确处理负数。上文描述也就是说: | ||
v[1] == tbl[first + 0] | |||
v[2] == tbl[first + 1] | |||
... | ... | ||
v[#v] == tbl[first + #v - 1] | |||
</pre> | </pre> | ||
此处的 | 此处的<code>first + #v - 1</code>在<code>tbl</code>的<code>[first, last]</code>范围内。 | ||
* | * <code>transforms.foreach(tbl: table, adapter: function, first: number or nil, last: number or nil)</code> | ||
<pre> | <pre>返回tbl中从first到last的每个元素的修改版本。若adapter的结果出现nil则会被忽略,不会被加入结果。 | ||
adapter函数遵循判断函数的格式,除了返回值处理方面。 | |||
* **Adapter函数返回值** | * **Adapter函数返回值** | ||
简单的情况是返回单个值,例如tx.foreach({'a', 'b', 'c'}, string.upper)将会返回{'A', 'B', 'C'}。 | |||
adapter函数可以通过返回nil来跳过某个值。例如,tx.foreach({'1', 'foobar', '2'}, function(n) return tonumber(n) end)将会返回{1, 2}。 | |||
adapter函数可以返回第二个值,此值会被用作结果的下个序号。例如tx.foreach({'1','foobar','3'},function(n,i) return tonumber(n), tostring(i) end)将会返回{["1"]=1, ["3"]=3} | |||
</pre> | </pre> | ||
== 目录 == | == 目录 == | ||
{{:API/contents/zh}} | {{:API/contents/zh}} | ||
Latest revision as of 20:27, 24 August 2026
Transforms(变换)
transforms(变换)库提供了一套用于带索引表的实用工具。此运行库提供了高度可复用的特殊迭代器,这些迭代器是text与sh命令解析的核心。
Transforms(变换) API
- Transforms工作于序列之上
所有transform方法都预期在序列上迭代,参见https://www.lua.org/manual/5.2/manual.html#3.4.6。
- first 与 last
此API中所有的first和last参数均与string方法(例如string.sub)中的first与last参数工作方式一致。也就是可以接收负值,负值为从后向前数。first(当选择时)默认相当于 1,而 last 默认相当于 -1。
- 判断函数(predicate)
译者注:此处的predicate通用的译名是“谓词”,指根据条件返回布尔值的函数。但译者认为这是相当糟糕的译名,不利于理解。因此译为“判断函数”。 所有接收判断函数的transform方法均使用以下的判断函数定义:
predicate(element: value, index: number, tbl: table): number, number
此判断函数会在tbl的每个索引值上依次调用。element为tbl[index]的值。 通常而言,判断函数将会忽略index与tbl,仅处理element。但一些判断函数可能会需要检查tbl中在index之前或之后的值。
应注意,传递给判断函数的tbl实际上只是传递给transform api的原始表的一个视图(view)。此处的视图不是原生的序列,而是只有tbl中[first, last]范围内的值。
换言之,判断函数处理“一组元素”,并返回代表所满足条件的值。
* **元素组** "元素组"一词代指下列之一: A)传递给判断函数的单个element。与tbl[index]的值为同一个。 或者 B)tbl中自index起的元素序列。判断函数可能会从index处开始迭代,数量为其需要检查的元素数,直到#tbl为止。
- 返回值
返回值的可能情况: 参数1:若为false 或 nil,代表这组元素不满足判断函数的条件。若为index,代表满足条件。函数应当直接返回给定函数的索引号,也就是元素组的起始元素索引号。 参数2:满足判断函数的元素组大小,或nil。 一些tranform方法可能会将第二个参数指定为可选,例如transforms.first()。
一些transform方法可能会指定其他类型的判断类型,例如表或字符串。这些判断函数的用法特定于对应的方法,且在此处详细列出的方法中定义。
方法
transforms.sub(tbl: table, first: number, last: number or nil): table
与string.sub作用类似,返回tbl从first到last的子表。
transforms.first(tbl: table, predicate: function or table, first: number or nil, last: number or nil): number, number
返回tbl中(范围在first与last索引值之间,包含首尾)满足predicate的首个元素的索引值。第二个返回值为连续匹配的元素最后一个的索引值。一般而言会返回两个同样的值,即匹配的连续元素为1个。predicate可以返回第二个返回值(可选),代表匹配的连续元素序列长度。
当predicate为表时,transforms.first()将会返回tbl中首个满足条件的子表的首尾索引值,这种情况下的匹配指匹配predicate表中的任一元素。
样例:
local tx = require("transforms") print( tx.first ( { 1, 1, 3, 2, 4, 7 }, function(e, i, tbl)
local evens = 0
for i=i,#tbl do
if tbl[i] % 2 == 0 then
evens = evens + 1
else
break
end
end
return evens > 0, evens
end))输出:
4 5
local tx = require("transforms") print( tx.first ( { 1, 1, 3, 2, 4, 7 }, { {1, 2}, {3, 2, 4} }) )输出
3 5
transforms.partition(tbl: table, partioner: function, first: number or nil, last: number or nil): table of tables
返回一个子表的列表,子表来自tbl,由partioner生成,来源范围为从first到last。partioner为判断函数,定义见前文。
传递给partitioner的index参数将会跳过子表的范围,即此参数会增加n,n即为分区大小。
此方法的partitioner判断函数必须同时返回匹配的元素组的开始与结束索引。请再次参见前文的predicate相关信息。
transforms.begins(tbl: table, sub: table, first: number or nil, last: number or nil)
若tbl从first到last的子表能完全组成v(自首个元素对齐),则返回true。first与last元素可以正确处理负数。上文描述也就是说: v[1] == tbl[first + 0] v[2] == tbl[first + 1] ... v[#v] == tbl[first + #v - 1]
此处的first + #v - 1在tbl的[first, last]范围内。
transforms.foreach(tbl: table, adapter: function, first: number or nil, last: number or nil)
返回tbl中从first到last的每个元素的修改版本。若adapter的结果出现nil则会被忽略,不会被加入结果。
adapter函数遵循判断函数的格式,除了返回值处理方面。
* **Adapter函数返回值**
简单的情况是返回单个值,例如tx.foreach({'a', 'b', 'c'}, string.upper)将会返回{'A', 'B', 'C'}。
adapter函数可以通过返回nil来跳过某个值。例如,tx.foreach({'1', 'foobar', '2'}, function(n) return tonumber(n) end)将会返回{1, 2}。
adapter函数可以返回第二个值,此值会被用作结果的下个序号。例如tx.foreach({'1','foobar','3'},function(n,i) return tonumber(n), tostring(i) end)将会返回{["1"]=1, ["3"]=3}
目录
| < 100% 15% 15% > | ||
| API | OpenOS | buffer - colors - component - computer - event - filesystem - uuid - internet - keyboard - note - process - rc - robot - serialization - shell - sides - term - text - thread - transforms - unicode |
| ::: | Lua 库 | coroutine - package - io - os |