selectMin: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(see also)
m (template:command argument fix)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


|Returns the array element with [[min]]imum numerical value. Engine solution to [[BIS_fnc_lowestNum]] and [[BIS_fnc_findExtreme]]. Therefore it is expected that supplied array consists of [[Number]]s only.  [[Boolean]]s however are also supported and will be evaluated as [[Number]]s: [[true]] - 1, [[false]] - 0. [[nil]] value treated as 0. Other non [[Number]] elements (not recommended) will be evaluated as 0 and '''Bad conversion: scalar''' message will be logged into .[[rpt]].|= Description
|Returns the array element with [[min]]imum numerical value. Engine solution to [[BIS_fnc_lowestNum]] and [[BIS_fnc_findExtreme]]. Therefore it is expected that supplied array consists of [[Number]]s only.  [[Boolean]]s however are also supported and will be evaluated as [[Number]]s: [[true]] - 1, [[false]] - 0. [[nil]] value treated as 0. Other non [[Number]] elements (not recommended) will be evaluated as 0 and '''Bad conversion: scalar''' message will be logged into .[[rpt]].|DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


|'''selectMin''' array |= Syntax
|'''selectMin''' array |SYNTAX=


|p1= array: [[Array]] - array of [[Number]]s (see description)
|p1= array: [[Array]] - array of [[Number]]s (see description)


| [[Anything]] - element with [[min]]imum numerical value |= Return value
| [[Anything]] - element with [[min]]imum numerical value |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <code>_min = [[selectMin]] [1,2,3,4,5]; //1</code>  |= Example 1
|x1= <code>_min = [[selectMin]] [1,2,3,4,5]; //1</code>  |EXAMPLE1=
|x2= <code>// Same as, for example:  
|x2= <code>// Same as, for example:  
_min = _a [[min]] _b [[min]] _c [[min]] _d;
_min = _a [[min]] _b [[min]] _c [[min]] _d;
// Only faster:
// Only faster:
_min = [[selectMin]] [_a,_b,_c,_d];</code>  |= Example 1
_min = [[selectMin]] [_a,_b,_c,_d];</code>  |EXAMPLE1=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[selectMax]], [[min]], [[max]], [[selectRandom]], [[select]], [[selectRandomWeighted]]|= See also
| [[selectMax]], [[min]], [[max]], [[selectRandom]], [[select]], [[selectRandomWeighted]]|SEEALSO=


}}
}}

Revision as of 15:46, 7 April 2019

Hover & click on the images for description

Description

Description:
Returns the array element with minimum numerical value. Engine solution to BIS_fnc_lowestNum and BIS_fnc_findExtreme. Therefore it is expected that supplied array consists of Numbers only. Booleans however are also supported and will be evaluated as Numbers: true - 1, false - 0. nil value treated as 0. Other non Number elements (not recommended) will be evaluated as 0 and Bad conversion: scalar message will be logged into .rpt.
Groups:
Uncategorised

Syntax

Syntax:
selectMin array
Parameters:
array: Array - array of Numbers (see description)
Return Value:
Anything - element with minimum numerical value

Examples

Example 1:
_min = selectMin [1,2,3,4,5]; //1
Example 2:
// Same as, for example: _min = _a min _b min _c min _d; // Only faster: _min = selectMin [_a,_b,_c,_d];

Additional Information

See also:
selectMaxminmaxselectRandomselectselectRandomWeighted

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note