Add (Arraylist function)

2011-03-14T20:11:36Z

Curly: /* Syntax terms */

{{Template:Arraylist:Add subtitle}}
<var>Add</var> adds an item to the end of an <var>Arraylist</var>.

==Syntax==
{{Template:Arraylist:Add syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%count</th>
<td>An, optional, numeric variable that returns the number of items in the indicated <var>Arraylist</var> after the items have been added. <var class="term">%count</var> is also the item number associated with the last or only added item in the <var>Arraylist</var>. </td></tr>
<tr><th>al</th>
<td>An <var>Arraylist</var> object. </td></tr>
<tr><th>itemList</th>
<td>Under <var class="product">Sirius Mods</var> 7.9 and later this can be a comma-delimited set of values or variables of the same type as specified on the <var class="term">al</var> declaration or collections of objects of the same type as specified on the <var class="term">al</var> declaration. Each of these, from left to right, becomes an item or items in the method object <var>Arraylist</var>.

Under <var class="product">Sirius Mods</var> 7.8 and earlier <var>itemList</var> can only be a single value or variable of the same type as specified on the <var class="term">al</var> declaration, or a value or variable convertible to that type to be added to the <var class="term">al</var> <var>Arraylist</var> object.

Of course, a single value or variable is just a single item list so can be specified under <var class="product">Sirius Mods</var> 7.9 and later, too.</td></tr>

</table>

==Usage notes==
<ul><li>The <var>[[Push (Arraylist function)|Push]]</var> and <var>[[Enqueue (Arraylist function)|Enqueue]]</var> functions are the same as the <var>Add</var> function with the exception that <var>Push</var> and <var>Enqueue</var> can only add a single item to the target <var>Arraylist</var> while (under <var class="product">Sirius Mods</var> 7.9 and later) <var>Add</var> can add many items to the target <var>Arraylist</var>:
<ul>
<li><var>Push</var> was designed as a convenience for use with the <var>[[Pop (Arraylist function)|Pop]]</var> function.
<li><var>Enqueue</var> was designed as a convenience for use with the <var>[[Dequeue (Arraylist function)|Dequeue]]</var> function.
</ul></ul>

==Examples==
For more examples of <var>Add</var> calls, see [[Arraylist class]].
===Adding numbers to an Arraylist===
In the following example, a literal number, a numeric variable and another <var>Arraylist</var> of numbers is added to an <var>Arraylist</var>:
<p class="code">b

%nums is arraylist of float
%perfect is float
%primes is arraylist of float

%nums = list(0, 1)
%perfect = 6
%primes = list(2, 3, 5, 7, 11, 13, 17, 23)

%nums:add(16, %perfect, %primes)
%nums:print

end
</p>
This outputs:
<p class="output">1: 0
2: 1
3: 16
4: 6
5: 2
6: 3
7: 5
8: 7
9: 11
10: 13
11: 17
12: 23
</p>
===Adding objects to an Arraylist===
In the following example, a new object, an object variable and another <var>Arraylist</var> of objects is added to an <var>Arraylist</var>:
<p class="code">b

class coordinate
public
constructor new(%x is float, %y is float)
function toString is longstring
variable x is float
variable y is float
end public
constructor new(%x is float, %y is float)
%this:x = %x; %this:y = %y
end constructor
function toString is longstring
returnText coordinate: x={%x}, y={%y}
end function
end class

%points is arraylist of object coordinate
%where is object coordinate
%locations is arraylist of object coordinate

%points = list(new(6, 9), new(-4, 3))
%where = new(17, -3)
%locations = list(new(1, 1), new(2, 5), new(3, 11))

%points:add(new(4, 3), %where, %locations)

%points:print

end
</p>
This outputs:
<p class="output">1: coordinate: x=6, y=9
2: coordinate: x=-4, y=3
3: coordinate: x=4, y=3
4: coordinate: x=17, y=-3
5: coordinate: x=1, y=1
6: coordinate: x=2, y=5
7: coordinate: x=3, y=11
</p>

==See also==
{{Template:Arraylist:Add footer}}

m204wiki - User contributions [en]

Add (Arraylist function)