File: debug.texi

package info (click to toggle)
octave 3.8.2-4
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 84,396 kB
  • ctags: 45,547
  • sloc: cpp: 293,356; ansic: 42,041; fortran: 23,669; sh: 13,629; objc: 7,890; yacc: 7,093; lex: 3,442; java: 2,125; makefile: 1,589; perl: 1,009; awk: 974; xml: 34
file content (807 lines) | stat: -rw-r--r-- 28,464 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
@c DO NOT EDIT!  Generated automatically by munge-texi.pl.

@c Copyright (C) 1996-2013 John W. Eaton
@c
@c This file is part of Octave.
@c
@c Octave is free software; you can redistribute it and/or modify it
@c under the terms of the GNU General Public License as published by the
@c Free Software Foundation; either version 3 of the License, or (at
@c your option) any later version.
@c 
@c Octave is distributed in the hope that it will be useful, but WITHOUT
@c ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
@c FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
@c for more details.
@c 
@c You should have received a copy of the GNU General Public License
@c along with Octave; see the file COPYING.  If not, see
@c <http://www.gnu.org/licenses/>.

@node Debugging
@chapter Debugging

Octave includes a built-in debugger to aid in the development of
scripts.  This can be used to interrupt the execution of an Octave script
at a certain point, or when certain conditions are met.  Once execution
has stopped, and debug mode is entered, the symbol table at the point
where execution has stopped can be examined and modified to check for
errors.

The normal command-line editing and history functions are available in
debug mode.

@menu
* Entering Debug Mode::
* Leaving Debug Mode::
* Breakpoints::
* Debug Mode::
* Call Stack::
* Profiling::
* Profiler Example::
@end menu

@node Entering Debug Mode
@section Entering Debug Mode

There are two basic means of interrupting the execution of an Octave
script.  These are breakpoints (@pxref{Breakpoints}), discussed in the next
section, and interruption based on some condition.

Octave supports three means to stop execution based on the values set in
the functions @code{debug_on_interrupt}, @code{debug_on_warning}, and
@code{debug_on_error}.

@c debug_on_interrupt libinterp/corefcn/sighandlers.cc
@anchor{XREFdebug_on_interrupt}
@deftypefn  {Built-in Function} {@var{val} =} debug_on_interrupt ()
@deftypefnx {Built-in Function} {@var{old_val} =} debug_on_interrupt (@var{new_val})
@deftypefnx {Built-in Function} {} debug_on_interrupt (@var{new_val}, "local")
Query or set the internal variable that controls whether Octave will try
to enter debugging mode when it receives an interrupt signal (typically
generated with @kbd{C-c}).  If a second interrupt signal is received
before reaching the debugging mode, a normal interrupt will occur.

When called from inside a function with the @qcode{"local"} option, the
variable is changed locally for the function and any subroutines it calls.  
The original variable value is restored when exiting the function.
@seealso{@ref{XREFdebug_on_error,,debug_on_error}, @ref{XREFdebug_on_warning,,debug_on_warning}}
@end deftypefn


@c debug_on_warning libinterp/corefcn/error.cc
@anchor{XREFdebug_on_warning}
@deftypefn  {Built-in Function} {@var{val} =} debug_on_warning ()
@deftypefnx {Built-in Function} {@var{old_val} =} debug_on_warning (@var{new_val})
@deftypefnx {Built-in Function} {} debug_on_warning (@var{new_val}, "local")
Query or set the internal variable that controls whether Octave will try
to enter the debugger when a warning is encountered.

When called from inside a function with the @qcode{"local"} option, the
variable is changed locally for the function and any subroutines it calls.  
The original variable value is restored when exiting the function.
@seealso{@ref{XREFdebug_on_error,,debug_on_error}, @ref{XREFdebug_on_interrupt,,debug_on_interrupt}}
@end deftypefn


