annotate scripts/strings/mat2str.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 9fc020886ae9
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19697
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19593
diff changeset
1 ## Copyright (C) 2002-2015 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")
20164
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
22 ## Format real, complex, and logical matrices as strings.
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
23 ##
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
24 ## The returned string may be used to reconstruct the original matrix by using
13314
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
25 ## the @code{eval} function.
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
26 ##
20164
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
27 ## The precision of the values is given by @var{n}. If @var{n} is a scalar
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
28 ## then both real and imaginary parts of the matrix are printed to the same
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
29 ## precision. Otherwise @code{@var{n}(1)} defines the precision of the real
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
30 ## part and @code{@var{n}(2)} defines the precision of the imaginary part.
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
31 ## The default for @var{n} is 15.
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
32 ##
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16994
diff changeset
33 ## If the argument @qcode{"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
34 ## 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
35 ## construction of a matrix of the same class.
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
36 ##
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
37 ## @example
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
38 ## @group
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8442
diff changeset
39 ## 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
40 ## @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
41 ##
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8442
diff changeset
42 ## 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
43 ## @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
44 ##
14868
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents: 14363
diff changeset
45 ## 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
46 ## @result{} "int16([1 -1])"
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
47 ##
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
48 ## mat2str (logical (eye (2)))
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
49 ## @result{} "[true false;false true]"
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
50 ##
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
51 ## isequal (x, eval (mat2str (x)))
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
52 ## @result{} 1
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
53 ## @end group
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
54 ## @end example
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
55 ##
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7812
diff changeset
56 ## @seealso{sprintf, num2str, int2str}
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
57 ## @end deftypefn
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
58
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
59 ## Author: Rolf Fabian <fabian@tu-cottbus.de>
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
60
13314
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
61 function s = mat2str (x, n = 15, cls = "")
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
62
13180
c215352ddb4f mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents: 12611
diff changeset
63 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
64 print_usage ();
13314
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
65 elseif (ndims (x) > 2)
13180
c215352ddb4f mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents: 12611
diff changeset
66 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
67 endif
c215352ddb4f mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents: 12611
diff changeset
68
13314
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
69 if (nargin == 2 && ischar (n))
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
70 cls = n;
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
71 n = 15;
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
72 elseif (isempty (n))
13180
c215352ddb4f mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents: 12611
diff changeset
73 n = 15; # Default precision
19725
5f2c0ca0ef51 Ensure that numbers passed to integer *printf format codes are integers (bug #44245).
Rik <rik@octave.org>
parents: 19697
diff changeset
74 elseif (numel (n) > 2)
5f2c0ca0ef51 Ensure that numbers passed to integer *printf format codes are integers (bug #44245).
Rik <rik@octave.org>
parents: 19697
diff changeset
75 error ("mat2str: N must have only 1 or 2 elements");
5f2c0ca0ef51 Ensure that numbers passed to integer *printf format codes are integers (bug #44245).
Rik <rik@octave.org>
parents: 19697
diff changeset
76 else
5f2c0ca0ef51 Ensure that numbers passed to integer *printf format codes are integers (bug #44245).
Rik <rik@octave.org>
parents: 19697
diff changeset
77 n = fix (n);
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
78 endif
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
79
11485
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
80 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
81 x_iscomplex = iscomplex (x);
5838
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
82
11485
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
83 if (x_iscomplex)
13314
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
84 if (isscalar (n))
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
85 n = [n, n];
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
86 endif
5838
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
87 fmt = sprintf ("%%.%dg%%+.%dgi", n(1), n(2));
11485
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
88 elseif (x_islogical)
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
89 v = {"false", "true"};
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
90 fmt = "%s";
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
91 else
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
92 fmt = sprintf ("%%.%dg", n(1));
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
93 endif
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
94
5838
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
95 nel = numel (x);
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
96
5838
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
97 if (nel == 0)
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
98 ## Empty, only print brackets
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
99 s = "[]";
5838
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
100 elseif (nel == 1)
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
101 ## Scalar X, don't print brackets
11485
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
102 if (x_iscomplex)
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
103 s = sprintf (fmt, real (x), imag (x));
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
104 elseif (x_islogical)
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
105 s = v{x+1};
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
106 else
5838
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
107 s = sprintf (fmt, x);
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
108 endif
5838
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
109 else
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
110 ## Non-scalar X, print brackets
16994
333243133364 Use matrix concatenation for strings, rather than cstrcat(), for clarity and performance.
Rik <rik@octave.org>
parents: 14868
diff changeset
111 fmt = [fmt " "];
11485
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
112 if (x_iscomplex)
7812
c25094267486 strings/mat2str.m: Change is_complex to iscomplex, add tests, add missing ;
kimhanse@gmail.com
parents: 7017
diff changeset
113 t = x.';
c25094267486 strings/mat2str.m: Change is_complex to iscomplex, add tests, add missing ;
kimhanse@gmail.com
parents: 7017
diff changeset
114 s = sprintf (fmt, [real(t(:))'; imag(t(:))']);
11485
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
115 elseif (x_islogical)
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
116 t = v(x+1);
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
117 s = cstrcat (sprintf (fmt, t{:}));
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
118 else
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
119 s = sprintf (fmt, x.');
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
120 endif
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
121
16994
333243133364 Use matrix concatenation for strings, rather than cstrcat(), for clarity and performance.
Rik <rik@octave.org>
parents: 14868
diff changeset
122 s = ["[" s];
5838
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
123 s(end) = "]";
13314
da56d27164fe mat2str.m: Tune function for Matlab compatability and speed.
Rik <octave@nomad.inbox5.com>
parents: 13180
diff changeset
124 idx = strfind (s, " ");
5946
4b433225128d [project @ 2006-08-21 15:54:50 by jwe]
jwe
parents: 5838
diff changeset
125 nc = columns (x);
13180
c215352ddb4f mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents: 12611
diff changeset
126 s(idx(nc:nc:end)) = ";";
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
127 endif
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
128
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
129 if (strcmp ("class", cls))
16994
333243133364 Use matrix concatenation for strings, rather than cstrcat(), for clarity and performance.
Rik <rik@octave.org>
parents: 14868
diff changeset
130 s = [class(x) "(" s ")"];
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
131 endif
13180
c215352ddb4f mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents: 12611
diff changeset
132
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
133 endfunction
7812
c25094267486 strings/mat2str.m: Change is_complex to iscomplex, add tests, add missing ;
kimhanse@gmail.com
parents: 7017
diff changeset
134
13180
c215352ddb4f mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents: 12611
diff changeset
135
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
136 %!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
137 %!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
138 %!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
139 %!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
140 %!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
141 %!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
142 %!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
143 %!assert (mat2str (true), "true")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
144 %!assert (mat2str (false), "false")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
145 %!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
146
19833
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19725
diff changeset
147 ## Test input validation
13180
c215352ddb4f mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents: 12611
diff changeset
148 %!error mat2str ()
c215352ddb4f mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents: 12611
diff changeset
149 %!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
150 %!error mat2str (["Hello"])
14868
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents: 14363
diff changeset
151 %!error <X must be two dimensional> mat2str (ones (3,3,2))
19725
5f2c0ca0ef51 Ensure that numbers passed to integer *printf format codes are integers (bug #44245).
Rik <rik@octave.org>
parents: 19697
diff changeset
152 %!error <N must have only 1 or 2 elements> mat2str (ones (3,3), [1 2 3])
13180
c215352ddb4f mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents: 12611
diff changeset
153