MaximumItem (Arraylist function): Difference between revisions
Jump to navigation
Jump to search
m (→Syntax terms) |
m (→Usage notes) |
||
Line 21: | Line 21: | ||
<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">method</var> parameter lets you further manipulate the <var>Arraylist</var> item values before performing the | ||
<var>MaximumItem</var> method's item | <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 a <var class="term">method</var> function that can map the item values to intrinsic values or the method will fail. | ||
</ul> | </ul> |
Revision as of 20:59, 18 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 return 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. |
method | 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 method value is the special identity function, This, which simply returns the item value. |
Usage notes
- The optional method 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 a method 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, %al:maxItem
returns 9
.