Maximum (FloatNamedArraylist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (→Usage notes) |
||
| (15 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:FloatNamedArraylist:Maximum subtitle}} | {{Template:FloatNamedArraylist:Maximum subtitle}} | ||
<var>Maximum</var> returns the (numeric) name of the <var>FloatNamedArraylist</var> item that has the maximum value as returned by a specified function. The function applied to each <var>FloatNamedArraylist</var> item, which you specify with the required <var class="term">itemFunction</var> argument, must be a method that operates on the item type and returns a <var class="product">User Language</var> [[Intrinsic classes|intrinsic]] datatype (<var>Float</var>, <var>String</var>, or <var>Unicode</var>) value. | |||
that has the maximum value | |||
The function | |||
you | |||
that operates on the item type and returns a User Language intrinsic | |||
datatype (Float, String | |||
==Syntax== | ==Syntax== | ||
{{Template:FloatNamedArraylist:Maximum syntax}} | {{Template:FloatNamedArraylist:Maximum syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th>%number</th> | ||
<td>A numeric variable to contain the | <td>A numeric variable to contain the name of the item in the indicated <var>FloatNamedArraylist</var> that has the maximum value as returned by the argument function.</td></tr> | ||
<tr><th> | <tr><th>fltNal</th> | ||
<td>A FloatNamedArraylist object. </td></tr> | <td>A <var>FloatNamedArraylist</var> object.</td></tr> | ||
<tr><th> | |||
<td>A method value (a method name literal, a method variable, or even a method that returns a method value) | <tr><th>itemFunction</th> | ||
<td>A method value (a method name literal, a [[Method variables|method variable]], or even a method that returns a method value) that operates on objects of the type specified on the <var class="term">fltNal</var> declaration and that returns an intrinsic value. | |||
As of | <p>As of <var class="product">Sirius Mods</var> Version 7.6, the special identity function, <var>This</var>, is the default <var class="term">itemFunction</var> value for the <var>Maximum</var> and <var>Minimum</var> methods. See [[Collections#Using the This function as the Maximum parameter|"Using the This function as the Maximum parameter"]] for more information.</p></td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li>If | <li>If <var class="term">itemFunction</var> returns <var>String</var> or <var>Unicode</var> values, <var>Maximum</var> uses the collating sequence of EBCDIC or Unicode, respectively, to determine which item has the greatest value. If <var class="term">itemFunction</var> returns a numeric type, numeric comparisons are used. See the second [[Maximum (NamedArraylist function)#Examples|"example"]] for the <var>NamedArraylist</var> <var>Maximum</var> function. | ||
uses the | |||
<li>If the values returned by <var class="term">itemFunction</var> for two or more <var>FloatNamedArraylist</var> items are equal, maximum, values, <var>Maximum</var> returns the (numeric) name of that item which is closest to the beginning of the <var>FloatNamedArraylist</var>. | |||
<li>The parameter for <var>Maximum</var> is a method value, not a <var class="product">User Language</var> expression. That is, you cannot provide a function that itself has an argument (say, <code>ToIntegerPower(2)</code>) as the <var>Maximum</var> parameter. The [[Maximum (Arraylist function)#Maximum and Minimum with local method|"Maximum and Minimum with local method"]] example shows a way to apply <var>[[ToIntegerPower and ToPower (Float functions)|ToIntegerPower]]</var> with <var>Maximum</var>. | |||
the | <li><var>Maximum</var> is available in <var class="product">[[Sirius Mods|Sirius Mods]]</var> Version 7.3 and later. | ||
<li>If two or more FloatNamedArraylist items | |||
Maximum returns the | |||
of the FloatNamedArraylist. | |||
<li>The parameter for Maximum is a method value, not a User Language expression. | |||
That is, you cannot provide a function that itself has an argument | |||
(say, < | |||
< | |||
<li> | |||
</ul> | </ul> | ||
==Examples== | |||
For examples of <var>Maximum</var> (and <var>Minimum</var>) calls, see the [[Minimum (FloatNamedArraylist function)#Examples|"FloatNamedArraylist Minimum function example"]] in | |||
the <var>Minimum</var> method description, and [[Collections#Finding collection maxima and minima, and sorting|"Finding collection maxima and minima, and sorting"]], and the [[Maximum (NamedArraylist function)#Examples|"NamedArraylist Maximum function example"]]. | |||
==See also== | ==See also== | ||
<ul><li><var>[[Minimum_(FloatNamedArraylist_function)|Minimum]]</var> is the opposite of the <var>Maximum</var> function.</ul> | |||
{{Template:FloatNamedArraylist:Maximum footer}} | {{Template:FloatNamedArraylist:Maximum footer}} | ||
Latest revision as of 20:30, 1 November 2012
Name of item with maximum value or maximum value of function applied to items (FloatNamedArraylist class)
Maximum returns the (numeric) name of the FloatNamedArraylist item that has the maximum value as returned by a specified function. The function applied to each FloatNamedArraylist item, which you specify with the required itemFunction argument, must be a method that operates on the item type and returns a User Language intrinsic datatype (Float, String, or Unicode) value.
Syntax
%number = fltNal:Maximum[( [itemFunction])]
Syntax terms
| %number | A numeric variable to contain the name of the item in the indicated FloatNamedArraylist that has the maximum value as returned by the argument function. |
|---|---|
| fltNal | A FloatNamedArraylist object. |
| itemFunction | A method value (a method name literal, a method variable, or even a method that returns a method value) that operates on objects of the type specified on the fltNal declaration and that returns an intrinsic value.
As of Sirius Mods Version 7.6, the special identity function, This, is the default itemFunction value for the Maximum and Minimum methods. See "Using the This function as the Maximum parameter" for more information. |
Usage notes
- If itemFunction returns String or Unicode values, Maximum uses the collating sequence of EBCDIC or Unicode, respectively, to determine which item has the greatest value. If itemFunction returns a numeric type, numeric comparisons are used. See the second "example" for the NamedArraylist Maximum function.
- If the values returned by itemFunction for two or more FloatNamedArraylist items are equal, maximum, values, Maximum returns the (numeric) name of that item which is closest to the beginning of the FloatNamedArraylist.
- The parameter for Maximum is a method value, not a User Language expression. That is, you cannot provide a function that itself has an argument (say,
ToIntegerPower(2)) as the Maximum parameter. The "Maximum and Minimum with local method" example shows a way to apply ToIntegerPower with Maximum. - Maximum is available in Sirius Mods Version 7.3 and later.
Examples
For examples of Maximum (and Minimum) calls, see the "FloatNamedArraylist Minimum function example" in the Minimum method description, and "Finding collection maxima and minima, and sorting", and the "NamedArraylist Maximum function example".
See also
- Minimum is the opposite of the Maximum function.