@c debug_on_error libinterp/corefcn/error.cc
@anchor{XREFdebug_on_error}
@deftypefn  {Built-in Function} {@var{val} =} debug_on_error ()
@deftypefnx {Built-in Function} {@var{old_val} =} debug_on_error (@var{new_val})
@deftypefnx {Built-in Function} {} debug_on_error (@var{new_val}, "local")
Query or set the internal variable that controls whether Octave will try
to enter the debugger when an error is encountered.  This will also
inhibit printing of the normal traceback message (you will only see
the top-level error message).

When called from inside a function with the @qcode{"local"} option, the
variable is changed locally for the function and any subroutines it calls.  
The original variable value is restored when exiting the function.
@seealso{@ref{XREFdebug_on_warning,,debug_on_warning}, @ref{XREFdebug_on_interrupt,,debug_on_interrupt}}
@end deftypefn


@node Leaving Debug Mode
@section Leaving Debug Mode

Use either @code{dbcont} or @code{return} to leave the debug mode and
continue the normal execution of the script.

@c dbcont libinterp/corefcn/debug.cc
@anchor{XREFdbcont}
@deftypefn {Command} {} dbcont
Leave command-line debugging mode and continue code execution normally.
@seealso{@ref{XREFdbstep,,dbstep}, @ref{XREFdbquit,,dbquit}}
@end deftypefn


To quit debug mode and return directly to the prompt without executing
any additional code use @code{dbquit}.

@c dbquit libinterp/corefcn/debug.cc
@anchor{XREFdbquit}
@deftypefn {Command} {} dbquit
Quit debugging mode immediately without further code execution and
return to the Octave prompt.
@seealso{@ref{XREFdbcont,,dbcont}, @ref{XREFdbstep,,dbstep}}
@end deftypefn


Finally, typing @code{exit} or @code{quit} at the debug prompt will
result in Octave terminating normally.

@node Breakpoints
@section Breakpoints

Breakpoints can be set in any m-file function by using the @code{dbstop}
function.

@c dbstop libinterp/corefcn/debug.cc
@anchor{XREFdbstop}
@deftypefn  {Built-in Function} {@var{rline} =} dbstop ("@var{func}")
@deftypefnx {Built-in Function} {@var{rline} =} dbstop ("@var{func}", @var{line})
@deftypefnx {Built-in Function} {@var{rline} =} dbstop ("@var{func}", @var{line1}, @var{line2}, @dots{})
Set a breakpoint in function @var{func}.

Arguments are

@table @var
@item func
Function name as a string variable.  When already in debug
mode this should be left out and only the line should be given.

@item line
Line number where the breakpoint should be set.  Multiple
lines may be given as separate arguments or as a vector.
@end table

When called with a single argument @var{func}, the breakpoint
is set at the first executable line in the named function.

The optional output @var{rline} is the real line number where the
breakpoint was set.  This can differ from specified line if
the line is not executable.  For example, if a breakpoint attempted on a
blank line then Octave will set the real breakpoint at the
next executable line.
@seealso{@ref{XREFdbclear,,dbclear}, @ref{XREFdbstatus,,dbstatus}, @ref{XREFdbstep,,dbstep}, @ref{XREFdebug_on_error,,debug_on_error}, @ref{XREFdebug_on_warning,,debug_on_warning}, @ref{XREFdebug_on_interrupt,,debug_on_interrupt}}
@end deftypefn


@noindent
Breakpoints in class methods are also supported (e.g.,
@code{dbstop ("@@class/method")}).  However, breakpoints cannot be set in
built-in functions (e.g., @code{sin}, etc.) or dynamically loaded functions
(i.e., oct-files).

To set a breakpoint immediately upon entering a function use line number 1, or
omit the line number entirely and just give the function name.  When setting
the breakpoint Octave will ignore the leading comment block, and the breakpoint
will be set on the first executable statement in the function.  For example:

@example
@group
dbstop ("asind", 1)
@result{} 29
@end group
@end example

@noindent
Note that the return value of @code{29} means that the breakpoint was
effectively set to line 29.  The status of breakpoints in a function can
be queried with @code{dbstatus}.

