annotate scripts/general/num2str.m @ 14363:f3d52523cde1

Use Octave coding conventions in all m-file %!test blocks * wavread.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, accumarray.m, accumdim.m, bitcmp.m, bitget.m, bitset.m, blkdiag.m, cart2pol.m, cart2sph.m, celldisp.m, chop.m, circshift.m, colon.m, common_size.m, cplxpair.m, cumtrapz.m, curl.m, dblquad.m, deal.m, divergence.m, flipdim.m, fliplr.m, flipud.m, genvarname.m, gradient.m, idivide.m, int2str.m, interp1.m, interp1q.m, interp2.m, interp3.m, interpft.m, interpn.m, isa.m, isdir.m, isequal.m, isequalwithequalnans.m, issquare.m, logspace.m, nargchk.m, narginchk.m, nargoutchk.m, nextpow2.m, nthargout.m, num2str.m, pol2cart.m, polyarea.m, postpad.m, prepad.m, profile.m, profshow.m, quadgk.m, quadv.m, randi.m, rat.m, repmat.m, rot90.m, rotdim.m, shift.m, shiftdim.m, sph2cart.m, structfun.m, trapz.m, triplequad.m, convhull.m, dsearch.m, dsearchn.m, griddata3.m, griddatan.m, rectint.m, tsearchn.m, __makeinfo__.m, doc.m, get_first_help_sentence.m, help.m, type.m, unimplemented.m, which.m, imread.m, imwrite.m, dlmwrite.m, fileread.m, is_valid_file_id.m, strread.m, textread.m, textscan.m, commutation_matrix.m, cond.m, condest.m, cross.m, duplication_matrix.m, expm.m, housh.m, isdefinite.m, ishermitian.m, issymmetric.m, logm.m, normest.m, null.m, onenormest.m, orth.m, planerot.m, qzhess.m, rank.m, rref.m, trace.m, vech.m, ans.m, bincoeff.m, bug_report.m, bzip2.m, comma.m, compare_versions.m, computer.m, edit.m, fileparts.m, fullfile.m, getfield.m, gzip.m, info.m, inputname.m, isappdata.m, isdeployed.m, ismac.m, ispc.m, isunix.m, list_primes.m, ls.m, mexext.m, namelengthmax.m, news.m, orderfields.m, paren.m, recycle.m, rmappdata.m, semicolon.m, setappdata.m, setfield.m, substruct.m, symvar.m, ver.m, version.m, warning_ids.m, xor.m, fminbnd.m, fsolve.m, fzero.m, lsqnonneg.m, optimset.m, pqpnonneg.m, sqp.m, matlabroot.m, __gnuplot_drawnow__.m, __plt_get_axis_arg__.m, ancestor.m, cla.m, clf.m, close.m, colorbar.m, colstyle.m, comet3.m, contourc.m, figure.m, gca.m, gcbf.m, gcbo.m, gcf.m, ginput.m, graphics_toolkit.m, gtext.m, hggroup.m, hist.m, hold.m, isfigure.m, ishghandle.m, ishold.m, isocolors.m, isonormals.m, isosurface.m, isprop.m, legend.m, line.m, loglog.m, loglogerr.m, meshgrid.m, ndgrid.m, newplot.m, orient.m, patch.m, plot3.m, plotyy.m, __print_parse_opts__.m, quiver3.m, refreshdata.m, ribbon.m, semilogx.m, semilogxerr.m, semilogy.m, stem.m, stem3.m, subplot.m, title.m, uigetfile.m, view.m, whitebg.m, compan.m, conv.m, deconv.m, mkpp.m, mpoles.m, pchip.m, poly.m, polyaffine.m, polyder.m, polyfit.m, polygcd.m, polyint.m, polyout.m, polyval.m, polyvalm.m, ppder.m, ppint.m, ppjumps.m, ppval.m, residue.m, roots.m, spline.m, intersect.m, ismember.m, powerset.m, setdiff.m, setxor.m, union.m, unique.m, autoreg_matrix.m, bartlett.m, blackman.m, detrend.m, fftconv.m, fftfilt.m, fftshift.m, freqz.m, hamming.m, hanning.m, ifftshift.m, sinc.m, sinetone.m, sinewave.m, unwrap.m, bicg.m, bicgstab.m, gmres.m, gplot.m, nonzeros.m, pcg.m, pcr.m, spaugment.m, spconvert.m, spdiags.m, speye.m, spfun.m, spones.m, sprand.m, sprandsym.m, spstats.m, spy.m, svds.m, treelayout.m, bessel.m, beta.m, betaln.m, factor.m, factorial.m, isprime.m, lcm.m, legendre.m, nchoosek.m, nthroot.m, perms.m, pow2.m, primes.m, reallog.m, realpow.m, realsqrt.m, hadamard.m, hankel.m, hilb.m, invhilb.m, magic.m, rosser.m, vander.m, __finish__.m, center.m, cloglog.m, corr.m, cov.m, gls.m, histc.m, iqr.m, kendall.m, kurtosis.m, logit.m, mahalanobis.m, mean.m, meansq.m, median.m, mode.m, moment.m, ols.m, ppplot.m, prctile.m, probit.m, quantile.m, range.m, ranks.m, run_count.m, runlength.m, skewness.m, spearman.m, statistics.m, std.m, table.m, var.m, zscore.m, betacdf.m, betainv.m, betapdf.m, betarnd.m, binocdf.m, binoinv.m, binopdf.m, binornd.m, cauchy_cdf.m, cauchy_inv.m, cauchy_pdf.m, cauchy_rnd.m, chi2cdf.m, chi2inv.m, chi2pdf.m, chi2rnd.m, discrete_cdf.m, discrete_inv.m, discrete_pdf.m, discrete_rnd.m, empirical_cdf.m, empirical_inv.m, empirical_pdf.m, empirical_rnd.m, expcdf.m, expinv.m, exppdf.m, exprnd.m, fcdf.m, finv.m, fpdf.m, frnd.m, gamcdf.m, gaminv.m, gampdf.m, gamrnd.m, geocdf.m, geoinv.m, geopdf.m, geornd.m, hygecdf.m, hygeinv.m, hygepdf.m, hygernd.m, kolmogorov_smirnov_cdf.m, laplace_cdf.m, laplace_inv.m, laplace_pdf.m, laplace_rnd.m, logistic_cdf.m, logistic_inv.m, logistic_pdf.m, logistic_rnd.m, logncdf.m, logninv.m, lognpdf.m, lognrnd.m, nbincdf.m, nbininv.m, nbinpdf.m, nbinrnd.m, normcdf.m, norminv.m, normpdf.m, normrnd.m, poisscdf.m, poissinv.m, poisspdf.m, poissrnd.m, stdnormal_cdf.m, stdnormal_inv.m, stdnormal_pdf.m, stdnormal_rnd.m, tcdf.m, tinv.m, tpdf.m, trnd.m, unidcdf.m, unidinv.m, unidpdf.m, unidrnd.m, unifcdf.m, unifinv.m, unifpdf.m, unifrnd.m, wblcdf.m, wblinv.m, wblpdf.m, wblrnd.m, kolmogorov_smirnov_test.m, kruskal_wallis_test.m, base2dec.m, bin2dec.m, blanks.m, cstrcat.m, deblank.m, dec2base.m, dec2bin.m, dec2hex.m, findstr.m, hex2dec.m, index.m, isletter.m, mat2str.m, rindex.m, str2num.m, strcat.m, strjust.m, strmatch.m, strsplit.m, strtok.m, strtrim.m, strtrunc.m, substr.m, validatestring.m, demo.m, example.m, fail.m, speed.m, addtodate.m, asctime.m, clock.m, ctime.m, date.m, datenum.m, datetick.m, datevec.m, eomday.m, etime.m, is_leap_year.m, now.m: Use Octave coding conventions in all m-file %!test blocks
author Rik <octave@nomad.inbox5.com>
date Mon, 13 Feb 2012 07:29:44 -0800
parents 72c96de7a403
children f8e041f11b18
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 13279
diff changeset
1 ## Copyright (C) 1993-2012 John W. Eaton
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
2 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
6 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6997
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6997
diff changeset
8 ## your option) any later version.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
13 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6997
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6997
diff changeset
17 ## <http://www.gnu.org/licenses/>.
245
16a24e76d6e0 [project @ 1993-12-03 02:00:15 by jwe]
jwe
parents: 4
diff changeset
18
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2847
diff changeset
19 ## -*- texinfo -*-
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 10549
diff changeset
20 ## @deftypefn {Function File} {} num2str (@var{x})
4229
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
21 ## @deftypefnx {Function File} {} num2str (@var{x}, @var{precision})
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
22 ## @deftypefnx {Function File} {} num2str (@var{x}, @var{format})
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
23 ## Convert a number (or array) to a string (or a character array). The
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
24 ## optional second argument may either give the number of significant
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
25 ## digits (@var{precision}) to be used in the output or a format
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
26 ## template string (@var{format}) as in @code{sprintf} (@pxref{Formatted
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
27 ## Output}). @code{num2str} can also handle complex numbers. For
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
28 ## example:
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
29 ##
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
30 ## @example
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
31 ## @group
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
32 ## num2str (123.456)
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
33 ## @result{} "123.46"
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
34 ##
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
35 ## num2str (123.456, 4)
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
36 ## @result{} "123.5"
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
37 ##
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
38 ## s = num2str ([1, 1.34; 3, 3.56], "%5.1f")
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
39 ## @result{} s =
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
40 ## 1.0 1.3
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
41 ## 3.0 3.6
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
42 ## whos s
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
43 ## @result{}
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
44 ## Attr Name Size Bytes Class
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
45 ## ==== ==== ==== ===== =====
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
46 ## s 2x8 16 char
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
47 ##
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
48 ## num2str (1.234 + 27.3i)
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
49 ## @result{} "1.234+27.3i"
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
50 ## @end group
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
51 ## @end example
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
52 ##
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
53 ## The @code{num2str} function is not very flexible. For better control
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
54 ## over the results, use @code{sprintf} (@pxref{Formatted Output}).
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
55 ## Note that for complex @var{x}, the format string may only contain one
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
56 ## output conversion specification and nothing else. Otherwise, you
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
57 ## will get unpredictable results.
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
58 ## @seealso{sprintf, int2str, mat2str}
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2847
diff changeset
59 ## @end deftypefn
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
60
2314
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
61 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
62
4229
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
63 function retval = num2str (x, arg)
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
64
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
65 if (nargin != 1 && nargin != 2)
5947
009fa69b6182 [project @ 2006-08-21 16:15:20 by jwe]
jwe
parents: 5939
diff changeset
66 print_usage ();
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
67 endif
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
68
5443
ec8c33dcd1bf [project @ 2005-09-08 01:40:57 by jwe]
jwe
parents: 5355
diff changeset
69 if (ischar (x))
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
70 retval = x;
5947
009fa69b6182 [project @ 2006-08-21 16:15:20 by jwe]
jwe
parents: 5939
diff changeset
71 elseif (isempty (x))
009fa69b6182 [project @ 2006-08-21 16:15:20 by jwe]
jwe
parents: 5939
diff changeset
72 retval = "";
009fa69b6182 [project @ 2006-08-21 16:15:20 by jwe]
jwe
parents: 5939
diff changeset
73 elseif (iscomplex (x))
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
74 if (nargin == 2)
5443
ec8c33dcd1bf [project @ 2005-09-08 01:40:57 by jwe]
jwe
parents: 5355
diff changeset
75 if (ischar (arg))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
76 fmt = cstrcat (arg, "%-+", arg(2:end), "i");
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
77 else
13279
984359717d71 Use common code idiom for checking whether a double value is an integer.
Rik <octave@nomad.inbox5.com>
parents: 12676
diff changeset
78 if (isnumeric (x) && x == fix (x) && abs (x) < (10 .^ arg))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
79 fmt = sprintf ("%%%dd%%-+%ddi ", arg, arg);
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
80 else
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
81 fmt = sprintf ("%%%d.%dg%%-+%d.%dgi", arg+7, arg, arg+7, arg);
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
82 endif
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
83 endif
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
84 else
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
85 ## Setup a suitable format string
13279
984359717d71 Use common code idiom for checking whether a double value is an integer.
Rik <octave@nomad.inbox5.com>
parents: 12676
diff changeset
86 if (isnumeric (x) && x == fix (x) && abs (x) < 1e10)
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
87 if (max (abs (real (x(:)))) == 0)
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
88 dgt1 = 2;
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
89 else
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
90 dgt1 = ceil (log10 (max (max (abs (real (x(:)))),
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
91 max (abs (imag (x(:))))))) + 2;
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
92 endif
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
93 dgt2 = dgt1 - (min (real (x(:))) >= 0);
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
94
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
95 if (length (abs (x) == x) > 0)
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
96 fmt = sprintf("%%%dg%%+-%dgi ", dgt2, dgt1);
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
97 else
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
98 fmt = sprintf("%%%dd%%+-%ddi ", dgt2, dgt1);
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
99 endif
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
100 elseif (isscalar (x))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
101 fmt = "%.6g%-+.6gi";
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
102 else
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
103 fmt = "%11.6g%-+11.6gi";
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
104 endif
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
105 endif
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
106
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
107 ## Manipulate the complex value to have real values in the odd
4914
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4911
diff changeset
108 ## columns and imaginary values in the even columns.
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
109 sz = size (x);
4914
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4911
diff changeset
110 nc = sz(2);
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
111 nd = ndims (x);
4914
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4911
diff changeset
112 perm = fix ([1:0.5:nc+0.5]);
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4911
diff changeset
113 perm(2:2:2*nc) = perm(2:2:2*nc) + nc;
12676
2783fa95cab7 Use common code idiom for creating cell array for indexing ND-arrays
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
114 idx = repmat ({':'}, nd, 1);
4914
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4911
diff changeset
115 idx{2} = perm;
7208
a730e47fda4d [project @ 2007-11-28 02:32:41 by jwe]
jwe
parents: 7017
diff changeset
116 x = horzcat (real (x), imag (x));
4914
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4911
diff changeset
117 x = x(idx{:});
5939
2e86e3601e0f [project @ 2006-08-18 17:40:41 by jwe]
jwe
parents: 5642
diff changeset
118
7540
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7411
diff changeset
119 fmt = cstrcat (deblank (repmat (fmt, 1, nc)), "\n");
4914
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4911
diff changeset
120 tmp = sprintf (fmt, permute (x, [2, 1, 3:nd]));
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
121
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
122 ## Put the "i"'s where they are supposed to be.
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
123 while (true)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
124 tmp2 = strrep (tmp, " i\n", "i\n");
4914
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4911
diff changeset
125 if (length (tmp) == length (tmp2))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
126 break;
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
127 else
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
128 tmp = tmp2;
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
129 endif
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
130 endwhile
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
131 while (true)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
132 tmp2 = strrep (tmp, " i", "i ");
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
133 if (tmp == tmp2)
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
134 break;
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
135 else
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
136 tmp = tmp2;
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
137 endif
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
138 endwhile
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
139
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
140 tmp(length (tmp)) = "";
8877
2c8b2399247b implement strsplit; deprecate split
Jaroslav Hajek <highegg@gmail.com>
parents: 8442
diff changeset
141 retval = char (strtrim (strsplit (tmp, "\n")));
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
142 else
4229
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
143 if (nargin == 2)
5443
ec8c33dcd1bf [project @ 2005-09-08 01:40:57 by jwe]
jwe
parents: 5355
diff changeset
144 if (ischar (arg))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
145 fmt = arg;
4229
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
146 else
13279
984359717d71 Use common code idiom for checking whether a double value is an integer.
Rik <octave@nomad.inbox5.com>
parents: 12676
diff changeset
147 if (isnumeric (x) && x == fix (x) && abs (x) < (10 .^ arg))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
148 fmt = sprintf ("%%%dd ", arg);
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
149 else
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
150 fmt = sprintf ("%%%d.%dg", arg+7, arg);
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
151 endif
4229
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
152 endif
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
153 else
13279
984359717d71 Use common code idiom for checking whether a double value is an integer.
Rik <octave@nomad.inbox5.com>
parents: 12676
diff changeset
154 if (isnumeric (x) && x == fix (x) && abs (x) < 1e10)
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
155 if (max (abs (x(:))) == 0)
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
156 dgt = 2;
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
157 else
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
158 dgt = floor (log10 (max (abs(x(:))))) + (min (real (x(:))) < 0) + 2;
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
159 endif
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
160 if (length (abs (x) == x) > 0)
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
161 fmt = sprintf ("%%%dg ", dgt);
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
162 else
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
163 fmt = sprintf ("%%%dd ", dgt);
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
164 endif
4691
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents: 4295
diff changeset
165 elseif (isscalar (x))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
166 fmt = "%11.5g";
4295
fea24da316a2 [project @ 2003-01-11 04:23:24 by jwe]
jwe
parents: 4229
diff changeset
167 else
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
168 fmt = "%11.5g";
4295
fea24da316a2 [project @ 2003-01-11 04:23:24 by jwe]
jwe
parents: 4229
diff changeset
169 endif
4229
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
170 endif
7540
3422f39573b1 strcat.m: Matlab compatibility, with cstrcat.m replacing conventional strcat.m.
Ben Abbott <bpabbott@mac.com>
parents: 7411
diff changeset
171 fmt = cstrcat (deblank (repmat (fmt, 1, columns (x))), "\n");
4914
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4911
diff changeset
172 nd = ndims (x);
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4911
diff changeset
173 tmp = sprintf (fmt, permute (x, [2, 1, 3:nd]));
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
174 tmp(length (tmp)) = "";
8893
937b58380b6a num2str.m: Trivial bug fix. Recent switch from split() to strsplit() produced cells rather than character data.
Ben Abbott <bpabbott@mac.com>
parents: 8886
diff changeset
175 retval = strtrim (char (strsplit (tmp, "\n")));
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
176 endif
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
177
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
178 endfunction
7411
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7208
diff changeset
179
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7208
diff changeset
180
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
181 %!assert (num2str (123), "123")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
182 %!assert (num2str (1.23), "1.23")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
183 %!assert (num2str (123.456, 4), "123.5")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
184 %!assert (num2str ([1, 1.34; 3, 3.56], "%5.1f"), ["1.0 1.3"; "3.0 3.6"])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
185 %!assert (num2str (1.234 + 27.3i), "1.234+27.3i")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
186
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
187 %!error num2str ()
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
188 %!error num2str (1, 2, 3)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
189