coder.performance.TimingResult

Capture detailed information about execution time of generated code

Since R2024b

expand all in page

    Description

    Use a coder.performance.TimingResult object to get detailed information about the execution times of the generated code.

    To create a coder.performance.TimingResult object, use the coder.timeit function.

    Properties

    expand all

    Name of the generated function, specified as a character vector.

    List of all the individual execution times after the warmup phase, specified as double array.

    The warmup phase is a period to stabilize a system before measuring the execution time.

    First execution time obtained before warmup phase, specified as double.

    Minimum execution time from Runtimes obtained during timing, specified as double.

    Examples

    collapse all

    Open Live Script

    Find information about the execution time of generated code by creating a coder.performance.TimingResult object and displaying its properties.

    Define the MATLAB® function integralExpLn:

    function out = integralExpLn(xmin,xmax)
    f = @(x)x.^5.*exp(-x).*sin(x);
    out = integral(f,xmin,xmax,'RelTol',1e-10);
end

    Use the coder.timeit function to create a coder.performance.TimingResult object.

    [~,trObj] = coder.timeit("integralExpLn",1,{0,Inf});
    - Generating code and building MEX.
- Running MEX.
TimingResult with 8058 Runtime Sample(s)

Statistical Overview:
   mean = 6.21e-05 s    max = 2.84e-03 s     sd = 4.20e-05 s
 median = 5.95e-05 s    min = 5.85e-05 s   90th = 6.18e-05 s

    Use the properties of the coder.performance.TimingResult object to find information about the execution time of the generated code.

    trObj.Name
    ans = 
'integralExpLn_mex'

    trObj.Runtimes(1:5)
    ans = 1×5
10-3 ×

    0.1125    0.0681    0.0656    0.0638    0.0647


    tIQR = iqr(trObj.Runtimes)
    tIQR = 
1.0300e-06

    trObj.FirstRuntime
    ans = 
1.6495e-04

    trObj.MinRuntime
    ans = 
5.8451e-05

    Version History

    Introduced in R2024b

    See Also

    | |