Mercurial > octave
view scripts/general/int2str.m @ 28891:de5f2f9a64ff
maint: Use same coding style when checking for a minimum of 1 input.
* disp.m, __get_properties__.m, disp.m, isplaying.m, pause.m, resume.m,
stop.m, __get_properties__.m, disp.m, isrecording.m, pause.m, resume.m, stop.m,
mu2lin.m, acosd.m, acot.m, acotd.m, acoth.m, acsc.m, acscd.m, acsch.m, asec.m,
asecd.m, asech.m, asind.m, atand.m, cosd.m, cot.m, cotd.m, coth.m, csc.m,
cscd.m, csch.m, sec.m, secd.m, sech.m, sind.m, tand.m, cell2mat.m, deg2rad.m,
fliplr.m, flipud.m, int2str.m, nextpow2.m, num2str.m, rad2deg.m, subsindex.m,
rotx.m, roty.m, rotz.m, voronoin.m, __unimplemented__.m, frame2im.m, hsv2rgb.m,
iscolormap.m, __imfinfo__.m, rgb2gray.m, rgb2hsv.m, fileread.m,
is_valid_file_id.m, usejava.m, argnames.m, char.m, formula.m, vectorize.m,
isdir.m, vectorize.m, condeig.m, duplication_matrix.m, expm.m, isdiag.m,
istril.m, istriu.m, normest.m, planerot.m, trace.m, vech.m, fieldnames.m,
fileparts.m, grabcode.m, isfile.m, isfolder.m, mustBeFinite.m, mustBeInteger.m,
mustBeNegative.m, mustBeNonNan.m, mustBeNonempty.m, mustBeNonnegative.m,
mustBeNonpositive.m, mustBeNonsparse.m, mustBeNonzero.m, mustBeNumeric.m,
mustBeNumericOrLogical.m, mustBePositive.m, mustBeReal.m, namedargs2cell.m,
open.m, run.m, swapbytes.m, pareto.m, allchild.m, colstyle.m, hdl2struct.m,
isaxes.m, isfigure.m, ishandle.m, compan.m, poly.m, polyreduce.m, ppjumps.m,
roots.m, unmkpp.m, profexplore.m, profile.m, bartlett.m, fftshift.m, hurst.m,
ifftshift.m, sinc.m, spencer.m, yulewalker.m, colperm.m, nonzeros.m,
spconvert.m, spones.m, sprandsym.m, cosint.m, expint.m, factor.m, factorial.m,
isprime.m, perms.m, primes.m, reallog.m, realsqrt.m, sinint.m, gallery.m,
hadamard.m, hilb.m, invhilb.m, magic.m, wilkinson.m, center.m, iqr.m, meansq.m,
median.m, runlength.m, bin2dec.m, blanks.m, deblank.m, hex2dec.m, isletter.m,
isstring.m, str2num.m, strtrim.m, asctime.m, ctime.m:
Replace "if (nargin != 1)" formulations with "if (nargin < 1)" to match
the rest of Octave.
author | Rik <rik@octave.org> |
---|---|
date | Sat, 10 Oct 2020 16:32:20 -0700 |
parents | d8318c12d903 |
children | 7854d5752dd2 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 1993-2020 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## 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 ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {} 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{} Variables in the current scope: ## Attr Name Size Bytes Class ## ==== ==== ==== ===== ===== ## s 2x7 14 char ## Total is 14 elements using 14 bytes ## @end group ## @end example ## ## This function is not very flexible. For better control over the ## results, use @code{sprintf} (@pxref{Formatted Output}). ## ## Programming Notes: ## ## Non-integers are rounded to integers before display. Only the real part ## of complex numbers is displayed. ## ## @seealso{sprintf, num2str, mat2str} ## @end deftypefn function retval = int2str (n) if (nargin < 1) print_usage (); elseif (! (isnumeric (n) || islogical (n) || ischar (n))) error ("int2str: N must be a numeric, logical, or character array"); endif if (ischar (n)) retval = n; return; elseif (isempty (n)) retval = ""; return; endif n = round (real (n)); ## Set up a suitable format string while ignoring Inf/NaN entries nan_inf = ! isfinite (n(:)); ndgt = floor (log10 (max (abs (n(! nan_inf))))); if (isempty (ndgt) || ndgt == -Inf) ndgt = 0; # All Inf or all zero array endif ndgt += 3; if (any (nan_inf)) ndgt = max (ndgt, 5); endif ## FIXME: Integers should be masked to show only 16 significant digits fmt = sprintf ("%%%d.0f", ndgt); nd = ndims (n); nc = columns (n) * (nd - 1); # ND-arrays are expanded in columns n = permute (n, [2, 3:nd, 1]); fmt = [repmat(fmt, 1, nc), "\n"]; strtmp = sprintf (fmt, n); retval = strtrim (char (ostrsplit (strtmp, "\n", true))); endfunction %!assert (int2str (123), "123") %!assert (int2str (-123), "-123") %!assert (int2str (1.2), "1") %!assert (int2str (1.6), "2") %!assert (int2str ([1, 2, 3; 4, 5, 6]), ["1 2 3";"4 5 6"]) %!assert (int2str ([]), "") %!error <Invalid call> int2str () %!error <N must be a numeric> int2str ({1})