PRWAITBAR

Report PRTools progress by single waitbar

    H = PRWAITBAR(N,M,TEXT)
    H = PRWAITBAR(N,TEXT,FLAG)
    S = PRWAITBAR

Input
N	Integer, total number of steps in loop
M	Integer, progress in number of steps in loop
TEXT	Text to be displayed in waitbar
FLAG	Flag (0/1)

Output
H	Waitbar handle
S	Status PRWAITBAR ('on' or 'off')

Description

This routine may be used to report progress in PRTools experiments.  It detects and integrates levels of loops. The following calls are  supported

     PRWAITBAR(N,TEXT)        initialize loop
     PRWAITBAR(N,TEXT,FLAG)   initialize loop if FLAG == 1
     PRWAITBAR(N,M)           update progress
     PRWAITBAR(N,M,TEXT)      update info
     PRWAITBAR(0)             closes loop level
     PRWAITBAR OFF            removes waitbar
     PRWAITBAR ON             switches waitbar on again
     PRWAITBAR REPORT         no waitbar, report progress in command window
     PRWAITBAR                reset prwaitbar

A typical sequence of calls is
.....  prwaitbar(nfolds,'cross validation')  for j = 1:nfolds  prwaitbar(nfolds,j,['cross validation, fold ' int2str(j)])  ....  end  prwaitbar(0) .....  Calls to PRTWAITBAR may be nested and all progress is merged into a single  waitbar. In this PRWAITBAR differs from Matlab's WAITBAR.  A typical example can be visualised by

      prcrossval({gendatb,gendath},{svc,loglc,fisherc},5,2)

PRWAITBAR may increase the computation time with 25%. For long running  processes PRWAITBAR REPORT (e.g. in a screen window) is recommended.

Some other, more high-level routines calling PRWAITBAR are  PRWAITBARINIT, PRWAITBARNEXT, PRWAITBARONCE, PREIG, PRINV, PRPINV, PRRANK,  PRSVD, PRCOV

See also

prwaitbarinit, prwaitbarnext, prwaitbaronce,