octave-antonio: scripts/general/profile.m annotate

annotate 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

rev	line source
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	1 ## Copyright (C) 2012-2015 Daniel Kraft
12869 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 --
13929 9cae456085c2 Grammarcheck of documentation before 3.6.0 release. Rik <octave@nomad.inbox5.com> parents: 13201 diff changeset	20 ## @deftypefn {Command} {} profile on
9cae456085c2 Grammarcheck of documentation before 3.6.0 release. Rik <octave@nomad.inbox5.com> parents: 13201 diff changeset	21 ## @deftypefnx {Command} {} profile off
9cae456085c2 Grammarcheck of documentation before 3.6.0 release. Rik <octave@nomad.inbox5.com> parents: 13201 diff changeset	22 ## @deftypefnx {Command} {} profile resume
9cae456085c2 Grammarcheck of documentation before 3.6.0 release. Rik <octave@nomad.inbox5.com> parents: 13201 diff changeset	23 ## @deftypefnx {Command} {} profile clear
14359 7277fe922e99 doc: Use Octave preference for double quote in docstrings in scripts/ Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	24 ## @deftypefnx {Function File} {@var{S} =} profile ("status")
7277fe922e99 doc: Use Octave preference for double quote in docstrings in scripts/ Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	25 ## @deftypefnx {Function File} {@var{T} =} profile ("info")
12869 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
20158 7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	30 ## Start the profiler, clearing all previously collected data if there is any.
12869 de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	31 ##
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	32 ## @item profile off
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	33 ## Stop profiling. The collected data can later be retrieved and examined
20158 7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	34 ## with @code{T = profile ("info")}.
12869 de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	35 ##
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	36 ## @item profile clear
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	37 ## 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	38 ##
de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	39 ## @item profile resume
20158 7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	40 ## Restart profiling without clearing the old data. All newly collected
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	41 ## statistics are added to the existing ones.
12869 de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	42 ##
14359 7277fe922e99 doc: Use Octave preference for double quote in docstrings in scripts/ Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	43 ## @item @var{S} = profile ("status")
20158 7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	44 ## Return a structure with information about the current status of the profiler.
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	45 ## At the moment, the only field is @code{ProfilerStatus} which is either
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	46 ## @qcode{"on"} or @qcode{"off"}.
12869 de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	47 ##
14359 7277fe922e99 doc: Use Octave preference for double quote in docstrings in scripts/ Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	48 ## @item @var{T} = profile ("info")
20158 7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	49 ## Return the collected profiling statistics in the structure @var{T}. The
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	50 ## flat profile is returned in the field @code{FunctionTable} which is an
12961 8c64cc024e8c Make hierarchical profile available via profile('info'). Daniel Kraft <d@domob.eu> parents: 12955 diff changeset	51 ## array of structures, each entry corresponding to a function which was called
20158 7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	52 ## and for which profiling statistics are present. In addition, the field
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	53 ## @code{Hierarchical} contains the hierarchical call tree. Each node has an
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	54 ## index into the @code{FunctionTable} identifying the function it corresponds
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	55 ## to as well as data fields for number of calls and time spent at this level
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	56 ## in the call tree.
13191 c5ddb99ff5de Put @seealso in profiler functions' docstrings. Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 13053 diff changeset	57 ## @seealso{profshow, profexplore}
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)
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 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
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 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
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 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
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 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
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 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)
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 enabled = "on";
12869 de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	88 else
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 enabled = "off";
12869 de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	90 endif
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	91 retval = struct ("ProfilerStatus", enabled);
12869 de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	92
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 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__ ();
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 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
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 %! profile on;
12869 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);
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	110 %! profile off;
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	111 %! profile resume;
12869 de9a9719e594 Extend data collection in profiler and add user-interface profile function. Daniel Kraft <d@domob.eu> parents: diff changeset	112 %! C = sqrtm (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	113 %! profile off;
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	114 %! T = profile ("info");
12871 23377c46516b Implement the profshow function to print profiler results. Daniel Kraft <d@domob.eu> parents: 12869 diff changeset	115 %! profshow (T);
13053 a7e82bdf12b3 codesprint: tests for profile.m John W. Eaton <jwe@octave.org> parents: 12961 diff changeset	116
a7e82bdf12b3 codesprint: tests for profile.m John W. Eaton <jwe@octave.org> parents: 12961 diff changeset	117 %!test
a7e82bdf12b3 codesprint: tests for profile.m John W. Eaton <jwe@octave.org> parents: 12961 diff changeset	118 %! on_struct.ProfilerStatus = "on";
a7e82bdf12b3 codesprint: tests for profile.m John W. Eaton <jwe@octave.org> parents: 12961 diff changeset	119 %! off_struct.ProfilerStatus = "off";
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	120 %! profile ("on");
13053 a7e82bdf12b3 codesprint: tests for profile.m John W. Eaton <jwe@octave.org> parents: 12961 diff changeset	121 %! result = logm (rand (200) + 10 * eye (200));
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	122 %! assert (profile ("status"), on_struct);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	123 %! profile ("off");
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	124 %! assert (profile ("status"), off_struct);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	125 %! profile ("resume");
13053 a7e82bdf12b3 codesprint: tests for profile.m John W. Eaton <jwe@octave.org> parents: 12961 diff changeset	126 %! result = logm (rand (200) + 10 * eye (200));
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	127 %! profile ("off");
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	128 %! assert (profile ("status"), off_struct);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	129 %! info = profile ("info");
13053 a7e82bdf12b3 codesprint: tests for profile.m John W. Eaton <jwe@octave.org> parents: 12961 diff changeset	130 %! assert (isstruct (info));
a7e82bdf12b3 codesprint: tests for profile.m John W. Eaton <jwe@octave.org> parents: 12961 diff changeset	131 %! assert (size (info), [1, 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	132 %! assert (fieldnames (info), {"FunctionTable"; "Hierarchical"});
13053 a7e82bdf12b3 codesprint: tests for profile.m John W. Eaton <jwe@octave.org> parents: 12961 diff changeset	133 %! ftbl = info.FunctionTable;
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	134 %! assert (fieldnames (ftbl), {"FunctionName"; "TotalTime"; "NumCalls"; "IsRecursive"; "Parents"; "Children"});
13053 a7e82bdf12b3 codesprint: tests for profile.m John W. Eaton <jwe@octave.org> parents: 12961 diff changeset	135 %! hier = info.Hierarchical;
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	136 %! assert (fieldnames (hier), {"Index"; "SelfTime"; "TotalTime"; "NumCalls"; "Children"});
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	137 %! profile ("clear");
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	138 %! info = profile ("info");
13053 a7e82bdf12b3 codesprint: tests for profile.m John W. Eaton <jwe@octave.org> parents: 12961 diff changeset	139 %! assert (isstruct (info));
a7e82bdf12b3 codesprint: tests for profile.m John W. Eaton <jwe@octave.org> parents: 12961 diff changeset	140 %! assert (size (info), [1, 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	141 %! assert (fieldnames (info), {"FunctionTable"; "Hierarchical"});
13053 a7e82bdf12b3 codesprint: tests for profile.m John W. Eaton <jwe@octave.org> parents: 12961 diff changeset	142 %! ftbl = info.FunctionTable;
a7e82bdf12b3 codesprint: tests for profile.m John W. Eaton <jwe@octave.org> parents: 12961 diff changeset	143 %! assert (size (ftbl), [0, 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	144 %! assert (fieldnames (ftbl), {"FunctionName"; "TotalTime"; "NumCalls"; "IsRecursive"; "Parents"; "Children"});
13053 a7e82bdf12b3 codesprint: tests for profile.m John W. Eaton <jwe@octave.org> parents: 12961 diff changeset	145 %! hier = info.Hierarchical;
a7e82bdf12b3 codesprint: tests for profile.m John W. Eaton <jwe@octave.org> parents: 12961 diff changeset	146 %! assert (size (hier), [0, 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	147 %! assert (fieldnames (hier), {"Index"; "SelfTime"; "NumCalls"; "Children"});
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	148
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	149 ## Test input validation
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	150 %!error profile ()
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	151 %!error profile ("on", 2)
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14359 diff changeset	152 %!error profile ("INVALID_OPTION")
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	153

Mercurial > octave-antonio

annotate scripts/general/profile.m @ 20158:7503499a252b stable