Editing Module:Timing/doc (section)

=== Testing with a wrapper function ===
If a call need additional setup, or parameters, then those can be provided in a wrapper function. That can be achieved by wrapping up the function in an additional function like the following, and then timing the resulting function.

Do not add wrappers to very simple functions, the timing will be far off, as is clearly seen in these examples!

====Wrapper in the debugger ====
The wrapper function can de defined in the debugger, that is added in the text area for debugging. Add a separate function like the following

<syntaxhighlight lang="lua">
function wrap() return p.hello(mw.getCurrentFrame()) end
=require 'Module:Timing'(wrap)
</syntaxhighlight>

A call sequence like that produced the following output

<pre>
function wrap() return p.hello(mw.getCurrentFrame()) end
=require 'Module:Timing'(wrap)
Each call was running for about 1.9e-07 seconds.
	Mean runtime for each set was 1.9e-05 seconds,
	with standard deviation of 3.4e-07 seconds,
	minimum 6.7e-06, maximum 7.3e-06.
	Total time spent was about 3.7e-04 seconds.
Relative load is estimated to 3.7.
</pre>

Note that the duration of the call is much higher than the bare function itself! The inspected function must be a bit heavy, otherwise the wrapper will dominate the result.

An alternate form with an anonymous function is

<syntaxhighlight lang="lua">
=require 'Module:Timing'(function() return p.hello(mw.getCurrentFrame()) end)
</syntaxhighlight>

In general you should precompute as much as possible to avoid unnecessary computations inside the loop, like this
<syntaxhighlight lang="lua">
my_frame=mw.getCurrentFrame()
=require 'Module:Timing'(function() return p.hello(my_frame) end)
</syntaxhighlight>

====Wrapper in the module====
Sometimes it is better to put the wrapper in the module itself

<syntaxhighlight lang="lua">
my_object = {};

my_object.hello = function( frame )
    local str = "Hello World!"
    return str
end

my_object.wrap = function ()
	return my_object.hello(mw.getCurrentFrame())
end

return my_object 
</syntaxhighlight>

That produced the following output

<pre>
=require 'Module:Timing'(p.wrap)
Each call was running for about 1.9e-07 seconds.
	Mean runtime for each set was 1.9e-05 seconds,
	with standard deviation of 7.0e-06 seconds,
	minimum 6.3e-06, maximum 7.1e-06.
	Total time spent was about 3.7e-04 seconds.
Relative load is estimated to 4.0.
</pre>

Also this wrapper is quite heavy compared to the tested function itself.

In general you should precompute as much as possible to avoid unnecessary computations inside the loop, like this
<syntaxhighlight lang="lua">
my_object = {};

my_object.hello = function( frame )
    local str = "Hello World!"
    return str
end

my_object.frame = mw.getCurrentFrame()
my_object.wrap = function ()
	return my_object.hello(my_object.frame)
end

return my_object 
</syntaxhighlight>