1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>Penlight Documentation</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div> <!-- id="product" -->
<div id="main">
<!-- Menu -->
<div id="navigation">
<br/>
<h1>Penlight</h1>
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<h2>Contents</h2>
<ul>
<li><a href="#Functions">Functions</a></li>
</ul>
<h2>Modules</h2>
<ul>
<li><a href="../modules/pl.html">pl</a></li>
<li><a href="../modules/pl.Date.html">pl.Date</a></li>
<li><a href="../modules/pl.List.html">pl.List</a></li>
<li><a href="../modules/pl.Map.html">pl.Map</a></li>
<li><a href="../modules/pl.MultiMap.html">pl.MultiMap</a></li>
<li><a href="../modules/pl.OrderedMap.html">pl.OrderedMap</a></li>
<li><a href="../modules/pl.Set.html">pl.Set</a></li>
<li><a href="../modules/pl.app.html">pl.app</a></li>
<li><a href="../modules/pl.array2d.html">pl.array2d</a></li>
<li><a href="../modules/pl.class.html">pl.class</a></li>
<li><a href="../modules/pl.comprehension.html">pl.comprehension</a></li>
<li><a href="../modules/pl.config.html">pl.config</a></li>
<li><a href="../modules/pl.data.html">pl.data</a></li>
<li><a href="../modules/pl.dir.html">pl.dir</a></li>
<li><a href="../modules/pl.file.html">pl.file</a></li>
<li><a href="../modules/pl.func.html">pl.func</a></li>
<li><a href="../modules/pl.input.html">pl.input</a></li>
<li><a href="../modules/pl.lapp.html">pl.lapp</a></li>
<li><a href="../modules/pl.lexer.html">pl.lexer</a></li>
<li><a href="../modules/pl.luabalanced.html">pl.luabalanced</a></li>
<li><a href="../modules/pl.operator.html">pl.operator</a></li>
<li><a href="../modules/pl.path.html">pl.path</a></li>
<li><a href="../modules/pl.permute.html">pl.permute</a></li>
<li><a href="../modules/pl.pretty.html">pl.pretty</a></li>
<li><a href="../modules/pl.seq.html">pl.seq</a></li>
<li><a href="../modules/pl.sip.html">pl.sip</a></li>
<li><a href="../modules/pl.strict.html">pl.strict</a></li>
<li><a href="../modules/pl.stringio.html">pl.stringio</a></li>
<li><a href="../modules/pl.stringx.html">pl.stringx</a></li>
<li><strong>pl.tablex</strong></li>
<li><a href="../modules/pl.template.html">pl.template</a></li>
<li><a href="../modules/pl.test.html">pl.test</a></li>
<li><a href="../modules/pl.text.html">pl.text</a></li>
<li><a href="../modules/pl.utils.html">pl.utils</a></li>
<li><a href="../modules/pl.xml.html">pl.xml</a></li>
</ul>
<h2>Topics</h2>
<ul>
<li><a href="../topics/01-introduction.md.html">01-introduction.md</a></li>
<li><a href="../topics/02-arrays.md.html">02-arrays.md</a></li>
<li><a href="../topics/03-strings.md.html">03-strings.md</a></li>
<li><a href="../topics/04-paths.md.html">04-paths.md</a></li>
<li><a href="../topics/05-dates.md.html">05-dates.md</a></li>
<li><a href="../topics/06-data.md.html">06-data.md</a></li>
<li><a href="../topics/07-functional.md.html">07-functional.md</a></li>
<li><a href="../topics/08-additional.md.html">08-additional.md</a></li>
<li><a href="../topics/09-discussion.md.html">09-discussion.md</a></li>
</ul>
<h2>Examples</h2>
<ul>
<li><a href="../examples/seesubst.lua.html">seesubst.lua</a></li>
<li><a href="../examples/sipscan.lua.html">sipscan.lua</a></li>
<li><a href="../examples/symbols.lua.html">symbols.lua</a></li>
<li><a href="../examples/test-cmp.lua.html">test-cmp.lua</a></li>
<li><a href="../examples/test-data.lua.html">test-data.lua</a></li>
<li><a href="../examples/test-listcallbacks.lua.html">test-listcallbacks.lua</a></li>
<li><a href="../examples/test-pretty.lua.html">test-pretty.lua</a></li>
<li><a href="../examples/test-symbols.lua.html">test-symbols.lua</a></li>
<li><a href="../examples/testapp.lua.html">testapp.lua</a></li>
<li><a href="../examples/testclone.lua.html">testclone.lua</a></li>
<li><a href="../examples/testconfig.lua.html">testconfig.lua</a></li>
<li><a href="../examples/testglobal.lua.html">testglobal.lua</a></li>
<li><a href="../examples/testinputfields.lua.html">testinputfields.lua</a></li>
<li><a href="../examples/testinputfields2.lua.html">testinputfields2.lua</a></li>
<li><a href="../examples/testxml.lua.html">testxml.lua</a></li>
<li><a href="../examples/which.lua.html">which.lua</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>pl.tablex</code></h1>
<p>Extended operations on Lua tables.</p>
<p> See <a href="../topics/02-arrays.md.html#Useful_Operations_on_Tables">the Guide</a></p>
<p> Dependencies: <a href="../modules/pl.utils.html#">pl.utils</a> </p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#update">update (t1, t2)</a></td>
<td class="summary">copy a table into another, in-place.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#size">size (t)</a></td>
<td class="summary">total number of elements in this table.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#copy">copy (t)</a></td>
<td class="summary">make a shallow copy of a table</td>
</tr>
<tr>
<td class="name" nowrap><a href="#deepcopy">deepcopy (t)</a></td>
<td class="summary">make a deep copy of a table, recursively copying all the keys and fields.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#deepcompare">deepcompare (t1, t2, ignore_mt, eps)</a></td>
<td class="summary">compare two values.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#compare">compare (t1, t2, cmp)</a></td>
<td class="summary">compare two arrays using a predicate.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#compare_no_order">compare_no_order (t1, t2, cmp)</a></td>
<td class="summary">compare two list-like tables using an optional predicate, without regard for element order.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#find">find (t, val, idx)</a></td>
<td class="summary">return the index of a value in a list.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#rfind">rfind (t, val, idx)</a></td>
<td class="summary">return the index of a value in a list, searching from the end.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#find_if">find_if (t, cmp, arg)</a></td>
<td class="summary">return the index (or key) of a value in a table using a comparison function.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#index_by">index_by (tbl, idx)</a></td>
<td class="summary">return a list of all values in a table indexed by another list.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#map">map (fun, t, ...)</a></td>
<td class="summary">apply a function to all values of a table.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#imap">imap (fun, t, ...)</a></td>
<td class="summary">apply a function to all values of a list.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#map_named_method">map_named_method (name, t, ...)</a></td>
<td class="summary">apply a named method to values from a table.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#transform">transform (fun, t, ...)</a></td>
<td class="summary">apply a function to all values of a table, in-place.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#range">range (start, finish, step)</a></td>
<td class="summary">generate a table of all numbers in a range</td>
</tr>
<tr>
<td class="name" nowrap><a href="#map2">map2 (fun, t1, t2, ...)</a></td>
<td class="summary">apply a function to values from two tables.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#imap2">imap2 (fun, t1, t2, ...)</a></td>
<td class="summary">apply a function to values from two arrays.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#reduce">reduce (fun, t)</a></td>
<td class="summary">‘reduce’ a list using a binary function.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#foreach">foreach (t, fun, ...)</a></td>
<td class="summary">apply a function to all elements of a table.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#foreachi">foreachi (t, fun, ...)</a></td>
<td class="summary">apply a function to all elements of a list-like table in order.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#mapn">mapn (fun, ..., fun)</a></td>
<td class="summary">Apply a function to a number of tables.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#pairmap">pairmap (fun, t, ...)</a></td>
<td class="summary">call the function with the key and value pairs from a table.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#keys">keys (t)</a></td>
<td class="summary">return all the keys of a table in arbitrary order.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#values">values (t)</a></td>
<td class="summary">return all the values of the table in arbitrary order</td>
</tr>
<tr>
<td class="name" nowrap><a href="#index_map">index_map (t)</a></td>
<td class="summary">create an index map from a list-like table.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#makeset">makeset (t)</a></td>
<td class="summary">create a set from a list-like table.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#merge">merge (t1, t2, dup)</a></td>
<td class="summary">combine two tables, either as union or intersection.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#difference">difference (s1, s2, symm)</a></td>
<td class="summary">a new table which is the difference of two tables.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#count_map">count_map (t, cmp)</a></td>
<td class="summary">A table where the key/values are the values and value counts of the table.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#filter">filter (t, pred, arg)</a></td>
<td class="summary">filter a table’s values using a predicate function</td>
</tr>
<tr>
<td class="name" nowrap><a href="#zip">zip ()</a></td>
<td class="summary">return a table where each element is a table of the ith values of an arbitrary
number of tables.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#icopy">icopy (dest, src, idest, isrc, nsrc)</a></td>
<td class="summary">copy an array into another one, resizing the destination if necessary.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#move">move (dest, src, idest, isrc, nsrc)</a></td>
<td class="summary">copy an array into another one.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#sub">sub (t, first, last)</a></td>
<td class="summary">Extract a range from a table, like ‘string.sub’.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#set">set (t, val, i1, i2)</a></td>
<td class="summary">set an array range to a value.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#new">new (n, val)</a></td>
<td class="summary">create a new array of specified size with initial value.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#clear">clear (t, istart)</a></td>
<td class="summary">clear out the contents of a table.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#insertvalues">insertvalues (t, ...)</a></td>
<td class="summary">insert values into a table.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#removevalues">removevalues (t, i1, i2)</a></td>
<td class="summary">remove a range of values from a table.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#search">search (t, value, exclude)</a></td>
<td class="summary">find a value in a table by recursive search.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "update"></a>
<strong>update (t1, t2)</strong>
</dt>
<dd>
copy a table into another, in-place.
<h3>Parameters:</h3>
<ul>
<li><code><em>t1</em></code>: destination table</li>
<li><code><em>t2</em></code>: source table</li>
</ul>
<h3>Returns:</h3>
<ol>
first table
</ol>
</dd>
<dt>
<a name = "size"></a>
<strong>size (t)</strong>
</dt>
<dd>
total number of elements in this table.
Note that this is distinct from <code>#t</code>, which is the number
of values in the array part; this value will always
be greater or equal. The difference gives the size of
the hash part, for practical purposes.
<h3>Parameters:</h3>
<ul>
<li><code><em>t</em></code>: a table</li>
</ul>
<h3>Returns:</h3>
<ol>
the size
</ol>
</dd>
<dt>
<a name = "copy"></a>
<strong>copy (t)</strong>
</dt>
<dd>
make a shallow copy of a table
<h3>Parameters:</h3>
<ul>
<li><code><em>t</em></code>: source table</li>
</ul>
<h3>Returns:</h3>
<ol>
new table
</ol>
</dd>
<dt>
<a name = "deepcopy"></a>
<strong>deepcopy (t)</strong>
</dt>
<dd>
make a deep copy of a table, recursively copying all the keys and fields.
This will also set the copied table’s metatable to that of the original.
<h3>Parameters:</h3>
<ul>
<li><code><em>t</em></code>: A table</li>
</ul>
<h3>Returns:</h3>
<ol>
new table
</ol>
</dd>
<dt>
<a name = "deepcompare"></a>
<strong>deepcompare (t1, t2, ignore_mt, eps)</strong>
</dt>
<dd>
compare two values.
if they are tables, then compare their keys and fields recursively.
<h3>Parameters:</h3>
<ul>
<li><code><em>t1</em></code>: A value</li>
<li><code><em>t2</em></code>: A value</li>
<li><code><em>ignore_mt</em></code>: if true, ignore __eq metamethod (default false)</li>
<li><code><em>eps</em></code>: if defined, then used for any number comparisons</li>
</ul>
<h3>Returns:</h3>
<ol>
true or false
</ol>
</dd>
<dt>
<a name = "compare"></a>
<strong>compare (t1, t2, cmp)</strong>
</dt>
<dd>
compare two arrays using a predicate.
<h3>Parameters:</h3>
<ul>
<li><code><em>t1</em></code>: an array</li>
<li><code><em>t2</em></code>: an array</li>
<li><code><em>cmp</em></code>: A comparison function</li>
</ul>
</dd>
<dt>
<a name = "compare_no_order"></a>
<strong>compare_no_order (t1, t2, cmp)</strong>
</dt>
<dd>
compare two list-like tables using an optional predicate, without regard for element order.
<h3>Parameters:</h3>
<ul>
<li><code><em>t1</em></code>: a list-like table</li>
<li><code><em>t2</em></code>: a list-like table</li>
<li><code><em>cmp</em></code>: A comparison function (may be nil)</li>
</ul>
</dd>
<dt>
<a name = "find"></a>
<strong>find (t, val, idx)</strong>
</dt>
<dd>
return the index of a value in a list.
Like string.find, there is an optional index to start searching,
which can be negative.
<h3>Parameters:</h3>
<ul>
<li><code><em>t</em></code>: A list-like table (i.e. with numerical indices)</li>
<li><code><em>val</em></code>: A value</li>
<li><code><em>idx</em></code>: index to start; -1 means last element,etc (default 1)</li>
</ul>
<h3>Usage:</h3>
<ul>
<li><pre class="example">find({10,20,30},20) == 2</pre></li>
<li><pre class="example">find({'a','b','a','c'},'a',2) == 3</pre></li>
</ul>
<h3>Returns:</h3>
<ol>
index of value or nil if not found
</ol>
</dd>
<dt>
<a name = "rfind"></a>
<strong>rfind (t, val, idx)</strong>
</dt>
<dd>
return the index of a value in a list, searching from the end.
Like string.find, there is an optional index to start searching,
which can be negative.
<h3>Parameters:</h3>
<ul>
<li><code><em>t</em></code>: A list-like table (i.e. with numerical indices)</li>
<li><code><em>val</em></code>: A value</li>
<li><code><em>idx</em></code>: index to start; -1 means last element,etc (default 1)</li>
</ul>
<h3>Usage:</h3>
<ul>
<pre class="example">rfind({10,10,10},10) == 3</pre>
</ul>
<h3>Returns:</h3>
<ol>
index of value or nil if not found
</ol>
</dd>
<dt>
<a name = "find_if"></a>
<strong>find_if (t, cmp, arg)</strong>
</dt>
<dd>
return the index (or key) of a value in a table using a comparison function.
<h3>Parameters:</h3>
<ul>
<li><code><em>t</em></code>: A table</li>
<li><code><em>cmp</em></code>: A comparison function</li>
<li><code><em>arg</em></code>: an optional second argument to the function</li>
</ul>
<h3>Returns:</h3>
<ol>
<li>index of value, or nil if not found</li>
<li>value returned by comparison function</li>
</ol>
</dd>
<dt>
<a name = "index_by"></a>
<strong>index_by (tbl, idx)</strong>
</dt>
<dd>
return a list of all values in a table indexed by another list.
<h3>Parameters:</h3>
<ul>
<li><code><em>tbl</em></code>: a table</li>
<li><code><em>idx</em></code>: an index table (a list of keys)</li>
</ul>
<h3>Usage:</h3>
<ul>
<li><pre class="example">index_by({10,20,30,40},{2,4}) == {20,40}</pre></li>
<li><pre class="example">index_by({one=1,two=2,three=3},{'one','three'}) == {1,3}</pre></li>
</ul>
<h3>Returns:</h3>
<ol>
a list-like table
</ol>
</dd>
<dt>
<a name = "map"></a>
<strong>map (fun, t, ...)</strong>
</dt>
<dd>
apply a function to all values of a table.
This returns a table of the results.
Any extra arguments are passed to the function.
<h3>Parameters:</h3>
<ul>
<li><code><em>fun</em></code>: A function that takes at least one argument</li>
<li><code><em>t</em></code>: A table</li>
<li><code><em>...</em></code>: optional arguments</li>
</ul>
<h3>Usage:</h3>
<ul>
<pre class="example">map(function(v) return v*v end, {10,20,30,fred=2}) is {100,400,900,fred=4}</pre>
</ul>
</dd>
<dt>
<a name = "imap"></a>
<strong>imap (fun, t, ...)</strong>
</dt>
<dd>
apply a function to all values of a list.
This returns a table of the results.
Any extra arguments are passed to the function.
<h3>Parameters:</h3>
<ul>
<li><code><em>fun</em></code>: A function that takes at least one argument</li>
<li><code><em>t</em></code>: a table (applies to array part)</li>
<li><code><em>...</em></code>: optional arguments</li>
</ul>
<h3>Usage:</h3>
<ul>
<pre class="example">imap(function(v) return v*v end, {10,20,30,fred=2}) is {100,400,900}</pre>
</ul>
<h3>Returns:</h3>
<ol>
a list-like table
</ol>
</dd>
<dt>
<a name = "map_named_method"></a>
<strong>map_named_method (name, t, ...)</strong>
</dt>
<dd>
apply a named method to values from a table.
<h3>Parameters:</h3>
<ul>
<li><code><em>name</em></code>: the method name</li>
<li><code><em>t</em></code>: a list-like table</li>
<li><code><em>...</em></code>: any extra arguments to the method</li>
</ul>
</dd>
<dt>
<a name = "transform"></a>
<strong>transform (fun, t, ...)</strong>
</dt>
<dd>
apply a function to all values of a table, in-place.
Any extra arguments are passed to the function.
<h3>Parameters:</h3>
<ul>
<li><code><em>fun</em></code>: A function that takes at least one argument</li>
<li><code><em>t</em></code>: a table</li>
<li><code><em>...</em></code>: extra arguments</li>
</ul>
</dd>
<dt>
<a name = "range"></a>
<strong>range (start, finish, step)</strong>
</dt>
<dd>
generate a table of all numbers in a range
<h3>Parameters:</h3>
<ul>
<li><code><em>start</em></code>: number</li>
<li><code><em>finish</em></code>: number</li>
<li><code><em>step</em></code>: optional increment (default 1 for increasing, -1 for decreasing)</li>
</ul>
</dd>
<dt>
<a name = "map2"></a>
<strong>map2 (fun, t1, t2, ...)</strong>
</dt>
<dd>
apply a function to values from two tables.
<h3>Parameters:</h3>
<ul>
<li><code><em>fun</em></code>: a function of at least two arguments</li>
<li><code><em>t1</em></code>: a table</li>
<li><code><em>t2</em></code>: a table</li>
<li><code><em>...</em></code>: extra arguments</li>
</ul>
<h3>Usage:</h3>
<ul>
<pre class="example">map2('+',{1,2,3,m=4},{10,20,30,m=40}) is {11,22,23,m=44}</pre>
</ul>
<h3>Returns:</h3>
<ol>
a table
</ol>
</dd>
<dt>
<a name = "imap2"></a>
<strong>imap2 (fun, t1, t2, ...)</strong>
</dt>
<dd>
apply a function to values from two arrays.
<h3>Parameters:</h3>
<ul>
<li><code><em>fun</em></code>: a function of at least two arguments</li>
<li><code><em>t1</em></code>: a list-like table</li>
<li><code><em>t2</em></code>: a list-like table</li>
<li><code><em>...</em></code>: extra arguments</li>
</ul>
<h3>Usage:</h3>
<ul>
<pre class="example">imap2('+',{1,2,3,m=4},{10,20,30,m=40}) is {11,22,23}</pre>
</ul>
</dd>
<dt>
<a name = "reduce"></a>
<strong>reduce (fun, t)</strong>
</dt>
<dd>
‘reduce’ a list using a binary function.
<h3>Parameters:</h3>
<ul>
<li><code><em>fun</em></code>: a function of two arguments</li>
<li><code><em>t</em></code>: a list-like table</li>
</ul>
<h3>Usage:</h3>
<ul>
<pre class="example">reduce('+',{1,2,3,4}) == 10</pre>
</ul>
<h3>Returns:</h3>
<ol>
the result of the function
</ol>
</dd>
<dt>
<a name = "foreach"></a>
<strong>foreach (t, fun, ...)</strong>
</dt>
<dd>
apply a function to all elements of a table.
The arguments to the function will be the value,
the key and <i>finally</i> any extra arguments passed to this function.
Note that the Lua 5.0 function table.foreach passed the <i>key</i> first.
<h3>Parameters:</h3>
<ul>
<li><code><em>t</em></code>: a table</li>
<li><code><em>fun</em></code>: a function with at least one argument</li>
<li><code><em>...</em></code>: extra arguments</li>
</ul>
</dd>
<dt>
<a name = "foreachi"></a>
<strong>foreachi (t, fun, ...)</strong>
</dt>
<dd>
apply a function to all elements of a list-like table in order.
The arguments to the function will be the value,
the index and <i>finally</i> any extra arguments passed to this function
<h3>Parameters:</h3>
<ul>
<li><code><em>t</em></code>: a table</li>
<li><code><em>fun</em></code>: a function with at least one argument</li>
<li><code><em>...</em></code>: optional arguments</li>
</ul>
</dd>
<dt>
<a name = "mapn"></a>
<strong>mapn (fun, ..., fun)</strong>
</dt>
<dd>
Apply a function to a number of tables.
A more general version of map
The result is a table containing the result of applying that function to the
ith value of each table. Length of output list is the minimum length of all the lists
<h3>Parameters:</h3>
<ul>
<li><code><em>fun</em></code>: A function that takes as many arguments as there are tables</li>
<li><code><em>...</em></code>: n tables</li>
<li><code><em>fun</em></code>: A function that takes as many arguments as there are tables</li>
</ul>
<h3>Usage:</h3>
<ul>
<li><pre class="example">mapn(function(x,y,z) return x+y+z end, {1,2,3},{10,20,30},{100,200,300}) is {111,222,333}</pre></li>
<li><pre class="example">mapn(math.max, {1,20,300},{10,2,3},{100,200,100}) is {100,200,300}</pre></li>
</ul>
</dd>
<dt>
<a name = "pairmap"></a>
<strong>pairmap (fun, t, ...)</strong>
</dt>
<dd>
call the function with the key and value pairs from a table.
The function can return a value and a key (note the order!). If both
are not nil, then this pair is inserted into the result. If only value is not nil, then
it is appended to the result.
<h3>Parameters:</h3>
<ul>
<li><code><em>fun</em></code>: A function which will be passed each key and value as arguments, plus any extra arguments to pairmap.</li>
<li><code><em>t</em></code>: A table</li>
<li><code><em>...</em></code>: optional arguments</li>
</ul>
<h3>Usage:</h3>
<ul>
<li><pre class="example">pairmap({fred=10,bonzo=20},function(k,v) return v end) is {10,20}</pre></li>
<li><pre class="example">pairmap({one=1,two=2},function(k,v) return {k,v},k end) is {one={'one',1},two={'two',2}}</pre></li>
</ul>
</dd>
<dt>
<a name = "keys"></a>
<strong>keys (t)</strong>
</dt>
<dd>
return all the keys of a table in arbitrary order.
<h3>Parameters:</h3>
<ul>
<li><code><em>t</em></code>: A table</li>
</ul>
</dd>
<dt>
<a name = "values"></a>
<strong>values (t)</strong>
</dt>
<dd>
return all the values of the table in arbitrary order
<h3>Parameters:</h3>
<ul>
<li><code><em>t</em></code>: A table</li>
</ul>
</dd>
<dt>
<a name = "index_map"></a>
<strong>index_map (t)</strong>
</dt>
<dd>
create an index map from a list-like table. The original values become keys,
and the associated values are the indices into the original list.
<h3>Parameters:</h3>
<ul>
<li><code><em>t</em></code>: a list-like table</li>
</ul>
<h3>Returns:</h3>
<ol>
a map-like table
</ol>
</dd>
<dt>
<a name = "makeset"></a>
<strong>makeset (t)</strong>
</dt>
<dd>
create a set from a list-like table. A set is a table where the original values
become keys, and the associated values are all true.
<h3>Parameters:</h3>
<ul>
<li><code><em>t</em></code>: a list-like table</li>
</ul>
<h3>Returns:</h3>
<ol>
a set (a map-like table)
</ol>
</dd>
<dt>
<a name = "merge"></a>
<strong>merge (t1, t2, dup)</strong>
</dt>
<dd>
combine two tables, either as union or intersection. Corresponds to
set operations for sets () but more general. Not particularly
useful for list-like tables.
<h3>Parameters:</h3>
<ul>
<li><code><em>t1</em></code>: a table</li>
<li><code><em>t2</em></code>: a table</li>
<li><code><em>dup</em></code>: true for a union, false for an intersection.</li>
</ul>
<h3>Usage:</h3>
<ul>
<li><pre class="example">merge({alice=23,fred=34},{bob=25,fred=34}) is {fred=34}</pre></li>
<li><pre class="example">merge({alice=23,fred=34},{bob=25,fred=34},true) is {bob=25,fred=34,alice=23}</pre></li>
</ul>
<h3>see also:</h3>
<ul>
<a href="../modules/pl.tablex.html#index_map">tablex.index_map</a>
</ul>
</dd>
<dt>
<a name = "difference"></a>
<strong>difference (s1, s2, symm)</strong>
</dt>
<dd>
a new table which is the difference of two tables.
With sets (where the values are all true) this is set difference and
symmetric difference depending on the third parameter.
<h3>Parameters:</h3>
<ul>
<li><code><em>s1</em></code>: a map-like table or set</li>
<li><code><em>s2</em></code>: a map-like table or set</li>
<li><code><em>symm</em></code>: symmetric difference (default false)</li>
</ul>
<h3>Returns:</h3>
<ol>
a map-like table or set
</ol>
</dd>
<dt>
<a name = "count_map"></a>
<strong>count_map (t, cmp)</strong>
</dt>
<dd>
A table where the key/values are the values and value counts of the table.
<h3>Parameters:</h3>
<ul>
<li><code><em>t</em></code>: a list-like table</li>
<li><code><em>cmp</em></code>: a function that defines equality (otherwise uses ==)</li>
</ul>
<h3>Returns:</h3>
<ol>
a map-like table
</ol>
<h3>see also:</h3>
<ul>
<a href="../modules/pl.seq.html#count_map">seq.count_map</a>
</ul>
</dd>
<dt>
<a name = "filter"></a>
<strong>filter (t, pred, arg)</strong>
</dt>
<dd>
filter a table’s values using a predicate function
<h3>Parameters:</h3>
<ul>
<li><code><em>t</em></code>: a list-like table</li>
<li><code><em>pred</em></code>: a boolean function</li>
<li><code><em>arg</em></code>: optional argument to be passed as second argument of the predicate</li>
</ul>
</dd>
<dt>
<a name = "zip"></a>
<strong>zip ()</strong>
</dt>
<dd>
return a table where each element is a table of the ith values of an arbitrary
number of tables. It is equivalent to a matrix transpose.
<h3>Usage:</h3>
<ul>
<pre class="example">zip({10,20,30},{100,200,300}) is {{10,100},{20,200},{30,300}}</pre>
</ul>
</dd>
<dt>
<a name = "icopy"></a>
<strong>icopy (dest, src, idest, isrc, nsrc)</strong>
</dt>
<dd>
copy an array into another one, resizing the destination if necessary. <br>
<h3>Parameters:</h3>
<ul>
<li><code><em>dest</em></code>: a list-like table</li>
<li><code><em>src</em></code>: a list-like table</li>
<li><code><em>idest</em></code>: where to start copying values from source (default 1)</li>
<li><code><em>isrc</em></code>: where to start copying values into destination (default 1)</li>
<li><code><em>nsrc</em></code>: number of elements to copy from source (default source size)</li>
</ul>
</dd>
<dt>
<a name = "move"></a>
<strong>move (dest, src, idest, isrc, nsrc)</strong>
</dt>
<dd>
copy an array into another one. <br>
<h3>Parameters:</h3>
<ul>
<li><code><em>dest</em></code>: a list-like table</li>
<li><code><em>src</em></code>: a list-like table</li>
<li><code><em>idest</em></code>: where to start copying values from source (default 1)</li>
<li><code><em>isrc</em></code>: where to start copying values into destination (default 1)</li>
<li><code><em>nsrc</em></code>: number of elements to copy from source (default source size)</li>
</ul>
</dd>
<dt>
<a name = "sub"></a>
<strong>sub (t, first, last)</strong>
</dt>
<dd>
Extract a range from a table, like ‘string.sub’.
If first or last are negative then they are relative to the end of the list
eg. sub(t,-2) gives last 2 entries in a list, and
sub(t,-4,-2) gives from -4th to -2nd
<h3>Parameters:</h3>
<ul>
<li><code><em>t</em></code>: a list-like table</li>
<li><code><em>first</em></code>: An index</li>
<li><code><em>last</em></code>: An index</li>
</ul>
<h3>Returns:</h3>
<ol>
a new List
</ol>
</dd>
<dt>
<a name = "set"></a>
<strong>set (t, val, i1, i2)</strong>
</dt>
<dd>
set an array range to a value. If it’s a function we use the result
of applying it to the indices.
<h3>Parameters:</h3>
<ul>
<li><code><em>t</em></code>: a list-like table</li>
<li><code><em>val</em></code>: a value</li>
<li><code><em>i1</em></code>: start range (default 1)</li>
<li><code><em>i2</em></code>: end range (default table size)</li>
</ul>
</dd>
<dt>
<a name = "new"></a>
<strong>new (n, val)</strong>
</dt>
<dd>
create a new array of specified size with initial value.
<h3>Parameters:</h3>
<ul>
<li><code><em>n</em></code>: size</li>
<li><code><em>val</em></code>: initial value (can be nil, but don’t expect # to work!)</li>
</ul>
<h3>Returns:</h3>
<ol>
the table
</ol>
</dd>
<dt>
<a name = "clear"></a>
<strong>clear (t, istart)</strong>
</dt>
<dd>
clear out the contents of a table.
<h3>Parameters:</h3>
<ul>
<li><code><em>t</em></code>: a table</li>
<li><code><em>istart</em></code>: optional start position</li>
</ul>
</dd>
<dt>
<a name = "insertvalues"></a>
<strong>insertvalues (t, ...)</strong>
</dt>
<dd>
insert values into a table. <br>
insertvalues(t, [pos,] values) <br>
similar to table.insert but inserts values from given table “values”,
not the object itself, into table “t” at position “pos”.
<h3>Parameters:</h3>
<ul>
<li><code><em>t</em></code>:
</li>
<li><code><em>...</em></code>:
</li>
</ul>
</dd>
<dt>
<a name = "removevalues"></a>
<strong>removevalues (t, i1, i2)</strong>
</dt>
<dd>
remove a range of values from a table.
<h3>Parameters:</h3>
<ul>
<li><code><em>t</em></code>: a list-like table</li>
<li><code><em>i1</em></code>: start index</li>
<li><code><em>i2</em></code>: end index</li>
</ul>
<h3>Returns:</h3>
<ol>
the table
</ol>
</dd>
<dt>
<a name = "search"></a>
<strong>search (t, value, exclude)</strong>
</dt>
<dd>
find a value in a table by recursive search.
<h3>Parameters:</h3>
<ul>
<li><code><em>t</em></code>: the table</li>
<li><code><em>value</em></code>: the value</li>
<li><code><em>exclude</em></code>: any tables to avoid searching</li>
</ul>
<h3>Usage:</h3>
<ul>
<pre class="example">search(_G,math.sin,{package.path}) == 'math.sin'</pre>
</ul>
<h3>Returns:</h3>
<ol>
a fieldspec, e.g. ‘a.b’ or ‘math.sin’
</ol>
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.2</a></i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
|
