AMin
(Engine-Level Function)
Description: | Array minimum. This function returns the minimum value in a sub-range of a numeric array. |
Returns: | Numeric |
Usage: | Script or steady state. |
Function Groups: | Array, Generic Math |
Related to: | AMax | Array Functions |
Format: | AMin(ArrayElem, N) |
Parameters: |
ArrayElem |
Required A numeric array element. The subscript(s) for the array may be any numeric expression, specifying the starting point for the array minimum search. |
N |
Required Any numeric expression giving the number of array elements to use, starting at the element given by the first parameter. If N extends past the upper bound of the lowest array dimension, this computation will "wrap-around" and resume at element 0 until N elements have been processed. |
Comments: | AMin ignores invalid array entries. The function only returns invalid if the array subscript is invalid, N is invalid, or if all of the array entries in the specified range are invalid. If processing a multidimensional array, the usual rules apply to decide which dimension should be examined. |
Example:
low = AMin(trendData[0] { Start at element 0 }, 100 { Search through 100 elements });
The example above sets low to the lowest value of trendData elements 0 to 99. Because this function ignores invalid array elements, low will be some valid value unless all elements 0 to 99 are invalid.