Difference between revisions of "Table.sort"

From GiderosMobile
Line 4: Line 4:
 
=== <translate>Description</translate> ===
 
=== <translate>Description</translate> ===
 
<translate>Sort the elements of a table in-place (i.e. alter the table).  
 
<translate>Sort the elements of a table in-place (i.e. alter the table).  
`> t = { 3,2,5,1,4 }`
+
''> t = { 3,2,5,1,4 }''
`> table.sort(t)`
+
''> table.sort(t)''
`> = table.concat(t, ", ")  -- display sorted values`
+
''> = table.concat(t, ", ")  -- display sorted values''
`1, 2, 3, 4, 5`
+
''1, 2, 3, 4, 5''
  
 
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:</translate>
 
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:</translate>

Revision as of 10:37, 24 August 2018

Available since: Gideros 2011.6
Class: table

Description

Sort the elements of a table in-place (i.e. alter the table). > t = { 3,2,5,1,4 } > table.sort(t) > = table.concat(t, ", ") -- display sorted values 1, 2, 3, 4, 5

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:

 table.sort(table,comp)

Parameters

table: (table) table to sort
comp: (function) comparison function returning bool comparison result optional