BIS fnc codePerformance: Difference between revisions

Revision as of 20:10, 18 July 2022

Hover & click on the images for description

Description:: Measures how much time it takes to execute given expression. Results may vary based on overall performance; use this function to compare alternative scripting approaches rather than to measure specific values. Upon function execution, window with results is opened. The user then has a choice to copy the result into clipboard or not.
This function is using diag_codePerformance command.

ⓘ
Use toString to stringify Code, as str adds curly braces - See Example 2.
Execution:: call
Groups:: Diagnostic

Syntax:: [expression, arguments, cycles, display] call BIS_fnc_codePerformance
Parameters:: expression: String - tested expression
: arguments: Anything - (Optional, default []) arguments to pass into the code
: cycles: Number - (Optional, default 10000) number of wanted cycles
: display: Display - (Optional, default findDisplay 46) display in which the message window with results will be opened. Use displayNull to disable the window
Return Value:: Number - Average execution time of the expression

Example 1:: // compare three methods of adding elements into array testArray = []; ["testArray = testArray + [1]"] call BIS_fnc_codePerformance; testArray = []; ["testArray set [count testArray, 1]"] call BIS_fnc_codePerformance; testArray = []; ["testArray pushBack 1"] call BIS_fnc_codePerformance;
Example 2:: [toString { hint "Hello there" }] call BIS_fnc_codePerformance;

: 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

@@ Line 12: / Line 12: @@
 This function is using [[diag_codePerformance]] command.
-{{Feature|informative|Use {{ic|[[toString]] _code}} instead of [[str]] as the latter adds curly braces to the string.}}
+{{Feature|informative|Use [[toString]] to stringify [[Code]], as [[str]] adds curly braces - See {{Link|#Example 2}}.}}
 |s1= [expression, arguments, cycles, display] call [[BIS_fnc_codePerformance]]
@@ Line 22: / Line 22: @@
 |p3= cycles: [[Number]] - (Optional, default 10000) number of wanted cycles
-|p4= display: [[Display]] - (Optional, default {{ic|[[findDisplay]] 46}}) display in which the message window with results will be opened. Use [[displayNull]] to disable the window
+|p4= display: [[Display]] - (Optional, default <sqf inline>findDisplay 46</sqf>) display in which the message window with results will be opened. Use [[displayNull]] to disable the window
 |r1= [[Number]] - Average execution time of the expression
@@ Line 35: / Line 35: @@
 ["testArray pushBack 1"] call BIS_fnc_codePerformance;
 </sqf>
+|x2= <sqf>[toString { hint "Hello there" }] call BIS_fnc_codePerformance;</sqf>
 |seealso= [[diag_codePerformance]]
 }}