@c dbstatus libinterp/corefcn/debug.cc
@anchor{XREFdbstatus}
@deftypefn  {Built-in Function} {} dbstatus ()
@deftypefnx {Built-in Function} {@var{brk_list} =} dbstatus ()
@deftypefnx {Built-in Function} {@var{brk_list} =} dbstatus ("@var{func}")
Report the location of active breakpoints.

When called with no input or output arguments, print the list of
all functions with breakpoints and the line numbers where those
breakpoints are set.
If a function name @var{func} is specified then only report breakpoints
for the named function.

The optional return argument @var{brk_list} is a struct array with the
following fields.

@table @asis
@item name
The name of the function with a breakpoint.

@item file
The name of the m-file where the function code is located.

@item line
A line number, or vector of line numbers, with a breakpoint.
@end table

@seealso{@ref{XREFdbclear,,dbclear}, @ref{XREFdbwhere,,dbwhere}}
@end deftypefn


@noindent
Reusing the previous example, @code{dbstatus ("asind")} will return
29.  The breakpoints listed can then be cleared with the @code{dbclear}
function.

@c dbclear libinterp/corefcn/debug.cc
@anchor{XREFdbclear}
@deftypefn  {Built-in Function} {} dbclear ("@var{func}")
@deftypefnx {Built-in Function} {} dbclear ("@var{func}", @var{line}, @dots{})
@deftypefnx {Built-in Function} {} dbclear (@var{line}, @dots{})
Delete a breakpoint in the function @var{func}.

Arguments are

@table @var
@item func
Function name as a string variable.  When already in debug
mode this argument should be omitted and only the line number should be
given.

@item line
Line number from which to remove a breakpoint.  Multiple
lines may be given as separate arguments or as a vector.
@end table

When called without a line number specification all breakpoints
in the named function are cleared.

If the requested line is not a breakpoint no action is performed.
@seealso{@ref{XREFdbstop,,dbstop}, @ref{XREFdbstatus,,dbstatus}, @ref{XREFdbwhere,,dbwhere}}
@end deftypefn


@noindent

A breakpoint may also be set in a subfunction.  For example, if a file contains
the functions

@example
@group
function y = func1 (x)
  y = func2 (x);
endfunction
function y = func2 (x)
  y = x + 1;
endfunction
@end group
@end example

@noindent
then a breakpoint can be set at the start of the subfunction directly with

@example
@group
dbstop (["func1", filemarker(), "func2"])
@result{} 5
@end group
@end example

Note that @code{filemarker} returns the character that marks subfunctions from
the file containing them.  Unless the default has been changed this character
is @samp{>}.  Thus, a quicker and more normal way to set the breakpoint would
be

@example
dbstop func1>func2
@end example

Another simple way of setting a breakpoint in an Octave script is the
use of the @code{keyboard} function.

@c keyboard libinterp/corefcn/input.cc
@anchor{XREFkeyboard}
@deftypefn  {Built-in Function} {} keyboard ()
@deftypefnx {Built-in Function} {} keyboard ("@var{prompt}")
This function is normally used for simple debugging.  When the
@code{keyboard} function is executed, Octave prints a prompt and waits
for user input.  The input strings are then evaluated and the results
are printed.  This makes it possible to examine the values of variables
within a function, and to assign new values if necessary.  To leave the
prompt and return to normal execution type @samp{return} or @samp{dbcont}.
The @code{keyboard} function does not return an exit status.

If @code{keyboard} is invoked without arguments, a default prompt of
@samp{debug> } is used.
@seealso{@ref{XREFdbstop,,dbstop}, @ref{XREFdbcont,,dbcont}, @ref{XREFdbquit,,dbquit}}
@end deftypefn


@noindent
The @code{keyboard} function is placed in a script at the point where the user
desires that the execution be stopped.  It automatically sets the running
script into the debug mode.

@node Debug Mode
@section Debug Mode

There are three additional support functions that allow the user to
find out where in the execution of a script Octave entered the debug
mode, and to print the code in the script surrounding the point where
Octave entered debug mode.

