List - Revision history

JoeStrout: /* Methods */

2022-05-22T18:14:43Z

Methods

2021-12-06T16:03:24Z

Methods

2021-12-06T16:03:01Z

Methods

2021-12-06T16:00:48Z

added default argument for join

2021-12-06T09:53:36Z

Add reference to listUtil

2021-12-06T09:51:48Z

Add missing methods

2021-12-05T23:26:08Z

Fix

2021-12-05T23:25:26Z

Refined parameters

2021-12-05T23:20:37Z

2021-12-05T23:18:50Z

Added method list

@@ Line 20: / Line 20: @@
 | indexOf(''item'') || Returns the index of the first occurrence of ''item'' in the list, or <c>null</c> if not found
 |-
-| push(''item'') || Adds the ''item'' to the end of the list
+| push ''item'' || Adds the ''item'' to the end of the list
 |-
-| remove(''index'') || Removes the element at ''index''
+| remove ''index'' || Removes the element at ''index'' (note: by index, '''not''' by value!)
 |-
 | pop || Removes the ''last'' element of the list, and returns it
@@ Line 36: / Line 36: @@
 | join(''separator''=" ") || Returns a string with all list elements "joined" by a ''separator'' (which defaults to a space)
 |-
-| insert(''index'', ''value'') || Mutates the list by inserting ''value'' at ''index''
+| insert ''index'', ''value'' || Mutates the list by inserting ''value'' at ''index''
 |-
-| replace(''oldValue'', ''newValue'', ''maxCount'') || Mutates the list by replacing occurrences of ''oldValue'' with ''newValue'' at most ''maxCount'', if specified. If ''maxCount'' is omitted it replaces '''all''' occurrences.
+| replace ''oldValue'', ''newValue'', ''maxCount'' || Mutates the list by replacing occurrences of ''oldValue'' with ''newValue'' at most ''maxCount'', if specified. If ''maxCount'' is omitted it replaces '''all''' occurrences.
 |-
 | indexes || Returns a list with the indexes of the elements of the list; equivalent to <c>range(0, theList.len-1)</c>

@@ Line 22: / Line 22: @@
 | push(''item'') || Adds the ''item'' to the end of the list
 |-
-| remove(''index'') || Removes the element at '''index'''
+| remove(''index'') || Removes the element at ''index''
 |-
 | pop || Removes the ''last'' element of the list, and returns it

@@ Line 16: / Line 16: @@
 ! Method !! Description
 |-
-| len || Returns the length of the list
+| len || Returns the length of the list, i.e., the number of items it contains
 |-
 | indexOf(''item'') || Returns the index of the first occurrence of ''item'' in the list, or <c>null</c> if not found
@@ Line 40: / Line 40: @@
 | replace(''oldValue'', ''newValue'', ''maxCount'') || Mutates the list by replacing occurrences of ''oldValue'' with ''newValue'' at most ''maxCount'', if specified. If ''maxCount'' is omitted it replaces '''all''' occurrences.
 |-
-| indexes || Returns a list with the indexes of the elements of the list
+| indexes || Returns a list with the indexes of the elements of the list; equivalent to <c>range(0, theList.len-1)</c>
 |-
 | values || Returns the values of the list (in fact it returns the list itself)

@@ Line 34: / Line 34: @@
 | shuffle || Mutates the list by re-ordering its elements randomly
 |-
-| join(''separator'') || Returns a string with all list elements "joined" by a ''separator''
+| join(''separator''=" ") || Returns a string with all list elements "joined" by a ''separator'' (which defaults to a space)
 |-
 | insert(''index'', ''value'') || Mutates the list by inserting ''value'' at ''index''

@@ Line 46: / Line 46: @@
 == See also ==
-* [[range]]
+* [[listUtil]] - for additional functions on a list
 [[Category:Language]]

@@ Line 2: / Line 2: @@
 A list is mutable, ordered sequence of values.  A list literal is defined by a comma-separated series of values enclosed in square brackets.
 <ms>
@@ Line 7: / Line 9: @@
 words = ["one", "two", "three", "four", "five"]
 </ms>
 [[Category:Language]]