Difference between revisions of "Table.sort"
From GiderosMobile
m (Text replacement - "<source" to "<syntaxhighlight") |
|||
| Line 5: | Line 5: | ||
=== Description === | === Description === | ||
Sorts the elements of a table in-place (i.e. alter the table). | Sorts the elements of a table in-place (i.e. alter the table). | ||
| − | < | + | <syntaxhighlight lang="lua"> |
table.sort(table,comp) | table.sort(table,comp) | ||
</source> | </source> | ||
Revision as of 15:31, 13 July 2023
Available since: Gideros 2011.6
Class: table
Description
Sorts the elements of a table in-place (i.e. alter the table). <syntaxhighlight lang="lua"> table.sort(table,comp) </source>
A comparison function can be provided to customise the element sorting. The comparison function must return a boolean value specifying whether the first argument should be before the second argument in the sequence. The default behaviour is for the < comparison to be made. For example, the following behaves the same as no function being supplied:
> t = { 3,2,5,1,4 }
> table.sort(t)
> = table.concat(t, ", ") -- display sorted values
1, 2, 3, 4, 5
Parameters
table: (table) table to sort
comp: (function) comparison function returning bool comparison result optional