@c dbwhere libinterp/corefcn/debug.cc
@anchor{XREFdbwhere}
@deftypefn {Command} {} dbwhere
In debugging mode, report the current file and line number where
execution is stopped.
@seealso{@ref{XREFdbstatus,,dbstatus}, @ref{XREFdbcont,,dbcont}, @ref{XREFdbstep,,dbstep}, @ref{XREFdbup,,dbup}}
@end deftypefn


@c dbtype libinterp/corefcn/debug.cc
@anchor{XREFdbtype}
@deftypefn  {Command} {} dbtype
@deftypefnx {Command} {} dbtype @var{lineno}
@deftypefnx {Command} {} dbtype @var{startl:endl}
@deftypefnx {Command} {} dbtype @var{startl:end}
@deftypefnx {Command} {} dbtype @var{func}
@deftypefnx {Command} {} dbtype @var{func} @var{lineno}
@deftypefnx {Command} {} dbtype @var{func} @var{startl:endl}
@deftypefnx {Command} {} dbtype @var{func} @var{startl:end}
Display a script file with line numbers.

When called with no arguments in debugging mode, display the script file
currently being debugged.  An optional range specification can be used to
list only a portion of the file.  The special keyword @qcode{"end"} is a
valid line number specification for the last line of the file.

When called with the name of a function, list that script file with line
numbers.
@seealso{@ref{XREFdbwhere,,dbwhere}, @ref{XREFdbstatus,,dbstatus}, @ref{XREFdbstop,,dbstop}}
@end deftypefn


@c dblist libinterp/corefcn/debug.cc
@anchor{XREFdblist}
@deftypefn  {Command} {} dblist
@deftypefnx {Command} {} dblist @var{n}
In debugging mode, list @var{n} lines of the function being debugged
centered around the current line to be executed.  If unspecified @var{n}
defaults to 10 (+/- 5 lines)
@seealso{@ref{XREFdbwhere,,dbwhere}, @ref{XREFdbtype,,dbtype}}
@end deftypefn


You may also use @code{isdebugmode} to determine whether the debugger is
currently active.

@c isdebugmode libinterp/corefcn/debug.cc
@anchor{XREFisdebugmode}
@deftypefn {Built-in Function} {} isdebugmode ()
Return true if in debugging mode, otherwise false.
@seealso{@ref{XREFdbwhere,,dbwhere}, @ref{XREFdbstack,,dbstack}, @ref{XREFdbstatus,,dbstatus}}
@end deftypefn


Debug mode also allows single line stepping through a function using
the command @code{dbstep}.

@c dbstep libinterp/corefcn/debug.cc
@anchor{XREFdbstep}
@deftypefn  {Command} {} dbstep
@deftypefnx {Command} {} dbstep @var{n}
@deftypefnx {Command} {} dbstep in
@deftypefnx {Command} {} dbstep out
@deftypefnx {Command} {} dbnext @dots{}
In debugging mode, execute the next @var{n} lines of code.
If @var{n} is omitted, execute the next single line of code.
If the next line of code is itself defined in terms of an m-file remain in
the existing function.

Using @code{dbstep in} will cause execution of the next line to step into
any m-files defined on the next line.  Using @code{dbstep out} will cause
execution to continue until the current function returns.

@code{dbnext} is an alias for @code{dbstep}.
@seealso{@ref{XREFdbcont,,dbcont}, @ref{XREFdbquit,,dbquit}}
@end deftypefn


When in debug mode the @key{RETURN} key will execute the last entered command.
This is useful, for example, after hitting a breakpoint and entering
@code{dbstep} once.  After that, one can advance line by line through the code
with only a single key stroke.

@node Call Stack
@section Call Stack

The function being debugged may be the leaf node of a series of function calls.
After examining values in the current subroutine it may turn out that the
problem occurred in earlier pieces of code.  Use @code{dbup} and @code{dbdown}
to move up and down through the series of function calls to locate where
variables first took on the wrong values.  @code{dbstack} shows the entire
series of function calls and at what level debugging is currently taking place.

