Minimum (UnicodeNamedArraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 14: Line 14:
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>name</th>
<tr><th>unicode</th>
<td>A Unicode string to contain the subscript name of the item in the indicated UnicodeNamedArraylist that has the minimum value after the argument function has been applied. </td></tr>
<td>A <var>Unicode</var> string to contain the subscript name of the item in the <var class="term">uniNal</var> method <var>UnicodeNamedArraylist</var> object that has the minimum value after the argument function has been applied. </td></tr>
<tr><th>%unamrayl</th>
<tr><th>uniNal</th>
<td>A UnicodeNamedArraylist object. </td></tr>
<td>A <var>UnicodeNamedArraylist</var> object. </td></tr>
<tr><th>function</th>
<tr><th>itemFunction</th>
<td>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 ''%unamrayl'' declaration and that returns a numeric or string value.
<td>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 <var class="term">uniNal</var> declaration and that returns a numeric or string value.


The special identity function, <tt>This</tt>, is the default ''function'' value for the Maximum and Minimum methods. See [[Collections#Using the This function as the Maximum parameter|"Using the This function as the Maximum parameter"]].</td></tr>
The special identity function, <tt>This</tt>, is the default ''function'' 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"]].</td></tr>


</table>
</table>
==Usage notes==
==Usage notes==
<ul>
<ul>
<li>If the function applied by Minimum returns string values, Minimum
<li>If <var class="term">itemFunction</var> returns string values, <var>Minimum</var>
uses the decimal-equivalent value of the character bytes and determines
uses the decimal-equivalent value of the character bytes and determines
the number of the item that has the lowest value.
the number of the item that has the lowest value.
Line 35: Line 35:
"z" ranks lower than all the uppercase letters;
"z" ranks lower than all the uppercase letters;
and all letters rank lower than any number.
and all letters rank lower than any number.
<li>If one or more UnicodeNamedArraylist items have equal, minimum, values,
<li>If one or more <var>UnicodeNamedArraylist</var> items have equal, minimum, values,
Minimum returns the subscript of the item that appears closest to the beginning
<var>Minimum</var> returns the subscript of the item that appears closest to the beginning
of the UnicodeNamedArraylist.
of the <var>UnicodeNamedArraylist</var>.
<li>The [[Maximum (UnicodeNamedArraylist function)|Maximum]] function is the opposite of the Minimum function.
<li>The [[Maximum (UnicodeNamedArraylist function)|Maximum]] function is the opposite of the <var>Minimum</var> function.
<li>The parameter for Minimum is a method value, not a User Language expression.
<li>The <var class="term">itemFunction</var> argument is a method value, not a User Language expression.
That is, you cannot provide a function that itself has an argument
That is, you cannot provide a function that itself has an argument
(say, <tt>ToIntegerPower(2)</tt>) as the Minimum parameter.
(say, <tt>ToIntegerPower(2)</tt>) as <var class="term">itemFunction</var>.
Example [[Maximum (Arraylist function)|"Maximum/Minimum with local method"]] shows a way to apply ToIntegerPower
Example [[Maximum (Arraylist function)|"Maximum/Minimum with local method"]] shows a way to apply <var>ToIntegerPower</var>
with Maximum or Minimum for an Arraylist.
with <var>Maximum</var> or <var>Minimum</var> for an <var>Arraylist</var>.
</ul>
</ul>
==See also==
==See also==
{{Template:UnicodeNamedArraylist:Minimum footer}}
{{Template:UnicodeNamedArraylist:Minimum footer}}

Revision as of 12:33, 8 February 2012

Name of item with minimum value or minimum value of function applied to items (UnicodeNamedArraylist class)


This function returns the name (subscript) of the UnicodeNamedArraylist item that has the minimum value after the application of a specified function to each item. The function that gets applied to each UnicodeNamedArraylist item, which you identify in the argument to Minimum, 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". Local methods are discussed in ?? refid=localm..

Syntax

%unicode = uniNal:Minimum[( [itemFunction])]

Syntax terms

unicode A Unicode string to contain the subscript name of the item in the uniNal method UnicodeNamedArraylist object that has the minimum value after the argument function has been applied.
uniNal A UnicodeNamedArraylist object.
itemFunction 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 uniNal declaration and that returns a numeric or string value. The special identity function, This, is the default function value for the Maximum and Minimum methods. See "Using the This function as the Maximum parameter".

Usage notes

  • If itemFunction returns string values, Minimum uses the decimal-equivalent value of the character bytes and determines the number of the item that has the lowest value. Therefore, lowercase letters are ranked alphabetically and the minimum lowercase letter is "a"; the uppercase letters are ranked alphabetically and the minimum uppercase letter is "A"; "z" ranks lower than all the uppercase letters; and all letters rank lower than any number.
  • If one or more UnicodeNamedArraylist items have equal, minimum, values, Minimum returns the subscript of the item that appears closest to the beginning of the UnicodeNamedArraylist.
  • The Maximum function is the opposite of the Minimum function.
  • The itemFunction argument 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 itemFunction. Example "Maximum/Minimum with local method" shows a way to apply ToIntegerPower with Maximum or Minimum for an Arraylist.

See also