Mercurial > octave-antonio
view scripts/general/profile.m @ 20158:7503499a252b stable
doc: Update docstrings to have one sentence summary as first line.
Update scripts in audio, elfun, general, geometry, and image directories.
* scripts/audio/@audioplayer/__get_properties__.m,
scripts/audio/@audioplayer/audioplayer.m, scripts/audio/@audioplayer/get.m,
scripts/audio/@audioplayer/isplaying.m, scripts/audio/@audioplayer/play.m,
scripts/audio/@audioplayer/playblocking.m, scripts/audio/@audioplayer/set.m,
scripts/audio/@audioplayer/subsasgn.m, scripts/audio/@audioplayer/subsref.m,
scripts/audio/@audiorecorder/audiorecorder.m,
scripts/audio/@audiorecorder/get.m,
scripts/audio/@audiorecorder/getaudiodata.m,
scripts/audio/@audiorecorder/getplayer.m,
scripts/audio/@audiorecorder/isrecording.m,
scripts/audio/@audiorecorder/play.m, scripts/audio/@audiorecorder/record.m,
scripts/audio/@audiorecorder/recordblocking.m,
scripts/audio/@audiorecorder/set.m, scripts/audio/@audiorecorder/stop.m,
scripts/audio/@audiorecorder/subsasgn.m,
scripts/audio/@audiorecorder/subsref.m, scripts/audio/lin2mu.m,
scripts/audio/mu2lin.m, scripts/audio/record.m, scripts/audio/sound.m,
scripts/audio/soundsc.m, scripts/audio/wavread.m, scripts/audio/wavwrite.m,
scripts/elfun/cosd.m, scripts/elfun/sind.m, scripts/elfun/tand.m,
scripts/general/accumarray.m, scripts/general/accumdim.m,
scripts/general/bitcmp.m, scripts/general/bitget.m, scripts/general/bitset.m,
scripts/general/blkdiag.m, scripts/general/cart2pol.m,
scripts/general/cart2sph.m, scripts/general/cell2mat.m,
scripts/general/celldisp.m, scripts/general/chop.m,
scripts/general/circshift.m, scripts/general/common_size.m,
scripts/general/cplxpair.m, scripts/general/cumtrapz.m,
scripts/general/dblquad.m, scripts/general/deal.m, scripts/general/del2.m,
scripts/general/display.m, scripts/general/divergence.m,
scripts/general/fieldnames.m, scripts/general/flip.m,
scripts/general/flipdim.m, scripts/general/fliplr.m, scripts/general/flipud.m,
scripts/general/gradient.m, scripts/general/interp3.m,
scripts/general/interpft.m, scripts/general/interpn.m,
scripts/general/loadobj.m, scripts/general/logspace.m,
scripts/general/methods.m, scripts/general/nargchk.m,
scripts/general/narginchk.m, scripts/general/nargoutchk.m,
scripts/general/nextpow2.m, scripts/general/nthargout.m,
scripts/general/num2str.m, scripts/general/pol2cart.m,
scripts/general/polyarea.m, scripts/general/postpad.m,
scripts/general/prepad.m, scripts/general/profile.m, scripts/general/quadgk.m,
scripts/general/quadl.m, scripts/general/quadv.m, scripts/general/randi.m,
scripts/general/rat.m, scripts/general/repmat.m, scripts/general/rot90.m,
scripts/general/rotdim.m, scripts/general/saveobj.m, scripts/general/shift.m,
scripts/general/shiftdim.m, scripts/general/sortrows.m,
scripts/general/sph2cart.m, scripts/general/structfun.m,
scripts/general/subsindex.m, scripts/general/trapz.m,
scripts/general/triplequad.m, scripts/geometry/delaunayn.m,
scripts/geometry/dsearch.m, scripts/geometry/dsearchn.m,
scripts/geometry/griddata.m, scripts/geometry/griddata3.m,
scripts/geometry/griddatan.m, scripts/geometry/inpolygon.m,
scripts/geometry/rectint.m, scripts/geometry/tsearchn.m,
scripts/geometry/voronoi.m, scripts/geometry/voronoin.m,
scripts/help/__unimplemented__.m, scripts/help/doc.m,
scripts/help/doc_cache_create.m, scripts/help/get_first_help_sentence.m,
scripts/help/help.m, scripts/help/lookfor.m, scripts/help/print_usage.m,
scripts/help/type.m, scripts/help/which.m, scripts/image/autumn.m,
scripts/image/bone.m, scripts/image/brighten.m, scripts/image/cmpermute.m,
scripts/image/colorcube.m, scripts/image/contrast.m, scripts/image/cool.m,
scripts/image/copper.m, scripts/image/cubehelix.m, scripts/image/flag.m,
scripts/image/gmap40.m, scripts/image/gray.m, scripts/image/gray2ind.m,
scripts/image/hot.m, scripts/image/hsv.m, scripts/image/image.m,
scripts/image/imagesc.m, scripts/image/imfinfo.m, scripts/image/imformats.m,
scripts/image/imread.m, scripts/image/imshow.m, scripts/image/imwrite.m,
scripts/image/iscolormap.m, scripts/image/jet.m, scripts/image/lines.m,
scripts/image/ntsc2rgb.m, scripts/image/ocean.m, scripts/image/pink.m,
scripts/image/prism.m, scripts/image/rainbow.m, scripts/image/rgb2ntsc.m,
scripts/image/spinmap.m, scripts/image/spring.m, scripts/image/summer.m,
scripts/image/white.m, scripts/image/winter.m:
Update docstrings to have one sentence summary as first line.
Re-structure to have line lengths <= 80 chars.
author | Rik <rik@octave.org> |
---|---|
date | Sun, 03 May 2015 09:36:20 -0700 |
parents | 9fc020886ae9 |
children |
line wrap: on
line source
## Copyright (C) 2012-2015 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 {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 @code{T = profile ("info")}. ## ## @item profile clear ## Clear all collected profiler data. ## ## @item profile resume ## Restart profiling without clearing the old data. All newly collected ## statistics are added to the existing ones. ## ## @item @var{S} = profile ("status") ## Return a structure with 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. In addition, 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{profshow, profexplore} ## @end table ## @end deftypefn ## Built-in profiler. ## Author: Daniel Kraft <d@domob.eu> function retval = profile (option) if (nargin != 1) print_usage (); endif switch (option) case "on" __profiler_reset__ (); __profiler_enable__ (true); case "off" __profiler_enable__ (false); case "clear" __profiler_reset__ (); case "resume" __profiler_enable__ (true); case "status" enabled = __profiler_enable__ (); if (enabled) enabled = "on"; else enabled = "off"; endif retval = struct ("ProfilerStatus", enabled); case "info" [flat, tree] = __profiler_data__ (); retval = struct ("FunctionTable", flat, "Hierarchical", tree); otherwise warning ("profile: Unrecognized option '%s'", option); print_usage (); endswitch endfunction %!demo %! profile on; %! A = rand (100); %! B = expm (A); %! profile off; %! profile resume; %! C = sqrtm (A); %! profile off; %! T = profile ("info"); %! profshow (T); %!test %! on_struct.ProfilerStatus = "on"; %! off_struct.ProfilerStatus = "off"; %! profile ("on"); %! result = logm (rand (200) + 10 * eye (200)); %! assert (profile ("status"), on_struct); %! profile ("off"); %! assert (profile ("status"), off_struct); %! profile ("resume"); %! result = logm (rand (200) + 10 * eye (200)); %! profile ("off"); %! assert (profile ("status"), off_struct); %! info = profile ("info"); %! assert (isstruct (info)); %! assert (size (info), [1, 1]); %! assert (fieldnames (info), {"FunctionTable"; "Hierarchical"}); %! ftbl = info.FunctionTable; %! assert (fieldnames (ftbl), {"FunctionName"; "TotalTime"; "NumCalls"; "IsRecursive"; "Parents"; "Children"}); %! hier = info.Hierarchical; %! assert (fieldnames (hier), {"Index"; "SelfTime"; "TotalTime"; "NumCalls"; "Children"}); %! profile ("clear"); %! info = profile ("info"); %! assert (isstruct (info)); %! assert (size (info), [1, 1]); %! assert (fieldnames (info), {"FunctionTable"; "Hierarchical"}); %! ftbl = info.FunctionTable; %! assert (size (ftbl), [0, 1]); %! assert (fieldnames (ftbl), {"FunctionName"; "TotalTime"; "NumCalls"; "IsRecursive"; "Parents"; "Children"}); %! hier = info.Hierarchical; %! assert (size (hier), [0, 1]); %! assert (fieldnames (hier), {"Index"; "SelfTime"; "NumCalls"; "Children"}); ## Test input validation %!error profile () %!error profile ("on", 2) %!error profile ("INVALID_OPTION")