@c dbstack libinterp/corefcn/debug.cc
@anchor{XREFdbstack}
@deftypefn  {Command} {} dbstack
@deftypefnx {Command} {} dbstack @var{n}
@deftypefnx {Command} {} dbstack @var{-completenames}
@deftypefnx {Built-in Function} {[@var{stack}, @var{idx}] =} dbstack (@dots{})
Display or return current debugging function stack information.
With optional argument @var{n}, omit the @var{n} innermost stack frames.

Although accepted, the argument @var{-completenames} is silently ignored.
Octave always returns absolute file names.  The arguments @var{n} and
@var{-completenames} can be both specified in any order.

The optional return argument @var{stack} is a struct array with the
following fields:

@table @asis
@item file
The name of the m-file where the function code is located.

@item name
The name of the function with a breakpoint.

@item line
The line number of an active breakpoint.

@item column
The column number of the line where the breakpoint begins.

@item scope
Undocumented.

@item context
Undocumented.
@end table

The return argument @var{idx} specifies which element of the @var{stack}
struct array is currently active.
@seealso{@ref{XREFdbup,,dbup}, @ref{XREFdbdown,,dbdown}, @ref{XREFdbwhere,,dbwhere}, @ref{XREFdbstatus,,dbstatus}}
@end deftypefn


@c dbup libinterp/corefcn/debug.cc
@anchor{XREFdbup}
@deftypefn  {Built-in Function} {} dbup
@deftypefnx {Built-in Function} {} dbup (@var{n})
In debugging mode, move up the execution stack @var{n} frames.
If @var{n} is omitted, move up one frame.
@seealso{@ref{XREFdbstack,,dbstack}, @ref{XREFdbdown,,dbdown}}
@end deftypefn


@c dbdown libinterp/corefcn/debug.cc
@anchor{XREFdbdown}
@deftypefn  {Built-in Function} {} dbdown
@deftypefnx {Built-in Function} {} dbdown (@var{n})
In debugging mode, move down the execution stack @var{n} frames.
If @var{n} is omitted, move down one frame.
@seealso{@ref{XREFdbstack,,dbstack}, @ref{XREFdbup,,dbup}}
@end deftypefn


@node Profiling
@section Profiling
@cindex profiler
@cindex code profiling

Octave supports profiling of code execution on a per-function level.  If
profiling is enabled, each call to a function (supporting built-ins,
operators, functions in oct- and mex-files, user-defined functions in
Octave code and anonymous functions) is recorded while running Octave
code.  After that, this data can aid in analyzing the code behavior, and
is in particular helpful for finding ``hot spots'' in the code which use
up a lot of computation time and are the best targets to spend
optimization efforts on.

The main command for profiling is @code{profile}, which can be used to
start or stop the profiler and also to query collected data afterwards.
The data is returned in an Octave data structure which can then be
examined or further processed by other routines or tools.

@c profile scripts/general/profile.m
@anchor{XREFprofile}
@deftypefn  {Command} {} profile on
@deftypefnx {Command} {} profile off
@deftypefnx {Command} {} profile resume
@deftypefnx {Command} {} profile clear
@deftypefnx {Function File} {@var{S} =} profile ("status")
@deftypefnx {Function File} {@var{T} =} profile ("info")
Control the built-in profiler.

@table @code
@item profile on
Start the profiler, clearing all previously collected data if there
is any.

@item profile off
Stop profiling.  The collected data can later be retrieved and examined
with calls like @code{S = profile ("info")}.

@item profile clear
Clear all collected profiler data.

@item profile resume
Restart profiling without cleaning up the old data and instead
all newly collected statistics are added to the already existing ones.

@item @var{S} = profile ("status")
Return a structure filled with certain information about the current status
of the profiler.  At the moment, the only field is @code{ProfilerStatus}
which is either @qcode{"on"} or @qcode{"off"}.

