Mercurial > octave-antonio
view scripts/general/celldisp.m @ 20164:df437a52bcaf stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed miscellaneous, sparse, strings in scripts directory.
* scripts/miscellaneous/bzip2.m, scripts/miscellaneous/citation.m,
scripts/miscellaneous/compare_versions.m, scripts/miscellaneous/computer.m,
scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m,
scripts/miscellaneous/edit.m, scripts/miscellaneous/error_ids.m,
scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/fullfile.m,
scripts/miscellaneous/genvarname.m, scripts/miscellaneous/gzip.m,
scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/news.m,
scripts/miscellaneous/open.m, scripts/miscellaneous/parseparams.m,
scripts/miscellaneous/recycle.m, scripts/miscellaneous/run.m,
scripts/miscellaneous/swapbytes.m, scripts/miscellaneous/tar.m,
scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m,
scripts/miscellaneous/what.m, scripts/sparse/bicg.m, scripts/sparse/bicgstab.m,
scripts/sparse/cgs.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m,
scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/gplot.m,
scripts/sparse/ichol.m, scripts/sparse/ilu.m, scripts/sparse/pcg.m,
scripts/sparse/pcr.m, scripts/sparse/qmr.m, scripts/sparse/spaugment.m,
scripts/sparse/spconvert.m, scripts/sparse/spdiags.m, scripts/sparse/spfun.m,
scripts/sparse/spones.m, scripts/sparse/sprandsym.m, scripts/sparse/spstats.m,
scripts/sparse/spy.m, scripts/sparse/svds.m, scripts/sparse/treelayout.m,
scripts/sparse/treeplot.m, scripts/strings/base2dec.m,
scripts/strings/bin2dec.m, scripts/strings/blanks.m, scripts/strings/cstrcat.m,
scripts/strings/deblank.m, scripts/strings/dec2base.m,
scripts/strings/dec2bin.m, scripts/strings/dec2hex.m,
scripts/strings/findstr.m, scripts/strings/hex2dec.m, scripts/strings/index.m,
scripts/strings/isletter.m, scripts/strings/isstrprop.m,
scripts/strings/mat2str.m, scripts/strings/ostrsplit.m,
scripts/strings/regexptranslate.m, scripts/strings/rindex.m,
scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strchr.m,
scripts/strings/strjoin.m, scripts/strings/strjust.m,
scripts/strings/strmatch.m, scripts/strings/strsplit.m,
scripts/strings/strtok.m, scripts/strings/strtrim.m,
scripts/strings/strtrunc.m, scripts/strings/substr.m,
scripts/strings/untabify.m, scripts/time/datenum.m:
Update more docstrings to have one sentence summary as first line.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 04 May 2015 14:22:02 -0700 |
parents | 7503499a252b |
children |
line wrap: on
line source
## Copyright (C) 2007-2015 David Bateman ## ## 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} {} celldisp (@var{c}) ## @deftypefnx {Function File} {} celldisp (@var{c}, @var{name}) ## Recursively display the contents of a cell array. ## ## By default the values are displayed with the name of the variable @var{c}. ## However, this name can be replaced with the variable @var{name}. For ## example: ## ## @example ## @group ## c = @{1, 2, @{31, 32@}@}; ## celldisp (c, "b") ## @result{} ## b@{1@} = ## 1 ## b@{2@} = ## 2 ## b@{3@}@{1@} = ## 31 ## b@{3@}@{2@} = ## 32 ## @end group ## @end example ## ## @seealso{disp} ## @end deftypefn ## This is ugly, but seems to be what matlab does.. function celldisp (c, name) if (nargin < 1 || nargin > 2) print_usage (); endif if (! iscell (c)) error ("celldisp: C must be a cell array"); endif if (nargin == 1) name = inputname (1); endif for i = 1: numel (c) if (iscell (c{i})) celldisp (c{i}, sprintf ("%s{%s}", name, indices (size (c), i))); else disp (sprintf ("%s{%s} = \n", name, indices (size (c), i))); disp (c{i}); disp (""); endif endfor endfunction function s = indices (dv, i) if (sum (dv != 1) > 1) c = cell (size (dv)); [c{:}] = ind2sub (dv, i); s = sprintf ("%i,", c{:}); s(end) = []; else s = sprintf ("%i", i); endif endfunction %!demo %! c = {1, 2, {31, 32}}; %! celldisp (c, "b") ## Test input validation %!error celldisp () %!error celldisp ({}, "name", 1) %!error <C must be a cell array> celldisp (1)