MaximumItem (GenericNamedArraylist function): Difference between revisions

Revision as of 20:50, 18 July 2012

Item with maximum value or maximum value of function applied to items (FloatNamedArraylist, NamedArraylist, and UnicodeNamedArraylist classes)

[Introduced in Sirius Mods 7.8]

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

%item	item
anyNal	GenericNamedArraylist object
itemFunction	A function that operates on the type of the items in the collection. 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.

Arraylist class FloatNamedArraylist class NamedArraylist class UnicodeNamedArraylist class	List of Arraylist methods List of FloatNamedArraylist methods List of NamedArraylist methods List of UnicodeNamedArraylist methods List of Collection methods	Arraylist methods syntax FloatNamedArraylist methods syntax NamedArraylist methods syntax UnicodeNamedArraylist methods syntax
Notation conventions for methods

@@ Line 6: / Line 6: @@
 ===Syntax terms===
 <table class="syntaxTable">
-<tr><th>%item</th><td>item</td></tr>
+<tr><th>%item</th>
+<td>item</td></tr>
 <tr><th>anyNal</th>
 <td>GenericNamedArraylist object</td></tr>
 <tr><th>itemFunction</th>
-<td><var>ItemFunction</var> object<br/>This argument is optional; its default value is <var>This</var>.</td></tr>
+<td>A function that operates on the type of the items in the collection. 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>
 ==Usage notes==
 ==Examples==
 ==See also==
 {{Template:GenericNamedArraylist:MaximumItem footer}}