diag codePerformance: Difference between revisions

Latest revision as of 13:22, 9 July 2023

1.58

Hover & click on the images for description

Description

Description:: Attempts to run given code with given arguments given number of cycles in unscheduled environment and returns average time it took to run the code as well as actual number of executions performed. The command will return as soon as possible if the tested code is slow and the duration of the command exceeds 1 second. Engine alternative to BIS_fnc_codePerformance.
Multiplayer:: For security purposes, this command will only run for 1 cycle in multiplayer, unless in-game debug console is available via description.ext option or Eden attribute setting.
Groups:: Diagnostic Performance Profiling

Syntax

Syntax:

diag_codePerformance [code, arguments, cycles]

Parameters:

code: Code - code to compare performance

arguments: Anything - (Optional, default nil) arguments to pass to the code in _this variable. Default: nil

cycles: Number - (Optional, default 100000) wanted number of cycles to run the given code. > 1000 is recommended

since 2.14

ignoreTimeLimit: Boolean - (Optional, default false) - ignore the 1 second timelimit, and always run the provided number of cycles (except in multiplayer)

Return Value:

Array format [duration, cycles], where:

duration: Number - average duration of 1 execution in milliseconds
cycles: Number - actual number of cycles executed

Examples

Example 1:: private _result = diag_codePerformance [{ private _a = 123; }, 0, 10000];

Additional Information

See also:: diag_log BIS_fnc_codePerformance Code Optimisation

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

@@ Line 1: / Line 1: @@
-{{DISPLAYTITLE:diag_codePerformance}}
+{{RV|type=command
-{{Command|Comments=
-____________________________________________________________________________________________
-| A3 |= Game
+|game1= arma3
-|1.58|Game Version= (number surrounded by NO SPACES)
+|version1= 1.58
-____________________________________________________________________________________________
-| Attempts to run given code with given arguments given number of cycles in unscheduled environment and returns average time it took to run the code as well as actual number of executions performed. The command will return as soon as possible if the tested code is slow and the duration of the command exceeds 1 second. Engine alternative to [[BIS_fnc_codePerformance]]<br><br>
+|gr1= Diagnostic
-'''NOTE:''' For security purposes, this command will only run for 1 cycle in MP, unless in-game [[Mission_Editor:_Debug_Console_(Arma_3)|debug console]] is available via [[description.ext]] option or [[Eden]] attribute setting. |DESCRIPTION=
-____________________________________________________________________________________________
-|  '''diag_codePerformance''' [code, arguments, cycles] |SYNTAX=
+|gr2= Performance Profiling
-|p1= [code, arguments, cycles]: [[Array]] |Parameter1=
-|p2= code: [[Code]] - code to compare performance |Parameter2=
+|descr= Attempts to run given code with given arguments given number of cycles in unscheduled environment and returns average time it took to run the code as well as actual number of executions performed.
+The command will return as soon as possible if the tested code is slow and the duration of the command exceeds 1 second.
+Engine alternative to [[BIS_fnc_codePerformance]].
-|p3= arguments (Optional): [[Anything]] - arguments to pass to the code in _this variable. Default: [[nil]] |=
+|mp= For security purposes, this command will only run for 1 cycle in multiplayer, unless in-game [[Arma 3: Debug Console|debug console]] is available via [[Description.ext|description.ext]] option or [[:Category:Eden Editor|Eden]] attribute setting.
-|p4= cycles (Optional): [[Number]] - wanted number of cycles to run the given code. > 1000 is recommended. Default: 100000 |=
-| [[Array]] - format [duration, cycles], where:
-* duration: [[Number]] - average duration of 1 execution in milliseconds
-* cycles: [[Number]] - actual number of cycles executed |RETURNVALUE=
+|s1= [[diag_codePerformance]] [code, arguments, cycles]
-|x1= <code>_result = [[diag_codePerformance]] [{[[private]] _a = 123;}, 0, 10000];</code>|EXAMPLE1=
+|p1= code: [[Code]] - code to compare performance
-____________________________________________________________________________________________
-| [[diag_log]], [[BIS_fnc_codePerformance]], [[Code_Optimisation|Code Optimisation]] |SEEALSO=
+|p2= arguments: [[Anything]] - (Optional, default [[nil]]) arguments to pass to the code in _this variable. Default: [[nil]]
-|  |MPBEHAVIOUR=
+|p3= cycles: [[Number]] - (Optional, default 100000) wanted number of cycles to run the given code. > 1000 is recommended
-____________________________________________________________________________________________
-}}
-<h3 style='display:none'>Notes</h3>
+|p4= ignoreTimeLimit: [[Boolean]] - (Optional, default false) - ignore the 1 second timelimit, and always run the provided number of cycles (except in multiplayer)
-<dl class='command_description'>
+|p4since= arma3 2.14
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
+|r1= [[Array]] format [duration, cycles], where:
-</dl>
+* duration: [[Number]] - average duration of 1 execution in milliseconds
+* cycles: [[Number]] - actual number of cycles executed
-<h3 style='display:none'>Bottom Section</h3>
+|x1= <sqf>private _result = diag_codePerformance [{ private _a = 123; }, 0, 10000];</sqf>
-[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
-<!-- CONTINUE Notes -->
+|seealso= [[diag_log]] [[BIS_fnc_codePerformance]] [[Code Optimisation]]
-<!-- DISCONTINUE Notes -->
+}}