Mercurial > hg > octave-nkf

annotate scripts/strings/mat2str.m @ 11485:571bfa4fc295

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mat2str: handle logical arguments
author John W. Eaton <jwe@octave.org>
date Wed, 12 Jan 2011 01:15:23 -0500
parents be55736a0783
children fd0a3ac60b0e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8920
eb63fbe60fab update copyright notices
John W. Eaton <jwe@octave.org>
parents: 8507
diff changeset
1 ## Copyright (C) 2002, 2006, 2007, 2008, 2009 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})
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
21 ## @deftypefnx {Function File} {@var{s} =} mat2str (@dots{}, 'class')
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
22 ##
9036
58604c45ca74 Cleanup of data types related documentation
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
23 ## Format real/complex numerical matrices as strings. This function
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
24 ## returns values that are suitable for the use of the @code{eval}
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
25 ## function.
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
26 ##
9036
58604c45ca74 Cleanup of data types related documentation
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
27 ## 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
28 ## scalar then both real and imaginary parts of the matrix are printed
9036
58604c45ca74 Cleanup of data types related documentation
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
29 ## to the same precision. Otherwise @code{@var{n} (1)} defines the
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
30 ## precision of the real part and @code{@var{n} (2)} defines the
9036
58604c45ca74 Cleanup of data types related documentation
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
31 ## precision of the imaginary part. The default for @var{n} is 17.
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
32 ##
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
33 ## If the argument 'class' is given, then the class of @var{x} is
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
34 ## included in the string in such a way that the eval will result in the
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])
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7812
diff changeset
43 ## @result{} "[-0.3333+0i,0+0.14i;0.3333+0i,-0-0.14i]"
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7812
diff changeset
44 ##
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8442
diff changeset
45 ## mat2str (int16([1 -1]), 'class')
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7812
diff changeset
46 ## @result{} "int16([1,-1])"
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
47 ## @end group
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
48 ## @end example
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
49 ##
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7812
diff changeset
50 ## @seealso{sprintf, num2str, int2str}
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
51 ## @end deftypefn
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
52
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
53 ## Author: Rolf Fabian <fabian@tu-cottbus.de>
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
54
5838
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
55 function s = mat2str (x, n, cls)
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
56
5838
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
57 if (nargin < 2 || isempty (n))
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
58 ## Default precision
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
59 n = 17;
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
60 endif
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
61
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
62 if (nargin < 3)
5838
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
63 if (ischar (n))
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
64 cls = n;
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
65 n = 17;
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
66 else
5838
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
67 cls = "";
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
68 endif
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
69 endif
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
70
11485
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
71 if (nargin < 1 || nargin > 3 || ! (isnumeric (x) || islogical (x)))
5838
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
72 print_usage ();
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
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
75 if (ndims (x) > 2)
5838
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
76 error ("mat2str: X must be two dimensional");
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
77 endif
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
78
11485
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
79 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
80 x_iscomplex = iscomplex (x);
5838
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
81
11485
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
82 if (x_iscomplex)
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 8442
diff changeset
83 if (length (n) == 1)
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
84 n = [n, n];
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
85 endif
5838
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
86 fmt = sprintf ("%%.%dg%%+.%dgi", n(1), n(2));
11485
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
87 elseif (x_islogical)
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
88 v = {"false", "true"};
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
89 fmt = "%s";
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
90 else
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
91 fmt = sprintf ("%%.%dg", n(1));
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
92 endif
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
93
5838
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
94 nel = numel (x);
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
95
5838
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
96 if (nel == 0)
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
97 ## Empty, only print brackets
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
98 s = "[]";
5838
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
99 elseif (nel == 1)
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
100 ## Scalar X, don't print brackets
11485
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
101 if (x_iscomplex)
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
102 s = sprintf (fmt, real (x), imag (x));
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
103 elseif (x_islogical)
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
104 s = v{x+1};
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
105 else
5838
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
106 s = sprintf (fmt, x);
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
107 endif
5838
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
108 else
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
109 ## Non-scalar X, print brackets
11485
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
110 fmt = cstrcat (fmt, ",");
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
111 if (x_iscomplex)
7812
c25094267486 strings/mat2str.m: Change is_complex to iscomplex, add tests, add missing ;
kimhanse@gmail.com
parents: 7017
diff changeset
112 t = x.';
c25094267486 strings/mat2str.m: Change is_complex to iscomplex, add tests, add missing ;
kimhanse@gmail.com
parents: 7017
diff changeset
113 s = sprintf (fmt, [real(t(:))'; imag(t(:))']);
11485
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
114 elseif (x_islogical)
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
115 t = v(x+1);
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
116 s = cstrcat (sprintf (fmt, t{:}));
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
117 else
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
118 s = sprintf (fmt, x.');
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
119 endif
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
120
11485
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
121 s = cstrcat ("[", s);
5838
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
122 s(end) = "]";
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
123 ind = find (s == ",");
5946
4b433225128d [project @ 2006-08-21 15:54:50 by jwe]
jwe
parents: 5838
diff changeset
124 nc = columns (x);
5838
376e02b2ce70 [project @ 2006-06-01 20:23:53 by jwe]
jwe
parents: 5837
diff changeset
125 s(ind(nc:nc:end)) = ";";
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
126 endif
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
127
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
128 if (strcmp ("class", cls))
11485
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
129 s = cstrcat (class(x), "(", s, ")");
5837
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
130 endif
55404f3b0da1 [project @ 2006-06-01 19:05:31 by jwe]
jwe
parents:
diff changeset
131 endfunction
7812
c25094267486 strings/mat2str.m: Change is_complex to iscomplex, add tests, add missing ;
kimhanse@gmail.com
parents: 7017
diff changeset
132
c25094267486 strings/mat2str.m: Change is_complex to iscomplex, add tests, add missing ;
kimhanse@gmail.com
parents: 7017
diff changeset
133 %!assert (mat2str ([-1/3 + i/7; 1/3 - i/7], [4 2]), "[-0.3333+0.14i;0.3333-0.14i]")
c25094267486 strings/mat2str.m: Change is_complex to iscomplex, add tests, add missing ;
kimhanse@gmail.com
parents: 7017
diff changeset
134 %!assert (mat2str ([-1/3 +i/7; 1/3 -i/7], [4 2]), "[-0.3333+0i,0+0.14i;0.3333+0i,-0-0.14i]")
c25094267486 strings/mat2str.m: Change is_complex to iscomplex, add tests, add missing ;
kimhanse@gmail.com
parents: 7017
diff changeset
135 %!assert (mat2str (int16 ([1 -1]), 'class'), "int16([1,-1])")
c25094267486 strings/mat2str.m: Change is_complex to iscomplex, add tests, add missing ;
kimhanse@gmail.com
parents: 7017
diff changeset
136
11485
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
137 %!assert (mat2str (true), "true");
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
138 %!assert (mat2str (false), "false");
571bfa4fc295 mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
139 %!assert (mat2str (logical (eye (2))), "[true,false;false,true]");