$Arr Min: Difference between revisions
m (misc formatting) |
No edit summary |
||
| (One intermediate revision by one other user not shown) | |||
| Line 4: | Line 4: | ||
<p class="warn"><b>Note:</b> Many $functions have been deprecated in favor of Object Oriented methods. There is no direct OO equivalent for the <var>$Arr_Min</var> function, because the OO methods emphasize the use of [[Collections]] over the use of arrays.</p> | <p class="warn"><b>Note:</b> Many $functions have been deprecated in favor of Object Oriented methods. There is no direct OO equivalent for the <var>$Arr_Min</var> function, because the OO methods emphasize the use of [[Collections]] over the use of arrays.</p> | ||
<var>$Arr_Min</var> can be used to find the minimum value in an array. | <var>$Arr_Min</var> can be used to find the minimum value in an [[Using_variables_and_values_in_computation#.25Variable_arrays|array]]. | ||
If the minimum value occurs in multiple array elements, <var>$Arr_Min</var> always returns the lowest array element number containing that value. | If the minimum value occurs in multiple array elements, <var>$Arr_Min</var> always returns the lowest array element number containing that value. | ||
==Syntax== | ==Syntax== | ||
<p class="syntax"><span class="term">%result</span> = $Arr_Min (array, maxnum) | <p class="syntax"><span class="term">%result</span> = $Arr_Min (<span class="term">array, maxnum</span>) | ||
</p> | </p> | ||
Latest revision as of 12:14, 9 January 2018
Find minimum value in array
Note: Many $functions have been deprecated in favor of Object Oriented methods. There is no direct OO equivalent for the $Arr_Min function, because the OO methods emphasize the use of Collections over the use of arrays.
$Arr_Min can be used to find the minimum value in an array. If the minimum value occurs in multiple array elements, $Arr_Min always returns the lowest array element number containing that value.
Syntax
%result = $Arr_Min (array, maxnum)
| %result | A numeric variable that is set to the array element number that contains the indicated minimum value, or it is set to a -1 if the array or maxnum is invalid. |
|---|---|
| array | An array of string, float, or fixed values. This array must be a single dimensional array and must not be an array in an image. |
| maxnum | The highest array element number to check. This argument can be used to limit the search to the first n elements in an array, where n is a positive integer. |
Examples
In the following example:
%FXARRAY IS FIXED ARRAY(5) %FXARRAY(1) = 81 %FXARRAY(2) = 49 %FXARRAY(3) = 121 %FXARRAY(4) = 25 %NUM = $Arr_Min(%FXARRAY)
%NUM is set to 4.
In the following example:
%STARRAY IS STRING LEN 20 ARRAY(5) %STARRAY(1) = 'HOMER' %STARRAY(2) = 'MARGE' %STARRAY(3) = 'KRUSTY' %STARRAY(4) = 'BART' %STARRAY(5) = 'SELMA' %NUM = $Arr_Min(%STARRAY, 3)
%NUM is set to 1.