Mercurial > hg > octave-nkf
annotate scripts/strings/mat2str.m @ 20737:2d9ec16fa960
Print error, rather than aborting, if mex function mxIsFromGlobalWS is used (bug #46070).
* mex.cc (mxIsFromGlobalWS): Call mexErrMsgTxt rather than abort() in function.
author | Rik <rik@octave.org> |
---|---|
date | Tue, 29 Sep 2015 12:00:11 -0700 |
parents | aa36fb998a4d |
children |
rev | line source |
---|---|
19898
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
19790
diff
changeset
|
1 ## Copyright (C) 2002-2015 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") |
20374
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20038
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:
20038
diff
changeset
|
23 ## |
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20038
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 | 26 ## |
20374
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20038
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:
20038
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:
20038
diff
changeset
|
29 ## precision. Otherwise @code{@var{n}(1)} defines the precision of the real |
20391
aa36fb998a4d
maint: Remove unnecessary whitespace at end of lines.
Rik <rik@octave.org>
parents:
20374
diff
changeset
|
30 ## part and @code{@var{n}(2)} defines the precision of the imaginary part. |
20374
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
20038
diff
changeset
|
31 ## The default for @var{n} is 15. |
5837 | 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 | 35 ## construction of a matrix of the same class. |
36 ## | |
37 ## @example | |
38 ## @group | |
8507 | 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 | 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 | 53 ## @end group |
54 ## @end example | |
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 | 57 ## @end deftypefn |
58 | |
7016 | 59 ## Author: Rolf Fabian <fabian@tu-cottbus.de> |
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 | 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 |
19930
5f2c0ca0ef51
Ensure that numbers passed to integer *printf format codes are integers (bug #44245).
Rik <rik@octave.org>
parents:
19898
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:
19898
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:
19898
diff
changeset
|
76 else |
5f2c0ca0ef51
Ensure that numbers passed to integer *printf format codes are integers (bug #44245).
Rik <rik@octave.org>
parents:
19898
diff
changeset
|
77 n = fix (n); |
5837 | 78 endif |
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 | 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 | 85 n = [n, n]; |
86 endif | |
5838 | 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 | 93 endif |
94 | |
5838 | 95 nel = numel (x); |
5837 | 96 |
5838 | 97 if (nel == 0) |
98 ## Empty, only print brackets | |
5837 | 99 s = "[]"; |
5838 | 100 elseif (nel == 1) |
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 | 107 s = sprintf (fmt, x); |
5837 | 108 endif |
5838 | 109 else |
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 | 120 endif |
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 | 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 | 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 | 127 endif |
128 | |
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 | 131 endif |
13180
c215352ddb4f
mat2str.m: Use more modern code syntax for function
Rik <octave@nomad.inbox5.com>
parents:
12611
diff
changeset
|
132 |
5837 | 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 |
20038
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19930
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)) |
19930
5f2c0ca0ef51
Ensure that numbers passed to integer *printf format codes are integers (bug #44245).
Rik <rik@octave.org>
parents:
19898
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 |