@item @var{T} = profile ("info")
Return the collected profiling statistics in the structure @var{T}.
The flat profile is returned in the field @code{FunctionTable} which is an
array of structures, each entry corresponding to a function which was called
and for which profiling statistics are present.  Furthermore, the field
@code{Hierarchical} contains the hierarchical call-tree.  Each node
has an index into the @code{FunctionTable} identifying the function it
corresponds to as well as data fields for number of calls and time spent
at this level in the call-tree.
@seealso{@ref{XREFprofshow,,profshow}, @ref{XREFprofexplore,,profexplore}}
@end table
@end deftypefn


An easy way to get an overview over the collected data is
@code{profshow}.  This function takes the profiler data returned by
@code{profile} as input and prints a flat profile, for instance:

@example
@group
 Function Attr     Time (s)        Calls
----------------------------------------
   >myfib    R        2.195        13529
binary <=             0.061        13529
 binary -             0.050        13528
 binary +             0.026         6764
@end group
@end example

This shows that most of the run time was spent executing the function
@samp{myfib}, and some minor proportion evaluating the listed binary
operators.  Furthermore, it is shown how often the function was called
and the profiler also records that it is recursive.

@c profshow scripts/general/profshow.m
@anchor{XREFprofshow}
@deftypefn  {Function File} {} profshow (@var{data})
@deftypefnx {Function File} {} profshow (@var{data}, @var{n})
Show flat profiler results.

This command prints out profiler data as a flat profile.  @var{data} is the
structure returned by @code{profile ("info")}.  If @var{n} is given, it
specifies the number of functions to show in the profile; functions are
sorted in descending order by total time spent in them.  If there are more
than @var{n} included in the profile, those will not be shown.  @var{n}
defaults to 20.

The attribute column shows @samp{R} for recursive functions and nothing
otherwise.
@seealso{@ref{XREFprofexplore,,profexplore}, @ref{XREFprofile,,profile}}
@end deftypefn


@c profexplore scripts/general/profexplore.m
@anchor{XREFprofexplore}
@deftypefn  {Function File} {} profexplore ()
@deftypefnx {Function File} {} profexplore (@var{data})
Interactively explore hierarchical profiler output.

Assuming @var{data} is the structure with profile data returned by
@code{profile (@qcode{"info"})}, this command opens an interactive prompt
that can be used to explore the call-tree.  Type @kbd{help} to get a list
of possible commands.  If @var{data} is omitted, @code{profile ("info")}
is called and used in its place.
@seealso{@ref{XREFprofile,,profile}, @ref{XREFprofshow,,profshow}}
@end deftypefn


@node Profiler Example
@section Profiler Example

Below, we will give a short example of a profiler session.
@xref{Profiling}, for the documentation of the profiler functions in
detail.  Consider the code:

@example
global N A;

N = 300;
A = rand (N, N);

function xt = timesteps (steps, x0, expM)
  global N;

  if (steps == 0)
    xt = NA (N, 0);
  else
    xt = NA (N, steps);
    x1 = expM * x0;
    xt(:, 1) = x1;
    xt(:, 2 : end) = timesteps (steps - 1, x1, expM);
  endif
endfunction

function foo ()
  global N A;

  initial = @@(x) sin (x);
  x0 = (initial (linspace (0, 2 * pi, N)))';

  expA = expm (A);
  xt = timesteps (100, x0, expA);
endfunction

function fib = bar (N)
  if (N <= 2)
    fib = 1;
  else
    fib = bar (N - 1) + bar (N - 2);
  endif
endfunction
@end example

If we execute the two main functions, we get:

@example
@group
tic; foo; toc;
@result{} Elapsed time is 2.37338 seconds.

tic; bar (20); toc;
@result{} Elapsed time is 2.04952 seconds.
@end group
@end example

But this does not give much information about where this time is spent;
for instance, whether the single call to @code{expm} is more expensive
or the recursive time-stepping itself.  To get a more detailed picture,
we can use the profiler.

@example
@group
profile on;
foo;
profile off;

data = profile ("info");
profshow (data, 10);
@end group
@end example

This prints a table like:

