ETA_disp documentation

Table of contents

• Description section:
• • Description
• Matlab/Octave section:
• • Syntax
• • Output arguments
• • Input arguments
• • Examples
• • Compatibility, version info, and licence

Description

This function will print a short message to the command window, giving you an idea when a process might finish. It displays the current percentage done, the runtime until now, the estimated time of completion, the time per iteration (or iterations per second), and the number of iterations left.

Alternatively you can capture the text before it is printed and use the text in your own application, e.g. in a GUI.

Matlab/Octave

Syntax

ETA_disp(N_total,n,then)
ETA_disp(N_total,n,then,per_it_display)
ETA_disp(N_total,n,then,per_it_display,scale_estimate)
msg = ETA_disp(___)
[msg,strct] = ETA_disp(___)

Output arguments

Input arguments

Examples

N = 10;then = now; %#ok<TNOW1>
for n=1:N
    pause((1+rand)*2/N)
    ETA_disp(N,n,then)
end

N = 10^6;then = now; %#ok<TNOW1>
for n=1:N
    pause((1+rand)*2/N)
    if mod(n,10^4)==0 % Avoid spending too much time printing the ETA.
        ETA_disp(N,n,then,1) % Print iterations/sec instead of sec/iteration.
    end
end

Compatibility, version info, and licence

Compatibility considerations:

• This is expected to work on all releases.

Version: 2.0.0
Date:    2023-11-03
Author:  H.J. Wisselink
Licence: CC by-nc-sa 4.0 ( https://creativecommons.org/licenses/by-nc-sa/4.0 )
Email = 'h_j_wisselink*alumnus_utwente_nl';
Real_email = regexprep(Email,{'*','_'},{'@','.'})

Test suite

The tester is included so you can test if your own modifications would introduce any bugs. These tests form the basis for the compatibility table above. Note that functions may be different between the tester version and the normal function. Make sure to apply any modifications to both.