MaximumItem (Arraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
 
(One intermediate revision by the same user not shown)
Line 14: Line 14:
<td>An <var>Arraylist</var> object.</td></tr>
<td>An <var>Arraylist</var> object.</td></tr>


<tr><th>method</th>
<tr><th>itemFunction</th>
<td>A function that operates on the type of the items in the <var>Arraylist</var>. It may be a [[Local and Common entities|local method]] or [[Method variables|method variable]] or a class member (<var>Variable</var>, <var>Property</var>), and it must return an [[Intrinsic classes|intrinsic]] value. The default <var class="term">method</var> value is the special identity function, <var>[[Collections#Using the This function as the Maximum parameter|This]]</var>, which simply returns the item value.</td></tr>
<td>A function that operates on the type of the items in the <var>Arraylist</var>. It may be a [[Local and Common entities|local method]] or [[Method variables|method variable]] or a class member (<var>Variable</var>, <var>Property</var>), and it must return an [[Intrinsic classes|intrinsic]] value. The default <var class="term">itemFunction</var> value is the special identity function, <var>[[Collections#Using the This function as the Maximum parameter|This]]</var>, which simply returns the item value.</td></tr>
</table>
</table>


==Usage notes==
==Usage notes==
<ul>
<ul>
<li>The optional <var class="term">method</var> parameter lets you further manipulate the <var>Arraylist</var> item values before performing the  
<li>The optional <var class="term">itemFunction</var> parameter lets you further manipulate the <var>Arraylist</var> item values before performing the  
<var>MaximumItem</var> method's item evaluation.
<var>MaximumItem</var> method's item evaluation.
If your <var>Arraylist</var> items are not intrinsic values, you must specify a <var class="term">method</var> function that can map the item values to intrinsic values or the method will fail.
If your <var>Arraylist</var> items are not intrinsic values, you must specify an <var class="term">itemFunction</var> function that can map the item values to intrinsic values or the method will fail.
</ul>
</ul>


==Examples==
==Examples==
For the <var>ArrayList</var> <code>%al</code> whose items are the odd integers between 0 and 10, <code>%al:maxItem</code> returns <code>9</code>.
For the <var>ArrayList</var> <code>%al</code> whose items are the odd integers between 0 and 10, <var>MaximumItem</var> returns the value of the item that has the maximum value, while <var>Maximum</var> returns the index (item number) of that item:
<p class="code">b                                 
                                   
%al  is arraylist of float         
%al = list(1,3,5,7,9)
 
printText {~=%al:maximumItem}
printText {~=%al:maximum}
end </p>
 
The result is:
<p class="output">%al:maximumItem=9  
%al:maximum=5 </p>


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

Latest revision as of 16:43, 27 July 2012

Get item that has maximum value (Arraylist class)

[Introduced in Sirius Mods 7.8]


MaximumItem is related to the Maximum Arraylist method, which returns the number or name of the item that has the maximum value in an Arraylist.

Syntax

%item = al:MaximumItem[( [itemFunction])]

Syntax terms

%item An Arraylist item of the same type as the al object.
al An Arraylist object.
itemFunction A function that operates on the type of the items in the Arraylist. It may be a local method or method variable or a class member (Variable, Property), and it must return an intrinsic value. The default itemFunction value is the special identity function, This, which simply returns the item value.

Usage notes

  • The optional itemFunction parameter lets you further manipulate the Arraylist item values before performing the MaximumItem method's item evaluation. If your Arraylist items are not intrinsic values, you must specify an itemFunction function that can map the item values to intrinsic values or the method will fail.

Examples

For the ArrayList %al whose items are the odd integers between 0 and 10, MaximumItem returns the value of the item that has the maximum value, while Maximum returns the index (item number) of that item:

b %al is arraylist of float %al = list(1,3,5,7,9) printText {~=%al:maximumItem} printText {~=%al:maximum} end

The result is:

%al:maximumItem=9 %al:maximum=5

See also