@example
@group
   #  Function Attr     Time (s)        Calls
---------------------------------------------
   7      expm             1.034            1
   3  binary *             0.823          117
  41  binary \             0.188            1
  38  binary ^             0.126            2
  43 timesteps    R        0.111          101
  44        NA             0.029          101
  39  binary +             0.024            8
  34      norm             0.011            1
  40  binary -             0.004          101
  33   balance             0.003            1
@end group
@end example

The entries are the individual functions which have been executed (only
the 10 most important ones), together with some information for each of
them.  The entries like @samp{binary *} denote operators, while other
entries are ordinary functions.  They include both built-ins like
@code{expm} and our own routines (for instance @code{timesteps}).  From
this profile, we can immediately deduce that @code{expm} uses up the
largest proportion of the processing time, even though it is only called
once.  The second expensive operation is the matrix-vector product in the
routine @code{timesteps}.  @footnote{We only know it is the binary
multiplication operator, but fortunately this operator appears only at
one place in the code and thus we know which occurrence takes so much
time.  If there were multiple places, we would have to use the
hierarchical profile to find out the exact place which uses up the time
which is not covered in this example.}

Timing, however, is not the only information available from the profile.
The attribute column shows us that @code{timesteps} calls itself
recursively.  This may not be that remarkable in this example (since it's
clear anyway), but could be helpful in a more complex setting.  As to the
question of why is there a @samp{binary \} in the output, we can easily
shed some light on that too.  Note that @code{data} is a structure array
(@ref{Structure Arrays}) which contains the field @code{FunctionTable}.
This stores the raw data for the profile shown.  The number in the first
column of the table gives the index under which the shown function can
be found there.  Looking up @code{data.FunctionTable(41)} gives:

@example
@group
  scalar structure containing the fields:

    FunctionName = binary \
    TotalTime =  0.18765
    NumCalls =  1
    IsRecursive = 0
    Parents =  7
    Children = [](1x0)
@end group
@end example

Here we see the information from the table again, but have additional
fields @code{Parents} and @code{Children}.  Those are both arrays, which
contain the indices of functions which have directly called the function
in question (which is entry 7, @code{expm}, in this case) or been called
by it (no functions).  Hence, the backslash operator has been used
internally by @code{expm}.

Now let's take a look at @code{bar}.  For this, we start a fresh
profiling session (@code{profile on} does this; the old data is removed
before the profiler is restarted):

@example
@group
profile on;
bar (20);
profile off;

profshow (profile ("info"));
@end group
@end example

This gives:

@example
@group
   #            Function Attr     Time (s)        Calls
-------------------------------------------------------
   1                 bar    R        2.091        13529
   2           binary <=             0.062        13529
   3            binary -             0.042        13528
   4            binary +             0.023         6764
   5             profile             0.000            1
   8               false             0.000            1
   6              nargin             0.000            1
   7           binary !=             0.000            1
   9 __profiler_enable__             0.000            1
@end group
@end example

Unsurprisingly, @code{bar} is also recursive.  It has been called 13,529
times in the course of recursively calculating the Fibonacci number in a
suboptimal way, and most of the time was spent in @code{bar} itself.

Finally, let's say we want to profile the execution of both @code{foo}
and @code{bar} together.  Since we already have the run-time data
collected for @code{bar}, we can restart the profiler without clearing
the existing data and collect the missing statistics about @code{foo}.
This is done by:

@example
@group
profile resume;
foo;
profile off;

profshow (profile ("info"), 10);
@end group
@end example

As you can see in the table below, now we have both profiles mixed
together.

@example
@group
   #  Function Attr     Time (s)        Calls
---------------------------------------------
   1       bar    R        2.091        13529
  16      expm             1.122            1
  12  binary *             0.798          117
  46  binary \             0.185            1
  45  binary ^             0.124            2
  48 timesteps    R        0.115          101
   2 binary <=             0.062        13529
   3  binary -             0.045        13629
   4  binary +             0.041         6772
  49        NA             0.036          101
@end group
@end example