BIS fnc nearestNum: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - " \|seealso *= *([^ ]*)\[\[BIS fnc ([a-zA-Z0-9_]+)\]\]([^ ]*)" to " |seealso= $1BIS_fnc_$2$3")
 
(27 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma2
____________________________________________________________________________________________
|version1= 1.00


| arma2 |= Game name
|game2= arma2oa
|version2= 1.50


|1.00|= Game version
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| <pre>
|game4= arma3
/************************************************************
|version4= 0.50
Find Nearest Number


Parameters: [[number set], target number]
|gr1= Arrays
Returns: number


Returns the number out of the set which is closest to the target number
|gr2= Math


Example: [[1,5,10], 4] call BIS_fnc_nearestNum
|descr= Returns the provided set closest number to the target number.
returns 5
************************************************************/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|s1= [values, value] call [[BIS_fnc_nearestNum]]
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_nearestNum]]; --> |= Syntax
|p1= values: [[Array]] of [[Number]]s - values to choose from


|p1= |= Parameter 1
|p2= value: [[Number]] - the reference value


| |= Return value
|r1= [[Number]] - the closest value
____________________________________________________________________________________________


|x1= <code></code> |=
|x1= <sqf>private _closestValueTo4 = [[1,5,10], 4] call BIS_fnc_nearestNum; // returns 5</sqf>
____________________________________________________________________________________________
 
| |= See also


|seealso=  [[BIS_fnc_randomNum]] [[random]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Numbers|{{uc:nearestNum}}]]
[[Category:Functions|{{uc:nearestNum}}]]
[[Category:{{Name|arma2}}: Functions|{{uc:nearestNum}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:nearestNum}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:nearestNum}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:nearestNum}}]]

Latest revision as of 18:02, 13 July 2022

Hover & click on the images for description

Description

Description:
Returns the provided set closest number to the target number.
Execution:
call
Groups:
ArraysMath

Syntax

Syntax:
[values, value] call BIS_fnc_nearestNum
Parameters:
values: Array of Numbers - values to choose from
value: Number - the reference value
Return Value:
Number - the closest value

Examples

Example 1:
private _closestValueTo4 = [[1,5,10], 4] call BIS_fnc_nearestNum; // returns 5

Additional Information

See also:
BIS_fnc_randomNum random

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