Mercurial > hg > octave-nkf

comparison scripts/general/profile.m @ 20368:7503499a252b stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
comparison
equal deleted inserted replaced
20363:3b3579ad7e46 20368:7503499a252b
25 ## @deftypefnx {Function File} {@var{T} =} profile ("info") 25 ## @deftypefnx {Function File} {@var{T} =} profile ("info")
26 ## Control the built-in profiler. 26 ## Control the built-in profiler.
27 ## 27 ##
28 ## @table @code 28 ## @table @code
29 ## @item profile on 29 ## @item profile on
30 ## Start the profiler, clearing all previously collected data if there 30 ## Start the profiler, clearing all previously collected data if there is any.
31 ## is any.
32 ## 31 ##
33 ## @item profile off 32 ## @item profile off
34 ## Stop profiling. The collected data can later be retrieved and examined 33 ## Stop profiling. The collected data can later be retrieved and examined
35 ## with calls like @code{S = profile ("info")}. 34 ## with @code{T = profile ("info")}.
36 ## 35 ##
37 ## @item profile clear 36 ## @item profile clear
38 ## Clear all collected profiler data. 37 ## Clear all collected profiler data.
39 ## 38 ##
40 ## @item profile resume 39 ## @item profile resume
41 ## Restart profiling without cleaning up the old data and instead 40 ## Restart profiling without clearing the old data. All newly collected
42 ## all newly collected statistics are added to the already existing ones. 41 ## statistics are added to the existing ones.
43 ## 42 ##
44 ## @item @var{S} = profile ("status") 43 ## @item @var{S} = profile ("status")
45 ## Return a structure filled with certain information about the current status 44 ## Return a structure with information about the current status of the profiler.
46 ## of the profiler. At the moment, the only field is @code{ProfilerStatus} 45 ## At the moment, the only field is @code{ProfilerStatus} which is either
47 ## which is either @qcode{"on"} or @qcode{"off"}. 46 ## @qcode{"on"} or @qcode{"off"}.
48 ## 47 ##
49 ## @item @var{T} = profile ("info") 48 ## @item @var{T} = profile ("info")
50 ## Return the collected profiling statistics in the structure @var{T}. 49 ## Return the collected profiling statistics in the structure @var{T}. The
51 ## The flat profile is returned in the field @code{FunctionTable} which is an 50 ## flat profile is returned in the field @code{FunctionTable} which is an
52 ## array of structures, each entry corresponding to a function which was called 51 ## array of structures, each entry corresponding to a function which was called
53 ## and for which profiling statistics are present. Furthermore, the field 52 ## and for which profiling statistics are present. In addition, the field
54 ## @code{Hierarchical} contains the hierarchical call-tree. Each node 53 ## @code{Hierarchical} contains the hierarchical call tree. Each node has an
55 ## has an index into the @code{FunctionTable} identifying the function it 54 ## index into the @code{FunctionTable} identifying the function it corresponds
56 ## corresponds to as well as data fields for number of calls and time spent 55 ## to as well as data fields for number of calls and time spent at this level
57 ## at this level in the call-tree. 56 ## in the call tree.
58 ## @seealso{profshow, profexplore} 57 ## @seealso{profshow, profexplore}
59 ## @end table 58 ## @end table
60 ## @end deftypefn 59 ## @end deftypefn
61 60
62 ## Built-in profiler. 61 ## Built-in profiler.