Mercurial > hg > octave-nkf

annotate scripts/general/profshow.m @ 18908:be0978e94806

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add column with time percentage to profshow output. * profshow.m: Also output a column with percent of total time.
author Daniel Kraft <d@domob.eu>
date Fri, 07 Mar 2014 09:10:46 +0100
parents d63878346099
children 6d14aa793e0a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18908
be0978e94806 Add column with time percentage to profshow output.
Daniel Kraft <d@domob.eu>
parents: 17744
diff changeset
1 ## Copyright (C) 2012-2014 Daniel Kraft
12871
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
2 ##
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
3 ## This file is part of Octave.
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
4 ##
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
8 ## your option) any later version.
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
9 ##
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
13 ## General Public License for more details.
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
14 ##
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
18
23377c46516b Implement the profshow function to print profiler results.
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} {} profshow (@var{data})
12871
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
21 ## @deftypefnx {Function File} {} profshow (@var{data}, @var{n})
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
22 ## Show flat profiler results.
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
23 ##
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
24 ## This command prints out profiler data as a flat profile. @var{data} is the
14359
7277fe922e99 doc: Use Octave preference for double quote in docstrings in scripts/
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
25 ## structure returned by @code{profile ("info")}. If @var{n} is given, it
12871
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
26 ## specifies the number of functions to show in the profile; functions are
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
27 ## sorted in descending order by total time spent in them. If there are more
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
28 ## than @var{n} included in the profile, those will not be shown. @var{n}
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
29 ## defaults to 20.
12887
ca5c1115b679 Show recursive-flag of functions in profshow.
Daniel Kraft <d@domob.eu>
parents: 12872
diff changeset
30 ##
ca5c1115b679 Show recursive-flag of functions in profshow.
Daniel Kraft <d@domob.eu>
parents: 12872
diff changeset
31 ## The attribute column shows @samp{R} for recursive functions and nothing
ca5c1115b679 Show recursive-flag of functions in profshow.
Daniel Kraft <d@domob.eu>
parents: 12872
diff changeset
32 ## otherwise.
13191
c5ddb99ff5de Put @seealso in profiler functions' docstrings.
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 13141
diff changeset
33 ## @seealso{profexplore, profile}
12871
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
34 ## @end deftypefn
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
35
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
36 ## Built-in profiler.
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
37 ## Author: Daniel Kraft <d@domob.eu>
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
38
12872
031e1a2c26f3 Vectorize and use Octave coding conventions for profile script files
Rik <octave@nomad.inbox5.com>
parents: 12871
diff changeset
39 function profshow (data, n = 20)
12871
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
40
12872
031e1a2c26f3 Vectorize and use Octave coding conventions for profile script files
Rik <octave@nomad.inbox5.com>
parents: 12871
diff changeset
41 if (nargin < 1 || nargin > 2)
031e1a2c26f3 Vectorize and use Octave coding conventions for profile script files
Rik <octave@nomad.inbox5.com>
parents: 12871
diff changeset
42 print_usage ();
031e1a2c26f3 Vectorize and use Octave coding conventions for profile script files
Rik <octave@nomad.inbox5.com>
parents: 12871
diff changeset
43 endif
031e1a2c26f3 Vectorize and use Octave coding conventions for profile script files
Rik <octave@nomad.inbox5.com>
parents: 12871
diff changeset
44
031e1a2c26f3 Vectorize and use Octave coding conventions for profile script files
Rik <octave@nomad.inbox5.com>
parents: 12871
diff changeset
45 n = fix (n);
031e1a2c26f3 Vectorize and use Octave coding conventions for profile script files
Rik <octave@nomad.inbox5.com>
parents: 12871
diff changeset
46 if (! isscalar (n) || ! isreal (n) || ! (n > 0))
13141
e81ddf9cacd5 maint: untabify and remove trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 13056
diff changeset
47 error ("profile: N must be a positive integer");
12871
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
48 endif
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
49
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
50 m = length (data.FunctionTable);
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
51 n = min (n, m);
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
52
12872
031e1a2c26f3 Vectorize and use Octave coding conventions for profile script files
Rik <octave@nomad.inbox5.com>
parents: 12871
diff changeset
53 ## We want to sort by times in descending order. For this, extract the
031e1a2c26f3 Vectorize and use Octave coding conventions for profile script files
Rik <octave@nomad.inbox5.com>
parents: 12871
diff changeset
54 ## times to an array, then sort this, and use the resulting index permutation
031e1a2c26f3 Vectorize and use Octave coding conventions for profile script files
Rik <octave@nomad.inbox5.com>
parents: 12871
diff changeset
55 ## to print out our table.
031e1a2c26f3 Vectorize and use Octave coding conventions for profile script files
Rik <octave@nomad.inbox5.com>
parents: 12871
diff changeset
56 times = -[ data.FunctionTable.TotalTime ];
18908
be0978e94806 Add column with time percentage to profshow output.
Daniel Kraft <d@domob.eu>
parents: 17744
diff changeset
57 totalTime = -sum (times);
12872
031e1a2c26f3 Vectorize and use Octave coding conventions for profile script files
Rik <octave@nomad.inbox5.com>
parents: 12871
diff changeset
58
12871
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
59 [~, p] = sort (times);
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
60
12872
031e1a2c26f3 Vectorize and use Octave coding conventions for profile script files
Rik <octave@nomad.inbox5.com>
parents: 12871
diff changeset
61 ## For printing the table, find out the maximum length of a function name
031e1a2c26f3 Vectorize and use Octave coding conventions for profile script files
Rik <octave@nomad.inbox5.com>
parents: 12871
diff changeset
62 ## so that we can proportion the table accordingly. Based on this,
031e1a2c26f3 Vectorize and use Octave coding conventions for profile script files
Rik <octave@nomad.inbox5.com>
parents: 12871
diff changeset
63 ## we can build the format used for printing table rows.
12889
dae596be0571 profshow.m: Change Matlab-style single quotes to Octave-style double quotes
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents: 12887
diff changeset
64 nameLen = length ("Function");
12871
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
65 for i = 1 : n
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
66 nameLen = max (nameLen, length (data.FunctionTable(p(i)).FunctionName));
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
67 endfor
18908
be0978e94806 Add column with time percentage to profshow output.
Daniel Kraft <d@domob.eu>
parents: 17744
diff changeset
68 headerFormat = sprintf ("%%4s %%%ds %%4s %%12s %%10s %%12s\n", nameLen);
be0978e94806 Add column with time percentage to profshow output.
Daniel Kraft <d@domob.eu>
parents: 17744
diff changeset
69 rowFormat = sprintf ("%%4d %%%ds %%4s %%12.3f %%10.2f %%12d\n", nameLen);
12871
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
70
18908
be0978e94806 Add column with time percentage to profshow output.
Daniel Kraft <d@domob.eu>
parents: 17744
diff changeset
71 printf (headerFormat, ...
be0978e94806 Add column with time percentage to profshow output.
Daniel Kraft <d@domob.eu>
parents: 17744
diff changeset
72 "#", "Function", "Attr", "Time (s)", "Time (%)", "Calls");
be0978e94806 Add column with time percentage to profshow output.
Daniel Kraft <d@domob.eu>
parents: 17744
diff changeset
73 printf ("%s\n", repmat ("-", 1, nameLen + 2 * 5 + 11 + 2 * 13));
12871
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
74 for i = 1 : n
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
75 row = data.FunctionTable(p(i));
18908
be0978e94806 Add column with time percentage to profshow output.
Daniel Kraft <d@domob.eu>
parents: 17744
diff changeset
76 timePercent = 100 * row.TotalTime / totalTime;
12889
dae596be0571 profshow.m: Change Matlab-style single quotes to Octave-style double quotes
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents: 12887
diff changeset
77 attr = "";
12887
ca5c1115b679 Show recursive-flag of functions in profshow.
Daniel Kraft <d@domob.eu>
parents: 12872
diff changeset
78 if (row.IsRecursive)
12889
dae596be0571 profshow.m: Change Matlab-style single quotes to Octave-style double quotes
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents: 12887
diff changeset
79 attr = "R";
12887
ca5c1115b679 Show recursive-flag of functions in profshow.
Daniel Kraft <d@domob.eu>
parents: 12872
diff changeset
80 endif
12977
9db4e9b352d6 Add index into FunctionTable to profshow output table.
Daniel Kraft <d@domob.eu>
parents: 12889
diff changeset
81 printf (rowFormat, p(i), row.FunctionName, attr, ...
18908
be0978e94806 Add column with time percentage to profshow output.
Daniel Kraft <d@domob.eu>
parents: 17744
diff changeset
82 row.TotalTime, timePercent, row.NumCalls);
12871
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
83 endfor
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
84
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
85 endfunction
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
86
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
87
12871
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
88 %!demo
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
89 %! profile on;
12871
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
90 %! A = rand (100);
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
91 %! B = expm (A);
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
92 %! profile off;
12889
dae596be0571 profshow.m: Change Matlab-style single quotes to Octave-style double quotes
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents: 12887
diff changeset
93 %! T = profile ("info");
12871
23377c46516b Implement the profshow function to print profiler results.
Daniel Kraft <d@domob.eu>
parents:
diff changeset
94 %! profshow (T, 10);
12887
ca5c1115b679 Show recursive-flag of functions in profshow.
Daniel Kraft <d@domob.eu>
parents: 12872
diff changeset
95
ca5c1115b679 Show recursive-flag of functions in profshow.
Daniel Kraft <d@domob.eu>
parents: 12872
diff changeset
96 %!demo
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
97 %! profile on;
13837
2c80bbd87f5d don't define functions in test and demo blocks
John W. Eaton <jwe@octave.org>
parents: 13191
diff changeset
98 %! expm (rand (500) + eye (500));
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
99 %! profile off;
12889
dae596be0571 profshow.m: Change Matlab-style single quotes to Octave-style double quotes
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents: 12887
diff changeset
100 %! profshow (profile ("info"), 5);
13056
66662c033301 codesprint: tests or profshow
John W. Eaton <jwe@octave.org>
parents: 12977
diff changeset
101
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14359
diff changeset
102 %!error profshow ()
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14359
diff changeset
103 %!error profshow (1, 2, 3)
14405
7d5a653825b9 profshow.m: Add more input validation tests
Rik <octave@nomad.inbox5.com>
parents: 14363
diff changeset
104 %!error <N must be a positive integer> profshow (struct (), ones (2))
7d5a653825b9 profshow.m: Add more input validation tests
Rik <octave@nomad.inbox5.com>
parents: 14363
diff changeset
105 %!error <N must be a positive integer> profshow (struct (), 1+i)
7d5a653825b9 profshow.m: Add more input validation tests
Rik <octave@nomad.inbox5.com>
parents: 14363
diff changeset
106 %!error <N must be a positive integer> profshow (struct (), -1)
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
107