Mercurial > octave-nkf

annotate scripts/general/profile.m @ 12961:8c64cc024e8c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Make hierarchical profile available via profile('info'). profile.m: Make profile('info') return also hierarchical call-tree.
author Daniel Kraft <d@domob.eu>
date Fri, 12 Aug 2011 12:27:56 +0200
parents 05941540287c
children a7e82bdf12b3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
12869
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
1 ## Copyright (C) 2011 Daniel Kraft
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
2 ##
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
3 ## This file is part of Octave.
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
4 ##
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
8 ## your option) any later version.
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
9 ##
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
13 ## General Public License for more details.
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
14 ##
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
18
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
19 ## -*- texinfo -*-
12872
031e1a2c26f3 Vectorize and use Octave coding conventions for profile script files
Rik <octave@nomad.inbox5.com>
parents: 12871
diff changeset
20 ## @deftypefn {Function File} {} profile on
12869
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
21 ## @deftypefnx {Function File} {} profile off
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
22 ## @deftypefnx {Function File} {} profile resume
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
23 ## @deftypefnx {Function File} {} profile clear
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
24 ## @deftypefnx {Function File} {@var{S} =} profile ('status')
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
25 ## @deftypefnx {Function File} {@var{T} =} profile ('info')
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
26 ## Control the built-in profiler.
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
27 ##
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
28 ## @table @code
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
29 ## @item profile on
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
30 ## Start the profiler, clearing all previously collected data if there
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
31 ## is any.
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
32 ##
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
33 ## @item profile off
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
34 ## Stop profiling. The collected data can later be retrieved and examined
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
35 ## with calls like @code{S = profile ('info')}.
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
36 ##
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
37 ## @item profile clear
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
38 ## Clear all collected profiler data.
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
39 ##
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
40 ## @item profile resume
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
41 ## Restart profiling without cleaning up the old data and instead
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
42 ## all newly collected statistics are added to the already existing ones.
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
43 ##
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
44 ## @item @var{S} = profile ('status')
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
45 ## Return a structure filled with certain information about the current status
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
46 ## of the profiler. At the moment, the only field is @code{ProfilerStatus}
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
47 ## which is either 'on' or 'off'.
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
48 ##
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
49 ## @item @var{T} = profile ('info')
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
50 ## Return the collected profiling statistics in the structure @var{T}.
12961
8c64cc024e8c Make hierarchical profile available via profile('info').
Daniel Kraft <d@domob.eu>
parents: 12955
diff changeset
51 ## The flat profile is returned in the field @code{FunctionTable} which is an
8c64cc024e8c Make hierarchical profile available via profile('info').
Daniel Kraft <d@domob.eu>
parents: 12955
diff changeset
52 ## array of structures, each entry corresponding to a function which was called
8c64cc024e8c Make hierarchical profile available via profile('info').
Daniel Kraft <d@domob.eu>
parents: 12955
diff changeset
53 ## and for which profiling statistics are present. Furthermore, the field
8c64cc024e8c Make hierarchical profile available via profile('info').
Daniel Kraft <d@domob.eu>
parents: 12955
diff changeset
54 ## @code{Hierarchical} contains the hierarchical call-tree. Each node
8c64cc024e8c Make hierarchical profile available via profile('info').
Daniel Kraft <d@domob.eu>
parents: 12955
diff changeset
55 ## has an index into the @code{FunctionTable} identifying the function it
8c64cc024e8c Make hierarchical profile available via profile('info').
Daniel Kraft <d@domob.eu>
parents: 12955
diff changeset
56 ## corresponds to as well as data fields for number of calls and time spent
8c64cc024e8c Make hierarchical profile available via profile('info').
Daniel Kraft <d@domob.eu>
parents: 12955
diff changeset
57 ## at this level in the call-tree.
12869
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
58 ## @end table
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
59 ## @end deftypefn
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
60
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
61 ## Built-in profiler.
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
62 ## Author: Daniel Kraft <d@domob.eu>
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
63
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
64 function retval = profile (option)
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
65
12872
031e1a2c26f3 Vectorize and use Octave coding conventions for profile script files
Rik <octave@nomad.inbox5.com>
parents: 12871
diff changeset
66 if (nargin != 1)
031e1a2c26f3 Vectorize and use Octave coding conventions for profile script files
Rik <octave@nomad.inbox5.com>
parents: 12871
diff changeset
67 print_usage ();
031e1a2c26f3 Vectorize and use Octave coding conventions for profile script files
Rik <octave@nomad.inbox5.com>
parents: 12871
diff changeset
68 endif
031e1a2c26f3 Vectorize and use Octave coding conventions for profile script files
Rik <octave@nomad.inbox5.com>
parents: 12871
diff changeset
69
12869
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
70 switch (option)
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
71 case 'on'
12955
05941540287c Style fixes on profiler internal functions
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents: 12872
diff changeset
72 __profiler_reset__ ();
05941540287c Style fixes on profiler internal functions
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents: 12872
diff changeset
73 __profiler_enable__ (true);
12869
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
74
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
75 case 'off'
12955
05941540287c Style fixes on profiler internal functions
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents: 12872
diff changeset
76 __profiler_enable__ (false);
12869
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
77
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
78 case 'clear'
12955
05941540287c Style fixes on profiler internal functions
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents: 12872
diff changeset
79 __profiler_reset__ ();
12869
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
80
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
81 case 'resume'
12955
05941540287c Style fixes on profiler internal functions
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents: 12872
diff changeset
82 __profiler_enable__ (true);
12869
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
83
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
84 case 'status'
12955
05941540287c Style fixes on profiler internal functions
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents: 12872
diff changeset
85 enabled = __profiler_enable__ ();
12869
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
86 if (enabled)
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
87 enabled = 'on';
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
88 else
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
89 enabled = 'off';
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
90 endif
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
91 retval = struct ('ProfilerStatus', enabled);
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
92
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
93 case 'info'
12961
8c64cc024e8c Make hierarchical profile available via profile('info').
Daniel Kraft <d@domob.eu>
parents: 12955
diff changeset
94 [flat, tree] = __profiler_data__ ();
8c64cc024e8c Make hierarchical profile available via profile('info').
Daniel Kraft <d@domob.eu>
parents: 12955
diff changeset
95 retval = struct ('FunctionTable', flat, 'Hierarchical', tree);
12869
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
96
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
97 otherwise
12872
031e1a2c26f3 Vectorize and use Octave coding conventions for profile script files
Rik <octave@nomad.inbox5.com>
parents: 12871
diff changeset
98 warning ("profile: Unrecognized option '%s'", option);
12869
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
99 print_usage ();
12872
031e1a2c26f3 Vectorize and use Octave coding conventions for profile script files
Rik <octave@nomad.inbox5.com>
parents: 12871
diff changeset
100
12869
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
101 endswitch
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
102
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
103 endfunction
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
104
12872
031e1a2c26f3 Vectorize and use Octave coding conventions for profile script files
Rik <octave@nomad.inbox5.com>
parents: 12871
diff changeset
105
12869
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
106 %!demo
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
107 %! profile ('on');
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
108 %! A = rand (100);
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
109 %! B = expm (A);
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
110 %! profile ('off');
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
111 %! profile ('resume');
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
112 %! C = sqrtm (A);
de9a9719e594 Extend data collection in profiler and add user-interface profile function.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
113 %! profile ('off');
12871
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents: 12869
diff changeset
114 %! T = profile ('info');
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents: 12869
diff changeset
115 %! profshow (T);