Arraylist methods syntax: Difference between revisions
m (Automatically generated page update) |
(Automatically generated page update) |
||
Line 12: | Line 12: | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="squareb">[</span><span class="term">%item</span><span class="literal"> =</span><span class="squareb">]</span> <span class="term">al</span><span class="literal">:[[Dequeue (Arraylist function)|Dequeue]]</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="squareb">[</span><span class="term">%item</span><span class="literal"> =</span><span class="squareb">]</span> <span class="term">al</span><span class="literal">:[[Dequeue (Arraylist function)|Dequeue]]</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="squareb">[</span><span class="term">%count</span><span class="literal"> =</span><span class="squareb">]</span> <span class="term">al</span><span class="literal">:[[Enqueue (Arraylist function)|Enqueue]]</span><span class="literal">(</span> <span class="term" title="CollectionItem">collectionItem</span><span class="literal">)</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="squareb">[</span><span class="term">%count</span><span class="literal"> =</span><span class="squareb">]</span> <span class="term">al</span><span class="literal">:[[Enqueue (Arraylist function)|Enqueue]]</span><span class="literal">(</span> <span class="term" title="CollectionItem">collectionItem</span><span class="literal">)</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%item</span><span class="literal"> =</span> <span class="term">al</span><span class="literal">:[[FindNextItem (Arraylist function)|FindNextItem]]</span><span class="literal">(</span> <span class="term" title="SelectionCriterion">selectionCriterion</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Number">Start=</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="literal">)</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%item</span><span class="literal"> =</span> <span class="term">al</span><span class="literal">:[[FindNextItem (Arraylist function)|FindNextItem]]</span><span class="literal">(</span> <span class="term" title="SelectionCriterion">selectionCriterion</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Number">Start=</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="literal">)</span> | ||
Throws [[ItemNotFound class|ItemNotFound]]</p> | |||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%number</span><span class="literal"> =</span> <span class="term">al</span><span class="literal">:[[FindNextItemNumber (Arraylist function)|FindNextItemNumber]]</span><span class="literal">(</span> <span class="term" title="SelectionCriterion">selectionCriterion</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Number">Start=</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="literal">)</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%number</span><span class="literal"> =</span> <span class="term">al</span><span class="literal">:[[FindNextItemNumber (Arraylist function)|FindNextItemNumber]]</span><span class="literal">(</span> <span class="term" title="SelectionCriterion">selectionCriterion</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Number">Start=</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="literal">)</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%item</span><span class="literal"> =</span> <span class="term">al</span><span class="literal">:[[FindPreviousItem (Arraylist function)|FindPreviousItem]]</span><span class="literal">(</span> <span class="term" title="SelectionCriterion">selectionCriterion</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Number">Start=</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="literal">)</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%item</span><span class="literal"> =</span> <span class="term">al</span><span class="literal">:[[FindPreviousItem (Arraylist function)|FindPreviousItem]]</span><span class="literal">(</span> <span class="term" title="SelectionCriterion">selectionCriterion</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Number">Start=</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="literal">)</span> | ||
Throws [[ItemNotFound class|ItemNotFound]]</p> | |||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%number</span><span class="literal"> =</span> <span class="term">al</span><span class="literal">:[[FindPreviousItemNumber (Arraylist function)|FindPreviousItemNumber]]</span><span class="literal">(</span> <span class="term" title="SelectionCriterion">selectionCriterion</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Number">Start=</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="literal">)</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%number</span><span class="literal"> =</span> <span class="term">al</span><span class="literal">:[[FindPreviousItemNumber (Arraylist function)|FindPreviousItemNumber]]</span><span class="literal">(</span> <span class="term" title="SelectionCriterion">selectionCriterion</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Number">Start=</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="literal">)</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%currentItem</span><span class="literal"> =</span> <span class="term">al</span><span class="literal">:[[FirstItem (Arraylist property)|FirstItem]]</span> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%currentItem</span><span class="literal"> =</span> <span class="term">al</span><span class="literal">:[[FirstItem (Arraylist property)|FirstItem]]</span> |
Latest revision as of 22:02, 2 March 2014
The syntax for each of the Arraylist class methods is shown below.
Square brackets indicate optional elements of the method invocation. See also the notation conventions for methods and the List of Arraylist methods.
[%count =] al:Add( itemList)
al:Audit[( [itemFunction], [NumWidth= number], [Separator= string], - [Start= number], [MaxItems= number], [Label= string])]
%average = al:Average[( [itemFunction])]
%copyList = al:Copy
%count = al:Count
%count = al:CountSubset( selectionCriterion)
%copyList = al:DeepCopy
[%item =] al:Dequeue
[%count =] al:Enqueue( collectionItem)
%item = al:FindNextItem( selectionCriterion, [Start= number]) Throws ItemNotFound
%number = al:FindNextItemNumber( selectionCriterion, [Start= number])
%item = al:FindPreviousItem( selectionCriterion, [Start= number]) Throws ItemNotFound
%number = al:FindPreviousItemNumber( selectionCriterion, [Start= number])
%currentItem = al:FirstItem al:FirstItem = newItem
[%count =] al:Insert( number, itemList)
%currentItem = al:Item( number) al:Item( number) = newItem
%currentItem = al:LastItem al:LastItem = newItem
%newList = [%(Arraylist Of itemType):]List( itemList)
%number = al:Maximum[( [itemFunction])]
%item = al:MaximumItem[( [itemFunction])]
%number = al:Minimum[( [itemFunction])]
%item = al:MinimumItem[( [itemFunction])]
%al = [%(Arraylist Of itemType):]New
[%item =] al:Pop
al:Print[( [itemFunction], [NumWidth= number], [Separator= string], - [Start= number], [MaxItems= number], [Label= string])]
[%count =] al:Push( collectionItem)
[%count =] al:RemoveItem( number)
al:Sort[( [sortOrder])]
%newList = al:SortNew[( [sortOrder])]
%standardDev = al:StandardDeviation[( [itemFunction])]
%newList = al:SubsetNew( selectionCriterion)
%sum = al:Sum[( [itemFunction])]
al:Trace[( [itemFunction], [NumWidth= number], [Separator= string], - [Start= number], [MaxItems= number], [Label= string])]
%variance = al:Variance[( [itemFunction])]