Mercurial > hg > octave-nkf
annotate scripts/strings/mat2str.m @ 10793:be55736a0783
Grammarcheck the documentation from m-files.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Sun, 18 Jul 2010 20:35:16 -0700 |
| parents | 58604c45ca74 |
| children | 571bfa4fc295 |
| rev | line source |
|---|---|
| 8920 | 1 ## Copyright (C) 2002, 2006, 2007, 2008, 2009 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}) |
| 5837 | 21 ## @deftypefnx {Function File} {@var{s} =} mat2str (@dots{}, 'class') |
| 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 | 24 ## returns values that are suitable for the use of the @code{eval} |
| 25 ## function. | |
| 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 | 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 | 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 | 32 ## |
| 33 ## If the argument 'class' is given, then the class of @var{x} is | |
| 34 ## included in the string in such a way that the eval will result in the | |
| 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]) |
|
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 | 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 | 47 ## @end group |
| 48 ## @end example | |
| 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 | 51 ## @end deftypefn |
| 52 | |
| 7016 | 53 ## Author: Rolf Fabian <fabian@tu-cottbus.de> |
| 54 | |
| 5838 | 55 function s = mat2str (x, n, cls) |
| 5837 | 56 |
| 5838 | 57 if (nargin < 2 || isempty (n)) |
| 58 ## Default precision | |
| 59 n = 17; | |
| 5837 | 60 endif |
| 61 | |
| 62 if (nargin < 3) | |
| 5838 | 63 if (ischar (n)) |
| 5837 | 64 cls = n; |
| 65 n = 17; | |
| 66 else | |
| 5838 | 67 cls = ""; |
| 5837 | 68 endif |
| 69 endif | |
| 70 | |
| 5838 | 71 if (nargin < 1 || nargin > 3 || ! isnumeric (x)) |
| 72 print_usage (); | |
| 5837 | 73 endif |
| 74 | |
| 75 if (ndims (x) > 2) | |
| 5838 | 76 error ("mat2str: X must be two dimensional"); |
| 5837 | 77 endif |
| 78 | |
|
7812
c25094267486
strings/mat2str.m: Change is_complex to iscomplex, add tests, add missing ;
kimhanse@gmail.com
parents:
7017
diff
changeset
|
79 x_iscomplex = iscomplex (x); |
| 5838 | 80 |
|
7812
c25094267486
strings/mat2str.m: Change is_complex to iscomplex, add tests, add missing ;
kimhanse@gmail.com
parents:
7017
diff
changeset
|
81 if (! x_iscomplex) |
| 5838 | 82 fmt = sprintf ("%%.%dg", n(1)); |
| 5837 | 83 else |
| 8507 | 84 if (length (n) == 1) |
| 5837 | 85 n = [n, n]; |
| 86 endif | |
| 5838 | 87 fmt = sprintf ("%%.%dg%%+.%dgi", n(1), n(2)); |
| 5837 | 88 endif |
| 89 | |
| 5838 | 90 nel = numel (x); |
| 5837 | 91 |
| 5838 | 92 if (nel == 0) |
| 93 ## Empty, only print brackets | |
| 5837 | 94 s = "[]"; |
| 5838 | 95 elseif (nel == 1) |
| 96 ## Scalar X, don't print brackets | |
|
7812
c25094267486
strings/mat2str.m: Change is_complex to iscomplex, add tests, add missing ;
kimhanse@gmail.com
parents:
7017
diff
changeset
|
97 if (! x_iscomplex) |
| 5838 | 98 s = sprintf (fmt, x); |
| 5837 | 99 else |
| 5838 | 100 s = sprintf (fmt, real (x), imag (x)); |
| 5837 | 101 endif |
| 5838 | 102 else |
| 103 ## Non-scalar X, print brackets | |
| 104 fmt = [fmt, ","]; | |
|
7812
c25094267486
strings/mat2str.m: Change is_complex to iscomplex, add tests, add missing ;
kimhanse@gmail.com
parents:
7017
diff
changeset
|
105 if (! x_iscomplex) |
| 5838 | 106 s = sprintf (fmt, x.'); |
| 5837 | 107 else |
|
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(:))']); |
| 5837 | 110 endif |
| 111 | |
| 112 s = ["[", s]; | |
| 5838 | 113 s(end) = "]"; |
| 114 ind = find (s == ","); | |
| 5946 | 115 nc = columns (x); |
| 5838 | 116 s(ind(nc:nc:end)) = ";"; |
| 5837 | 117 endif |
| 118 | |
| 119 if (strcmp ("class", cls)) | |
|
7812
c25094267486
strings/mat2str.m: Change is_complex to iscomplex, add tests, add missing ;
kimhanse@gmail.com
parents:
7017
diff
changeset
|
120 s = [class(x), "(", s, ")"]; |
| 5837 | 121 endif |
| 122 endfunction | |
|
7812
c25094267486
strings/mat2str.m: Change is_complex to iscomplex, add tests, add missing ;
kimhanse@gmail.com
parents:
7017
diff
changeset
|
123 |
|
c25094267486
strings/mat2str.m: Change is_complex to iscomplex, add tests, add missing ;
kimhanse@gmail.com
parents:
7017
diff
changeset
|
124 %!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
|
125 %!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
|
126 %!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
|
127 |