Mercurial > octave-antonio
view scripts/general/int2str.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 | 4197fc428c7d |
children |
line wrap: on
line source
## Copyright (C) 1993-2015 John W. Eaton ## ## 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} {} int2str (@var{n}) ## Convert an integer (or array of integers) to a string (or a character ## array). ## ## @example ## @group ## int2str (123) ## @result{} "123" ## ## s = int2str ([1, 2, 3; 4, 5, 6]) ## @result{} s = ## 1 2 3 ## 4 5 6 ## ## whos s ## @result{} ## Attr Name Size Bytes Class ## ==== ==== ==== ===== ===== ## s 2x7 14 char ## @end group ## @end example ## ## This function is not very flexible. For better control over the ## results, use @code{sprintf} (@pxref{Formatted Output}). ## @seealso{sprintf, num2str, mat2str} ## @end deftypefn ## Author: jwe function retval = int2str (n) if (nargin != 1) print_usage (); endif if (isempty (n)) retval = ''; return; endif n = round (real (n)); sz = size (n); nd = ndims (n); nc = columns (n); if (nc > 1) idx = repmat ({':'}, nd, 1); idx(2) = 1; ifmt = get_fmt (n(idx{:}), 0); idx(2) = 2:sz(2); rfmt = get_fmt (n(idx{:}), 2); fmt = [ifmt repmat(rfmt,1,nc-1) "\n"]; else fmt = [get_fmt(n, 0) "\n"]; endif tmp = sprintf (fmt, permute (n, [2, 1, 3 : nd])); tmp(end) = ""; retval = char (ostrsplit (tmp, "\n")); endfunction function fmt = get_fmt (x, sep) t = x(:); t = t(t != 0); if (isempty (t)) ## All zeros. fmt = sprintf ("%%%dd", 1 + sep); else ## Maybe have some zeros. nan_inf = ! isfinite (t); if (any (nan_inf)) if (any (t(nan_inf) < 0)) min_fw = 4 + sep; else min_fw = 3 + sep; endif else min_fw = 1 + sep; endif t = t(! nan_inf); if (isempty (t)) ## Only zeros, Inf, and NaN. fmt = sprintf ("%%%dd", min_fw); else ## Could have anything. tfw = floor (log10 (double (abs (t)))) + 1 + sep; fw = max (tfw); if (any (t(tfw == fw) < 0)) fw++; endif fmt = sprintf ("%%%dd", max (fw, min_fw)); endif endif endfunction %!assert (int2str (-123), "-123") %!assert (int2str (1.2), "1") %!assert (int2str ([1, 2, 3; 4, 5, 6]), ["1 2 3";"4 5 6"]) %!assert (int2str ([]), "") %!error int2str () %!error int2str (1, 2)