BIS fnc codePerformance: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "(Optional, default {{hl|[]}})" to "(Optional, default <sqf inline>[]</sqf>)")
 
(67 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function
____________________________________________________________________________________________


| TKOH |= Game name
|game1= arma3
|version1= 0.50


|1.00|= Game version
|gr1= Diagnostic
____________________________________________________________________________________________


| Measures how much time it takes to execute given expression. |= Description
|descr= [[File:BIS_fnc_codePerformance.png|300px|right]]
____________________________________________________________________________________________
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.<br>
This function is using [[diag_codePerformance]] command.


| [expression,(cycles)] call BIS_fnc_codePerformance; |= Syntax
{{Feature|informative|Use [[toString]] to stringify [[Code]], as [[str]] adds curly braces - See {{Link|#Example 2}}.}}


|p1= '''expression''': [[String]] - tested expression |=
|s1= [expression, arguments, cycles, display] call [[BIS_fnc_codePerformance]]
|p2= '''cycles''' (Optional): [[Number]] - Number of cycles (default: 10000) |=


| [[Nothing]] |= Return value
|p1= expression: [[String]] - tested expression
____________________________________________________________________________________________
 
|x1= <code>testArray = [];
["testArray = testArray + [1];"] call BIS_fnc_codePerformance;
testArray = [];
["testArray [[set]] <nowiki>[</nowiki>[[count]] testArray,1];"] call BIS_fnc_codePerformance;
</code>
Compare two methods of adding elements into array|=


____________________________________________________________________________________________
|p2= arguments: [[Anything]] - (Optional, default <sqf inline>[]</sqf>) arguments to pass into the code


| |= See also
|p3= cycles: [[Number]] - (Optional, default 10000) number of wanted cycles


}}
|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


<h3 style="display:none">Notes</h3>
|r1= [[Number]] - average execution time of the expression
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x1= <sqf>
</dl>
// 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;
</sqf>


<h3 style="display:none">Bottom Section</h3>
|x2= <sqf>[toString { hint "Hello there" }] call BIS_fnc_codePerformance;</sqf>


[[Category:Take_On_Helicopters:_Functions|codePerformance]]
|seealso= [[diag_codePerformance]]
[[Function Group: Debug|codePerformance]]
}}

Latest revision as of 18:09, 8 November 2023

Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
BIS fnc codePerformance.png

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

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

Examples

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;

Additional Information

See also:
diag_codePerformance

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_codePerformance&oldid=349499"