annotate scripts/general/num2str.m @ 7208:a730e47fda4d

[project @ 2007-11-28 02:32:41 by jwe]
author jwe
date Wed, 28 Nov 2007 02:32:42 +0000
parents a1dbe9d80eee
children 83a8781b529d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
1 ## Copyright (C) 1993, 1994, 1995, 1996, 1997, 1999, 2000, 2002, 2003,
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
2 ## 2004, 2005, 2006, 2007 John W. Eaton
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
3 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
4 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
5 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
6 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
7 ## 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: 6997
diff changeset
8 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6997
diff changeset
9 ## your option) any later version.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
10 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
11 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
14 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
15 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
16 ## 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: 6997
diff changeset
17 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6997
diff changeset
18 ## <http://www.gnu.org/licenses/>.
245
16a24e76d6e0 [project @ 1993-12-03 02:00:15 by jwe]
jwe
parents: 4
diff changeset
19
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2847
diff changeset
20 ## -*- texinfo -*-
5939
2e86e3601e0f [project @ 2006-08-18 17:40:41 by jwe]
jwe
parents: 5642
diff changeset
21 ## @deftypefn {Function File} {} num2str (@var{n})
4229
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
22 ## @deftypefnx {Function File} {} num2str (@var{x}, @var{precision})
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
23 ## @deftypefnx {Function File} {} num2str (@var{x}, @var{format})
6555
69e864d21c11 [project @ 2007-04-20 18:16:08 by jwe]
jwe
parents: 5947
diff changeset
24 ## Convert a number to a string. This function is not very flexible.
69e864d21c11 [project @ 2007-04-20 18:16:08 by jwe]
jwe
parents: 5947
diff changeset
25 ## For better control over the results, use @code{sprintf}
69e864d21c11 [project @ 2007-04-20 18:16:08 by jwe]
jwe
parents: 5947
diff changeset
26 ## (@pxref{Formatted Output}).
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5443
diff changeset
27 ## @seealso{sprintf, int2str}
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2847
diff changeset
28 ## @end deftypefn
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
29
2314
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
30 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
31
4229
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
32 function retval = num2str (x, arg)
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
33
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
34 if (nargin != 1 && nargin != 2)
5947
009fa69b6182 [project @ 2006-08-21 16:15:20 by jwe]
jwe
parents: 5939
diff changeset
35 print_usage ();
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
36 endif
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
37
5443
ec8c33dcd1bf [project @ 2005-09-08 01:40:57 by jwe]
jwe
parents: 5355
diff changeset
38 if (ischar (x))
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
39 retval = x;
5947
009fa69b6182 [project @ 2006-08-21 16:15:20 by jwe]
jwe
parents: 5939
diff changeset
40 elseif (isempty (x))
009fa69b6182 [project @ 2006-08-21 16:15:20 by jwe]
jwe
parents: 5939
diff changeset
41 retval = "";
009fa69b6182 [project @ 2006-08-21 16:15:20 by jwe]
jwe
parents: 5939
diff changeset
42 elseif (iscomplex (x))
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
43 if (nargin == 2)
5443
ec8c33dcd1bf [project @ 2005-09-08 01:40:57 by jwe]
jwe
parents: 5355
diff changeset
44 if (ischar (arg))
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
45 fmt = strcat (arg, "%-+", arg(2:end), "i");
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
46 else
4919
a1073eef650c [project @ 2004-07-27 15:22:50 by jwe]
jwe
parents: 4918
diff changeset
47 if (isnumeric (x) && round (x) == x && abs (x) < (10 .^ arg))
4918
d2a7208f35d4 [project @ 2004-07-27 15:18:04 by jwe]
jwe
parents: 4914
diff changeset
48 fmt = sprintf ("%%%dd%%-+%ddi ", arg, arg);
d2a7208f35d4 [project @ 2004-07-27 15:18:04 by jwe]
jwe
parents: 4914
diff changeset
49 else
d2a7208f35d4 [project @ 2004-07-27 15:18:04 by jwe]
jwe
parents: 4914
diff changeset
50 fmt = sprintf ("%%%d.%dg%%-+%d.%dgi", arg+7, arg, arg+7, arg);
d2a7208f35d4 [project @ 2004-07-27 15:18:04 by jwe]
jwe
parents: 4914
diff changeset
51 endif
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
52 endif
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
53 else
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
54 ## Setup a suitable format string
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
55 if (isnumeric (x) && round (x) == x && abs (x) < 1e10)
6997
6d0d8d621532 [project @ 2007-10-10 16:41:16 by jwe]
jwe
parents: 6975
diff changeset
56 if (max (abs (real (x(:)))) == 0)
6d0d8d621532 [project @ 2007-10-10 16:41:16 by jwe]
jwe
parents: 6975
diff changeset
57 dgt1 = 2;
6d0d8d621532 [project @ 2007-10-10 16:41:16 by jwe]
jwe
parents: 6975
diff changeset
58 else
6d0d8d621532 [project @ 2007-10-10 16:41:16 by jwe]
jwe
parents: 6975
diff changeset
59 dgt1 = ceil (log10 (max (max (abs (real (x(:)))),
6d0d8d621532 [project @ 2007-10-10 16:41:16 by jwe]
jwe
parents: 6975
diff changeset
60 max (abs (imag (x(:))))))) + 2;
6d0d8d621532 [project @ 2007-10-10 16:41:16 by jwe]
jwe
parents: 6975
diff changeset
61 endif
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
62 dgt2 = dgt1 - (min (real (x(:))) >= 0);
6975
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents: 6555
diff changeset
63
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents: 6555
diff changeset
64 if (length (abs (x) == x) > 0)
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents: 6555
diff changeset
65 fmt = sprintf("%%%dg%%+-%dgi ", dgt2, dgt1);
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents: 6555
diff changeset
66 else
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents: 6555
diff changeset
67 fmt = sprintf("%%%dd%%+-%ddi ", dgt2, dgt1);
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents: 6555
diff changeset
68 endif
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
69 elseif (isscalar (x))
6975
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents: 6555
diff changeset
70 fmt = "%.6g%-+.6gi";
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
71 else
6975
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents: 6555
diff changeset
72 fmt = "%11.6g%-+11.6gi";
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
73 endif
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
74 endif
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
75
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
76 ## Manipulate the complex value to have real values in the odd
4914
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4911
diff changeset
77 ## columns and imaginary values in the even columns.
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
78 sz = size (x);
4914
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4911
diff changeset
79 nc = sz(2);
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
80 nd = ndims (x);
4914
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4911
diff changeset
81 perm = fix ([1:0.5:nc+0.5]);
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4911
diff changeset
82 perm(2:2:2*nc) = perm(2:2:2*nc) + nc;
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
83 idx = cell ();
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
84 for i = 1:nd
7208
a730e47fda4d [project @ 2007-11-28 02:32:41 by jwe]
jwe
parents: 7017
diff changeset
85 idx{i} = 1:sz(i);
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
86 endfor
4914
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4911
diff changeset
87 idx{2} = perm;
7208
a730e47fda4d [project @ 2007-11-28 02:32:41 by jwe]
jwe
parents: 7017
diff changeset
88 x = horzcat (real (x), imag (x));
4914
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4911
diff changeset
89 x = x(idx{:});
5939
2e86e3601e0f [project @ 2006-08-18 17:40:41 by jwe]
jwe
parents: 5642
diff changeset
90
4914
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4911
diff changeset
91 fmt = strcat (deblank (repmat (fmt, 1, nc)), "\n");
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4911
diff changeset
92 tmp = sprintf (fmt, permute (x, [2, 1, 3:nd]));
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
93
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
94 ## Put the "i"'s where they are supposed to be.
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
95 while (true)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
96 tmp2 = strrep (tmp, " i\n", "i\n");
4914
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4911
diff changeset
97 if (length (tmp) == length (tmp2))
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
98 break;
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
99 else
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
100 tmp = tmp2;
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
101 endif
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
102 endwhile
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
103 while (true)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
104 tmp2 = strrep (tmp, " i", "i ");
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
105 if (tmp == tmp2)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
106 break;
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
107 else
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
108 tmp = tmp2;
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
109 endif
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
110 endwhile
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
111
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
112 tmp(length (tmp)) = "";
6975
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents: 6555
diff changeset
113 retval = strtrim (split (tmp, "\n"));
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
114 else
4229
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
115 if (nargin == 2)
5443
ec8c33dcd1bf [project @ 2005-09-08 01:40:57 by jwe]
jwe
parents: 5355
diff changeset
116 if (ischar (arg))
4229
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
117 fmt = arg;
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
118 else
4919
a1073eef650c [project @ 2004-07-27 15:22:50 by jwe]
jwe
parents: 4918
diff changeset
119 if (isnumeric (x) && round (x) == x && abs (x) < (10 .^ arg))
4918
d2a7208f35d4 [project @ 2004-07-27 15:18:04 by jwe]
jwe
parents: 4914
diff changeset
120 fmt = sprintf ("%%%dd ", arg);
d2a7208f35d4 [project @ 2004-07-27 15:18:04 by jwe]
jwe
parents: 4914
diff changeset
121 else
d2a7208f35d4 [project @ 2004-07-27 15:18:04 by jwe]
jwe
parents: 4914
diff changeset
122 fmt = sprintf ("%%%d.%dg", arg+7, arg);
d2a7208f35d4 [project @ 2004-07-27 15:18:04 by jwe]
jwe
parents: 4914
diff changeset
123 endif
4229
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
124 endif
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
125 else
4691
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents: 4295
diff changeset
126 if (isnumeric (x) && round (x) == x && abs (x) < 1e10)
4914
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4911
diff changeset
127 if (max (abs (x(:))) == 0)
6997
6d0d8d621532 [project @ 2007-10-10 16:41:16 by jwe]
jwe
parents: 6975
diff changeset
128 dgt = 2;
4911
14027e0bafa4 [project @ 2004-07-22 19:58:06 by jwe]
jwe
parents: 4878
diff changeset
129 else
6997
6d0d8d621532 [project @ 2007-10-10 16:41:16 by jwe]
jwe
parents: 6975
diff changeset
130 dgt = floor (log10 (max (abs(x(:))))) + (min (real (x(:))) < 0) + 2;
4911
14027e0bafa4 [project @ 2004-07-22 19:58:06 by jwe]
jwe
parents: 4878
diff changeset
131 endif
6975
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents: 6555
diff changeset
132 if (length (abs (x) == x) > 0)
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents: 6555
diff changeset
133 fmt = sprintf ("%%%dg ", dgt);
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents: 6555
diff changeset
134 else
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents: 6555
diff changeset
135 fmt = sprintf ("%%%dd ", dgt);
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents: 6555
diff changeset
136 endif
4691
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents: 4295
diff changeset
137 elseif (isscalar (x))
6975
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents: 6555
diff changeset
138 fmt = "%11.5g";
4295
fea24da316a2 [project @ 2003-01-11 04:23:24 by jwe]
jwe
parents: 4229
diff changeset
139 else
6975
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents: 6555
diff changeset
140 fmt = "%11.5g";
4295
fea24da316a2 [project @ 2003-01-11 04:23:24 by jwe]
jwe
parents: 4229
diff changeset
141 endif
4229
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
142 endif
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
143 fmt = strcat (deblank (repmat (fmt, 1, columns (x))), "\n");
4914
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4911
diff changeset
144 nd = ndims (x);
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4911
diff changeset
145 tmp = sprintf (fmt, permute (x, [2, 1, 3:nd]));
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
146 tmp(length (tmp)) = "";
6975
0d11a12643f1 [project @ 2007-10-08 18:23:44 by jwe]
jwe
parents: 6555
diff changeset
147 retval = strtrim (split (tmp, "\n"));
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
148 endif
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
149
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
150 endfunction