Mercurial > octave-nkf
view scripts/general/profshow.m @ 18792:6d14aa793e0a
profshow.m: Use current profiler data if there is no input data.
* profshow.m: Redo docstring. If no input data, call profile ('info') and use
the current profiler dataset. Use 'descend' option to sort to make code
clearer. Get rod of for loop for better performance.
author | Rik <rik@octave.org> |
---|---|
date | Thu, 15 May 2014 09:31:43 -0700 |
parents | be0978e94806 |
children |
line wrap: on
line source
## Copyright (C) 2012-2014 Daniel Kraft ## ## This file is part of Octave. ## ## Octave is free software; you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation; either version 3 of the License, or (at ## your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ## General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {} profshow (@var{data}) ## @deftypefnx {Function File} {} profshow (@var{data}, @var{n}) ## @deftypefnx {Function File} {} profshow () ## @deftypefnx {Function File} {} profshow (@var{n}) ## Display flat per-function profiler results. ## ## Print out profiler data (execution time, number of calls) for the most ## critical @var{n} functions. The results are sorted in descending order by ## the total time spent in each function. If @var{n} is unspecified it ## defaults to 20. ## ## The input @var{data} is the structure returned by @code{profile ("info")}. ## If unspecified, @code{profshow} will use the current profile dataset. ## ## The attribute column displays @samp{R} for recursive functions, and is blank ## for all other function types. ## @seealso{profexplore, profile} ## @end deftypefn ## Built-in profiler. ## Author: Daniel Kraft <d@domob.eu> function profshow (data, n = 20) if (nargin > 2) print_usage (); endif if (nargin == 0) data = profile ("info"); elseif (nargin == 1 && ! isstruct (data)) n = data; data = profile ("info"); endif n = fix (n); if (! isscalar (n) || ! isreal (n) || ! (n > 0)) error ("profile: N must be a positive integer"); endif m = length (data.FunctionTable); n = min (n, m); ## We want to sort by times in descending order. For this, extract the ## times to an array, then sort this, and use the resulting index permutation ## to print out our table. times = [ data.FunctionTable.TotalTime ]; totalTime = sum (times); [~, p] = sort (times, "descend"); ## For printing the table, find out the maximum length of a function name ## so that we can proportion the table accordingly. Based on this, ## we can build the format used for printing table rows. nameLen = max (length ("Function"), columns (char (data.FunctionTable(p(1:n)).FunctionName))); headerFormat = sprintf ("%%4s %%%ds %%4s %%12s %%10s %%12s\n", nameLen); rowFormat = sprintf ("%%4d %%%ds %%4s %%12.3f %%10.2f %%12d\n", nameLen); printf (headerFormat, ... "#", "Function", "Attr", "Time (s)", "Time (%)", "Calls"); printf ("%s\n", repmat ("-", 1, nameLen + 2 * 5 + 11 + 2 * 13)); for i = 1 : n row = data.FunctionTable(p(i)); timePercent = 100 * row.TotalTime / totalTime; attr = ""; if (row.IsRecursive) attr = "R"; endif printf (rowFormat, p(i), row.FunctionName, attr, row.TotalTime, timePercent, row.NumCalls); endfor endfunction %!demo %! profile on; %! A = rand (100); %! B = expm (A); %! profile off; %! T = profile ("info"); %! profshow (T, 10); %!demo %! profile on; %! expm (rand (500) + eye (500)); %! profile off; %! profshow (profile ("info"), 5); %!error profshow (1, 2, 3) %!error <N must be a positive integer> profshow (struct (), ones (2)) %!error <N must be a positive integer> profshow (struct (), 1+i) %!error <N must be a positive integer> profshow (struct (), -1)