Maximum (FloatNamedArraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
 
(26 intermediate revisions by 6 users not shown)
Line 1: Line 1:
<span style="font-size:120%; color:black"><b><section begin=dpl_desc/>Get item that has maximum value<section end=dpl_desc/></b></span>
{{Template:FloatNamedArraylist:Maximum subtitle}}
[[Category:FloatNamedArraylist methods|Maximum function]]
<!--DPL?? Category:FloatNamedArraylist methods|Maximum function: Get item that has maximum value-->
<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.
<p>
Maximum is a member of the [[FloatNamedArraylist class]].
==Syntax==
</p>
{{Template:FloatNamedArraylist:Maximum syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%number</th>
<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>fltNal</th>
<td>A <var>FloatNamedArraylist</var> object.</td></tr>
<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.
<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>
==Usage notes==
<ul>
<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.


This function returns the number (subscript) of the FloatNamedArraylist item
<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>.
that has the maximum value after the application of a specified function to
each item.
The function that gets applied to each FloatNamedArraylist item, which
you identify in the argument to Maximum, must be a method
that operates on the item type and returns a User Language intrinsic
datatype (Float, String, Longstring, or Unicode) value.


The system intrinsic classes are discussed in "[[Intrinsic classes]]".
<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>.
Local methods are discussed in [[??]] refid=localm..


Maximum is available in ''Sirius Mods'' version 7.3 and later.
<li><var>Maximum</var> is available in <var class="product">[[Sirius Mods|Sirius Mods]]</var> Version 7.3 and later.
==Syntax==
</ul>
<p class="code">%num = %fnamrayl:Maximum(function)
</p>
===Syntax Terms===
<dl>
<dt><i>%num</i>
<dd>A numeric variable to contain the subscript number of the
item in the indicated FloatNamedArraylist that has the maximum value
after the argument function has been applied.
<dt><i>%fnamrayl</i>
<dd>A FloatNamedArraylist object.
<dt><i>function</i>
<dd>A method value (a method name literal, a method variable,
or even a method that returns a method value) for a method
that operates on objects of the type specified on the ''%fnamrayl''
declaration and that returns a numeric or string value.


As of ''Sirius Mods'' version 7.6, the special identity function, <tt>This</tt>,
==Examples==
is the default ''function'' value for the Maximum and Minimum methods.
For examples of <var>Maximum</var> (and <var>Minimum</var>) calls, see the [[Minimum (FloatNamedArraylist function)#Examples|"FloatNamedArraylist Minimum function example"]] in
See [[Collections#Using the This function as the Maximum parameter|Using the This function as the Maximum parameter]].
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"]].
 
</dl>
==See also==
==Usage Notes==
<ul><li><var>[[Minimum_(FloatNamedArraylist_function)|Minimum]]</var> is the opposite of the <var>Maximum</var> function.</ul>
<ul>
{{Template:FloatNamedArraylist:Maximum footer}}
<li>If the function applied by Maximum returns string values, Maximum
uses the decimal-equivalent value of the character bytes and determines
the number of the item that has the greatest value.
Therefore, lowercase letters are ranked alphabetically and
the maximum lowercase letter is &ldquo;z&rdquo;;
the uppercase letters are ranked alphabetically and
the maximum uppercase letter is &ldquo;Z&rdquo;;
&ldquo;z&rdquo; ranks lower than all the uppercase letters;
and all letters rank lower than any number.
<li>If two or more FloatNamedArraylist items have equal, maximum, values,
Maximum returns the subscript of the item that appears closest to the beginning
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, <tt>ToIntegerPower(2)</tt>) as the Maximum parameter.
Example "[[Maximum (Arraylist function)|Maximum/Minimum with local method]]" shows a way to apply ToIntegerPower
with Maximum for an Arraylist.
<li>The [[Minimum (FloatNamedArraylist function)|Minimum]] function is the opposite of the Maximum function.
<li>For examples of Maximum (and Minimum) calls, see [[Minimum (FloatNamedArraylist function)#Examples|FloatNamedArraylist Minimum function example]] in
the Minimum method description, and see [[Collections#Finding collection maxima and minima, and sorting|Finding collection maxima and minima, and sorting]].
</ul>

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.
Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=Maximum_(FloatNamedArraylist_function)&oldid=15735"