Minimum (Arraylist function): Difference between revisions
Jump to navigation
Jump to search
m (Apply Dave's comments) |
m (→See also) |
||
| (18 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Arraylist:Minimum subtitle}} | {{Template:Arraylist:Minimum subtitle}} | ||
<var>Minimum</var> returns the number of the <var>Arraylist</var> item that has the minimum numeric value after the application of a specified function to each item. The function that gets applied to each <var>Arraylist</var> item, which you identify in the argument to <var>Minimum</var>, 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>, <var>Longstring</var>, or <var>Unicode</var>) value. | |||
==Syntax== | ==Syntax== | ||
{{Template:Arraylist:Minimum syntax}} | {{Template:Arraylist:Minimum syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%number</th> | <tr><th>%number</th> | ||
<td>A numeric variable to return the item number of the item in the indicated <var>Arraylist</var> that has the minimum value after the argument method has been applied. </td></tr> | <td>A numeric variable to return the item number of the item in the indicated <var>Arraylist</var> that has the minimum value after the argument method has been applied. </td></tr> | ||
<tr><th>al</th> | <tr><th>al</th> | ||
<td>An <var>Arraylist</var> object. </td></tr> | <td>An <var>Arraylist</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) for a method that operates on items of the type specified on the <var class="term">al</var> declaration and that returns a numeric or string value.<p>As of <var class="product">Sirius Mods</var> version 7.6, the special identity function, < | <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) for a method that operates on items of the type specified on the <var class="term">al</var> declaration and that returns a numeric or string 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 <var>[[Maximum (Arraylist function)|Maximum]]</var> and <var>Minimum</var>. See [[Collections#Using the This function as the Maximum parameter|"Using the This function as the Maximum parameter"]].</p></td></tr> | |||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li>If the function applied by <var>Minimum</var> returns | <li>If the function applied by <var>Minimum</var> returns <var>String</var> or <var>Unicode</var> values, <var>Minimum</var> uses the collating sequence of EBCDIC or Unicode, respectively, to determine the number of the item that has the lowest value. If the function returns a numeric type, numeric comparisons are used. | ||
<li>If one or more <var>Arraylist</var> items have equal, minimum, values, <var>Minimum</var> returns the position of the item that appears closest to the beginning of the <var>Arraylist</var>. | <li>If one or more <var>Arraylist</var> items have equal, minimum, values, <var>Minimum</var> returns the position of the item that appears closest to the beginning of the <var>Arraylist</var>. | ||
<li>The parameter for <var>Minimum</var> is a method value, not a User Language expression. That is, you cannot provide a function that itself has an argument (say, <code> | |||
<li><var>Minimum</var> is available in <var class="product">Sirius Mods</var> | <li>The parameter for <var>Minimum</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>Minimum</var> parameter. See the [[Maximum (Arraylist function)#Maximum and Minimum with local method|"Maximum and Minimum with local method"]] example, which shows a way to apply <var>[[ToIntegerPower and ToPower (Float functions)|ToIntegerPower]]</var> with the <var>Maximum</var> or <var>Minimum</var> method. | ||
<li><var>Minimum</var> is available in <var class="product">[[Sirius Mods|Sirius Mods]]</var> Version 7.3 and later. | |||
</ul> | </ul> | ||
==Examples== | ==Examples== | ||
In the following example, <var>Minimum</var> and <var>[[Maximum (Arraylist function)|Maximum]]</var> use the special method, <var>This</var>, which simply returns the item value. The <var>[[List (Arraylist function)|List]]</var> function simplifies the construction of the <var>Arraylist</var>. | |||
<p class="code">begin | <p class="code">begin | ||
%alist is collection arraylist of string len 12 | %alist is collection arraylist of string len 12 | ||
%alist = | %alist = [[List_(Arraylist_function)|list]]('broken', 'br4ck', 'brown', 'Box', 'bumped') | ||
PrintText {~} is {%alist:minimum(this)} | [[PrintText statement|printText]] {~} is {%alist:minimum(this)} | ||
printText {~} is {%alist:maximum(this)} | |||
end | end | ||
</p> | </p> | ||
| Line 44: | Line 45: | ||
</p> | </p> | ||
==See also== | |||
</ | <ul> | ||
<li>The <var>[[Maximum (Arraylist function)|Maximum]]</var> function is the opposite of the <var>Minimum</var> function. | |||
<li>For additional <var>Minimum</var> and <var>Maximum</var> examples, see the [[Maximum (Arraylist function)#Examples|Arraylist Maximum function examples]] and [[Collections#Finding collection maxima and minima, and sorting|"Finding collection maxima and minima, and sorting"]]. | |||
</ul> | |||
{{Template:Arraylist:Minimum footer}} | {{Template:Arraylist:Minimum footer}} | ||
Latest revision as of 16:15, 1 November 2012
Get number of minimum item (Arraylist class)
Minimum returns the number of the Arraylist item that has the minimum numeric value after the application of a specified function to each item. The function that gets applied to each Arraylist 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.
Syntax
%number = al:Minimum[( [itemFunction])]
Syntax terms
| %number | A numeric variable to return the item number of the item in the indicated Arraylist that has the minimum value after the argument method has been applied. |
|---|---|
| al | An Arraylist 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 items of the type specified on the al declaration and that returns a numeric or string value. As of Sirius Mods version 7.6, the special identity function, This, is the default itemFunction value for Maximum and Minimum. See "Using the This function as the Maximum parameter". |
Usage notes
- If the function applied by Minimum returns String or Unicode values, Minimum uses the collating sequence of EBCDIC or Unicode, respectively, to determine the number of the item that has the lowest value. If the function returns a numeric type, numeric comparisons are used.
- If one or more Arraylist items have equal, minimum, values, Minimum returns the position of the item that appears closest to the beginning of the Arraylist.
- The parameter for Minimum 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 Minimum parameter. See the "Maximum and Minimum with local method" example, which shows a way to apply ToIntegerPower with the Maximum or Minimum method. - Minimum is available in Sirius Mods Version 7.3 and later.
Examples
In the following example, Minimum and Maximum use the special method, This, which simply returns the item value. The List function simplifies the construction of the Arraylist.
begin %alist is collection arraylist of string len 12 %alist = list('broken', 'br4ck', 'brown', 'Box', 'bumped') printText {~} is {%alist:minimum(this)} printText {~} is {%alist:maximum(this)} end
The result is:
%alist:minimum(this) is 1 %alist:maximum(this) is 4
See also
- The Maximum function is the opposite of the Minimum function.
- For additional Minimum and Maximum examples, see the Arraylist Maximum function examples and "Finding collection maxima and minima, and sorting".