Mercurial > hg > octave-nkf
annotate scripts/strings/mat2str.m @ 13180:c215352ddb4f
mat2str.m: Use more modern code syntax for function
* mat2str.m: Put input validation first in function.
Add new tests. Update docstring.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Tue, 20 Sep 2011 16:42:37 -0700 |
parents | 708186085e0d |
children | da56d27164fe |
rev | line source |
---|---|
11523 | 1 ## Copyright (C) 2002-2011 Rolf Fabian |
5837 | 2 ## |
3 ## This file is part of Octave. | |
4 ## | |
5 ## Octave is free software; you can redistribute it and/or modify it | |
6 ## under the terms of the GNU General Public License as published by | |
7016 | 7 ## the Free Software Foundation; either version 3 of the License, or (at |
8 ## your option) any later version. | |
5837 | 9 ## |
10 ## Octave is distributed in the hope that it will be useful, but | |
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 ## General Public License for more details. | |
14 ## | |
15 ## You should have received a copy of the GNU General Public License | |
7016 | 16 ## along with Octave; see the file COPYING. If not, see |
17 ## <http://www.gnu.org/licenses/>. | |
5837 | 18 |
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") |
9036
58604c45ca74
Cleanup of data types related documentation
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
22 ## Format real/complex numerical matrices as strings. This function |
5837 | 23 ## returns values that are suitable for the use of the @code{eval} |
24 ## function. | |
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 | 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 | 31 ## |
13180
c215352ddb4f
mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents:
12611
diff
changeset
|
32 ## If the argument "class" is given, then the class of @var{x} is |
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 | 34 ## construction of a matrix of the same class. |
35 ## | |
36 ## @example | |
37 ## @group | |
8507 | 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 | 41 ## 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
|
42 ## @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
|
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") |
8442
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7812
diff
changeset
|
45 ## @result{} "int16([1,-1])" |
5837 | 46 ## @end group |
47 ## @end example | |
48 ## | |
8442
502e58a0d44f
Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7812
diff
changeset
|
49 ## @seealso{sprintf, num2str, int2str} |
5837 | 50 ## @end deftypefn |
51 | |
7016 | 52 ## Author: Rolf Fabian <fabian@tu-cottbus.de> |
53 | |
5838 | 54 function s = mat2str (x, n, cls) |
5837 | 55 |
13180
c215352ddb4f
mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents:
12611
diff
changeset
|
56 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
|
57 print_usage (); |
c215352ddb4f
mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents:
12611
diff
changeset
|
58 endif |
c215352ddb4f
mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents:
12611
diff
changeset
|
59 |
c215352ddb4f
mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents:
12611
diff
changeset
|
60 if (ndims (x) > 2) |
c215352ddb4f
mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents:
12611
diff
changeset
|
61 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
|
62 endif |
c215352ddb4f
mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents:
12611
diff
changeset
|
63 |
5838 | 64 if (nargin < 2 || isempty (n)) |
13180
c215352ddb4f
mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents:
12611
diff
changeset
|
65 n = 15; # Default precision |
5837 | 66 endif |
67 | |
68 if (nargin < 3) | |
5838 | 69 if (ischar (n)) |
5837 | 70 cls = n; |
12611
708186085e0d
mat2str.m: Limit the number of digits to one less than available for double.
Patrick Häcker <magicmuscleman>
parents:
11587
diff
changeset
|
71 n = 15; |
5837 | 72 else |
5838 | 73 cls = ""; |
5837 | 74 endif |
75 endif | |
76 | |
11485
571bfa4fc295
mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents:
10793
diff
changeset
|
77 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
|
78 x_iscomplex = iscomplex (x); |
5838 | 79 |
11485
571bfa4fc295
mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents:
10793
diff
changeset
|
80 if (x_iscomplex) |
8507 | 81 if (length (n) == 1) |
5837 | 82 n = [n, n]; |
83 endif | |
5838 | 84 fmt = sprintf ("%%.%dg%%+.%dgi", n(1), n(2)); |
11485
571bfa4fc295
mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents:
10793
diff
changeset
|
85 elseif (x_islogical) |
571bfa4fc295
mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents:
10793
diff
changeset
|
86 v = {"false", "true"}; |
571bfa4fc295
mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents:
10793
diff
changeset
|
87 fmt = "%s"; |
571bfa4fc295
mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents:
10793
diff
changeset
|
88 else |
571bfa4fc295
mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents:
10793
diff
changeset
|
89 fmt = sprintf ("%%.%dg", n(1)); |
5837 | 90 endif |
91 | |
5838 | 92 nel = numel (x); |
5837 | 93 |
5838 | 94 if (nel == 0) |
95 ## Empty, only print brackets | |
5837 | 96 s = "[]"; |
5838 | 97 elseif (nel == 1) |
98 ## Scalar X, don't print brackets | |
11485
571bfa4fc295
mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents:
10793
diff
changeset
|
99 if (x_iscomplex) |
571bfa4fc295
mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents:
10793
diff
changeset
|
100 s = sprintf (fmt, real (x), imag (x)); |
571bfa4fc295
mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents:
10793
diff
changeset
|
101 elseif (x_islogical) |
571bfa4fc295
mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents:
10793
diff
changeset
|
102 s = v{x+1}; |
571bfa4fc295
mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents:
10793
diff
changeset
|
103 else |
5838 | 104 s = sprintf (fmt, x); |
5837 | 105 endif |
5838 | 106 else |
107 ## Non-scalar X, print brackets | |
11485
571bfa4fc295
mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents:
10793
diff
changeset
|
108 fmt = cstrcat (fmt, ","); |
571bfa4fc295
mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents:
10793
diff
changeset
|
109 if (x_iscomplex) |
7812
c25094267486
strings/mat2str.m: Change is_complex to iscomplex, add tests, add missing ;
kimhanse@gmail.com
parents:
7017
diff
changeset
|
110 t = x.'; |
c25094267486
strings/mat2str.m: Change is_complex to iscomplex, add tests, add missing ;
kimhanse@gmail.com
parents:
7017
diff
changeset
|
111 s = sprintf (fmt, [real(t(:))'; imag(t(:))']); |
11485
571bfa4fc295
mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents:
10793
diff
changeset
|
112 elseif (x_islogical) |
571bfa4fc295
mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents:
10793
diff
changeset
|
113 t = v(x+1); |
571bfa4fc295
mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents:
10793
diff
changeset
|
114 s = cstrcat (sprintf (fmt, t{:})); |
571bfa4fc295
mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents:
10793
diff
changeset
|
115 else |
571bfa4fc295
mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents:
10793
diff
changeset
|
116 s = sprintf (fmt, x.'); |
5837 | 117 endif |
118 | |
11485
571bfa4fc295
mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents:
10793
diff
changeset
|
119 s = cstrcat ("[", s); |
5838 | 120 s(end) = "]"; |
13180
c215352ddb4f
mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents:
12611
diff
changeset
|
121 idx = find (s == ","); |
5946 | 122 nc = columns (x); |
13180
c215352ddb4f
mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents:
12611
diff
changeset
|
123 s(idx(nc:nc:end)) = ";"; |
5837 | 124 endif |
125 | |
126 if (strcmp ("class", cls)) | |
13180
c215352ddb4f
mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents:
12611
diff
changeset
|
127 s = cstrcat (class (x), "(", s, ")"); |
5837 | 128 endif |
13180
c215352ddb4f
mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents:
12611
diff
changeset
|
129 |
5837 | 130 endfunction |
7812
c25094267486
strings/mat2str.m: Change is_complex to iscomplex, add tests, add missing ;
kimhanse@gmail.com
parents:
7017
diff
changeset
|
131 |
13180
c215352ddb4f
mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents:
12611
diff
changeset
|
132 |
c215352ddb4f
mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents:
12611
diff
changeset
|
133 %!assert (mat2str (0.7), "0.7"); |
c215352ddb4f
mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents:
12611
diff
changeset
|
134 %!assert (mat2str (pi), "3.14159265358979"); |
c215352ddb4f
mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents:
12611
diff
changeset
|
135 %!assert (mat2str (pi, 5), "3.1416"); |
c215352ddb4f
mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents:
12611
diff
changeset
|
136 %!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
|
137 %!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
|
138 %!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
|
139 %!assert (mat2str (int16 ([1 -1]), 'class'), "int16([1,-1])") |
11485
571bfa4fc295
mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents:
10793
diff
changeset
|
140 %!assert (mat2str (true), "true"); |
571bfa4fc295
mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents:
10793
diff
changeset
|
141 %!assert (mat2str (false), "false"); |
571bfa4fc295
mat2str: handle logical arguments
John W. Eaton <jwe@octave.org>
parents:
10793
diff
changeset
|
142 %!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
|
143 |
c215352ddb4f
mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents:
12611
diff
changeset
|
144 %% Test input validation |
c215352ddb4f
mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents:
12611
diff
changeset
|
145 %!error mat2str () |
c215352ddb4f
mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents:
12611
diff
changeset
|
146 %!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
|
147 %!error mat2str (["Hello"]) |
c215352ddb4f
mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents:
12611
diff
changeset
|
148 %!error mat2str (ones(3,3,2)) |
c215352ddb4f
mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents:
12611
diff
changeset
|
149 |