annotate scripts/strings/mat2str.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 5d3a684236b0
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: 13314
diff changeset
1 ## Copyright (C) 2002-2012 Rolf Fabian
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
2 ##
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
4 ##
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
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: 7001
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: 7001
diff changeset
8 ## your option) any later version.
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
9 ##
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
14 ##
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
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: 7001
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: 7001
diff changeset
17 ## <http://www.gnu.org/licenses/>.
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
18
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 9036
diff changeset
20 ## @deftypefn {Function File} {@var{s} =} mat2str (@var{x}, @var{n})
13180
c215352ddb4f mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents: 12611
diff changeset
21 ## @deftypefnx {Function File} {@var{s} =} mat2str (@var{x}, @var{n}, "class")
13314
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
22 ## Format real, complex, and logical matrices as strings. The
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
23 ## returned string may be used to reconstruct the original matrix by using
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
24 ## the @code{eval} function.
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
25 ##
9036
58604c45ca74 Cleanup of data types related documentation
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
26 ## The precision of the values is given by @var{n}. If @var{n} is a
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
27 ## scalar then both real and imaginary parts of the matrix are printed
13180
c215352ddb4f mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents: 12611
diff changeset
28 ## to the same precision. Otherwise @code{@var{n}(1)} defines the
c215352ddb4f mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents: 12611
diff changeset
29 ## precision of the real part and @code{@var{n}(2)} defines the
12611
708186085e0d mat2str.m: Limit the number of digits to one less than available for double.
Patrick Häcker <magicmuscleman>
parents: 11587
diff changeset
30 ## precision of the imaginary part. The default for @var{n} is 15.
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
31 ##
13314
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
32 ## If the argument "class" is given then the class of @var{x} is
13180
c215352ddb4f mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents: 12611
diff changeset
33 ## included in the string in such a way that @code{eval} will result in the
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
34 ## construction of a matrix of the same class.
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
35 ##
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
36 ## @example
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
37 ## @group
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8442
diff changeset
38 ## mat2str ([ -1/3 + i/7; 1/3 - i/7 ], [4 2])
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7812
diff changeset
39 ## @result{} "[-0.3333+0.14i;0.3333-0.14i]"
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7812
diff changeset
40 ##
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8442
diff changeset
41 ## mat2str ([ -1/3 +i/7; 1/3 -i/7 ], [4 2])
13314
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
42 ## @result{} "[-0.3333+0i 0+0.14i;0.3333+0i -0-0.14i]"
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7812
diff changeset
43 ##
13180
c215352ddb4f mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents: 12611
diff changeset
44 ## mat2str (int16([1 -1]), "class")
13314
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
45 ## @result{} "int16([1 -1])"
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
46 ##
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
47 ## mat2str (logical (eye (2)))
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
48 ## @result{} "[true false;false true]"
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
49 ##
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
50 ## isequal (x, eval (mat2str (x)))
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
51 ## @result{} 1
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
52 ## @end group
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
53 ## @end example
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
54 ##
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7812
diff changeset
55 ## @seealso{sprintf, num2str, int2str}
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
56 ## @end deftypefn
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
57
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
58 ## Author: Rolf Fabian <fabian@tu-cottbus.de>
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
59
13314
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
60 function s = mat2str (x, n = 15, cls = "")
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
61
13180
c215352ddb4f mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents: 12611
diff changeset
62 if (nargin < 1 || nargin > 3 || ! (isnumeric (x) || islogical (x)))
c215352ddb4f mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents: 12611
diff changeset
63 print_usage ();
13314
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
64 elseif (ndims (x) > 2)
13180
c215352ddb4f mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents: 12611
diff changeset
65 error ("mat2str: X must be two dimensional");
c215352ddb4f mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents: 12611
diff changeset
66 endif
c215352ddb4f mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents: 12611
diff changeset
67
13314
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
68 if (nargin == 2 && ischar (n))
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
69 cls = n;
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
70 n = 15;
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
71 elseif (isempty (n))
13180
c215352ddb4f mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents: 12611
diff changeset
72 n = 15; # Default precision
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
73 endif
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
74
11485
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
75 x_islogical = islogical (x);
7812
c25094267486 strings/mat2str.m: Change is_complex to iscomplex, add tests, add missing ;
kimhanse@gmail.com
parents: 7017
diff changeset
76 x_iscomplex = iscomplex (x);
5838
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
77
11485
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
78 if (x_iscomplex)
13314
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
79 if (isscalar (n))
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
80 n = [n, n];
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
81 endif
5838
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
82 fmt = sprintf ("%%.%dg%%+.%dgi", n(1), n(2));
11485
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
83 elseif (x_islogical)
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
84 v = {"false", "true"};
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
85 fmt = "%s";
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
86 else
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
87 fmt = sprintf ("%%.%dg", n(1));
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
88 endif
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
89
5838
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
90 nel = numel (x);
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
91
5838
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
92 if (nel == 0)
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
93 ## Empty, only print brackets
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
94 s = "[]";
5838
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
95 elseif (nel == 1)
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
96 ## Scalar X, don't print brackets
11485
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
97 if (x_iscomplex)
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
98 s = sprintf (fmt, real (x), imag (x));
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
99 elseif (x_islogical)
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
100 s = v{x+1};
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
101 else
5838
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
102 s = sprintf (fmt, x);
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
103 endif
5838
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
104 else
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
105 ## Non-scalar X, print brackets
13314
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
106 fmt = cstrcat (fmt, " ");
11485
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
107 if (x_iscomplex)
7812
c25094267486 strings/mat2str.m: Change is_complex to iscomplex, add tests, add missing ;
kimhanse@gmail.com
parents: 7017
diff changeset
108 t = x.';
c25094267486 strings/mat2str.m: Change is_complex to iscomplex, add tests, add missing ;
kimhanse@gmail.com
parents: 7017
diff changeset
109 s = sprintf (fmt, [real(t(:))'; imag(t(:))']);
11485
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
110 elseif (x_islogical)
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
111 t = v(x+1);
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
112 s = cstrcat (sprintf (fmt, t{:}));
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
113 else
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
114 s = sprintf (fmt, x.');
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
115 endif
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
116
11485
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
117 s = cstrcat ("[", s);
5838
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
118 s(end) = "]";
13314
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
119 idx = strfind (s, " ");
5946
4b433225128d [project @ 2006-08-21 15:54:50 by jwe]
jwe
parents: 5838
diff changeset
120 nc = columns (x);
13180
c215352ddb4f mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents: 12611
diff changeset
121 s(idx(nc:nc:end)) = ";";
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
122 endif
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
123
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
124 if (strcmp ("class", cls))
13180
c215352ddb4f mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents: 12611
diff changeset
125 s = cstrcat (class (x), "(", s, ")");
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
126 endif
13180
c215352ddb4f mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents: 12611
diff changeset
127
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
128 endfunction
7812
c25094267486 strings/mat2str.m: Change is_complex to iscomplex, add tests, add missing ;
kimhanse@gmail.com
parents: 7017
diff changeset
129
13180
c215352ddb4f mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents: 12611
diff changeset
130
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
131 %!assert (mat2str (0.7), "0.7")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
132 %!assert (mat2str (pi), "3.14159265358979")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
133 %!assert (mat2str (pi, 5), "3.1416")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
134 %!assert (mat2str (single (pi), 5, "class"), "single(3.1416)")
7812
c25094267486 strings/mat2str.m: Change is_complex to iscomplex, add tests, add missing ;
kimhanse@gmail.com
parents: 7017
diff changeset
135 %!assert (mat2str ([-1/3 + i/7; 1/3 - i/7], [4 2]), "[-0.3333+0.14i;0.3333-0.14i]")
13314
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
136 %!assert (mat2str ([-1/3 +i/7; 1/3 -i/7], [4 2]), "[-0.3333+0i 0+0.14i;0.3333+0i -0-0.14i]")
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
137 %!assert (mat2str (int16 ([1 -1]), "class"), "int16([1 -1])")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
138 %!assert (mat2str (true), "true")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
139 %!assert (mat2str (false), "false")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
140 %!assert (mat2str (logical (eye (2))), "[true false;false true]")
13180
c215352ddb4f mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents: 12611
diff changeset
141
c215352ddb4f mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents: 12611
diff changeset
142 %% Test input validation
c215352ddb4f mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents: 12611
diff changeset
143 %!error mat2str ()
c215352ddb4f mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents: 12611
diff changeset
144 %!error mat2str (1,2,3,4)
c215352ddb4f mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents: 12611
diff changeset
145 %!error mat2str (["Hello"])
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
146 %!error <X must be two dimensional> mat2str (ones(3,3,2))
13180
c215352ddb4f mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents: 12611
diff changeset
147