BIS_fnc_codePerformance

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.

Note

Use toString to stringify Code, as str adds curly braces - See #Example 2.

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

Returns: 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;

See also

diag_codePerformance