annotate scripts/general/num2str.m @ 5355:cf44c749ba52

[project @ 2005-05-18 11:43:37 by jwe]
author jwe
date Wed, 18 May 2005 11:43:38 +0000
parents 4c8a2e4e0717
children ec8c33dcd1bf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2847
8b262e771614 [project @ 1997-03-27 16:18:26 by jwe]
jwe
parents: 2314
diff changeset
1 ## Copyright (C) 1996, 1997 John W. Eaton
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
2 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
5 ## 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
6 ## under the terms of the GNU General Public License as published by
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
7 ## the Free Software Foundation; either version 2, or (at your option)
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
8 ## any later version.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
10 ## 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
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
12 ## 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
13 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
15 ## You should have received a copy of the GNU General Public License
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
16 ## along with Octave; see the file COPYING. If not, write to the Free
5307
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 5053
diff changeset
17 ## Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 5053
diff changeset
18 ## 02110-1301, USA.
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 -*-
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2847
diff changeset
21 ## @deftypefn {Function File} {} int2str (@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})
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2847
diff changeset
24 ## Convert a number to a string. These functions are not very flexible,
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2847
diff changeset
25 ## but are provided for compatibility with @sc{Matlab}. For better control
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2847
diff changeset
26 ## over the results, use @code{sprintf} (@pxref{Formatted Output}).
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2847
diff changeset
27 ## @end deftypefn
5053
c08cb1098afc [project @ 2004-10-19 23:10:54 by jwe]
jwe
parents: 4919
diff changeset
28 ##
3408
ae7adbb591e8 [project @ 2000-01-06 08:29:11 by jwe]
jwe
parents: 3407
diff changeset
29 ## @seealso{sprintf and int2str}
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
30
2314
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
31 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
32
4229
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
33 function retval = num2str (x, arg)
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
34
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
35 if (nargin != 1 && nargin != 2)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
36 usage ("num2str (x) or num2str (x, precision) or num2str (x, fmt)");
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
37 endif
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
38
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
39 if (isstr (x))
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
40 retval = x;
5355
cf44c749ba52 [project @ 2005-05-18 11:43:37 by jwe]
jwe
parents: 5307
diff changeset
41 return;
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
42 endif
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
43
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
44 if (iscomplex (x))
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
45 if (nargin == 2)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
46 if (isstr (arg))
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
47 fmt = strcat (arg, "%-+", arg(2:end), "i");
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
48 else
4919
a1073eef650c [project @ 2004-07-27 15:22:50 by jwe]
jwe
parents: 4918
diff changeset
49 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
50 fmt = sprintf ("%%%dd%%-+%ddi ", arg, arg);
d2a7208f35d4 [project @ 2004-07-27 15:18:04 by jwe]
jwe
parents: 4914
diff changeset
51 else
d2a7208f35d4 [project @ 2004-07-27 15:18:04 by jwe]
jwe
parents: 4914
diff changeset
52 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
53 endif
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
54 endif
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
55 else
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
56 ## Setup a suitable format string
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
57 if (isnumeric (x) && round (x) == x && abs (x) < 1e10)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
58 dgt1 = ceil (log10 (max (max (abs (real (x(:)))),
4914
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4911
diff changeset
59 max (abs (imag (x(:))))))) + 1;
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
60 dgt2 = dgt1 - (min (real (x(:))) >= 0);
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
61 fmt = sprintf("%%%dd%%+-%ddi ", dgt2, dgt1);
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
62 elseif (isscalar (x))
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
63 fmt = "%.4g%-+.4gi";
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
64 else
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
65 fmt = "%11.4g%-+11.4gi";
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
66 endif
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
67 endif
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
68
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
69 ## 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
70 ## columns and imaginary values in the even columns.
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
71 sz = size (x);
4914
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4911
diff changeset
72 nc = sz(2);
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
73 nd = ndims (x);
4914
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4911
diff changeset
74 perm = fix ([1:0.5:nc+0.5]);
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4911
diff changeset
75 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
76 idx = cell ();
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
77 for i = 1:nd
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
78 idx {i} = 1:sz(i);
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
79 endfor
4914
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4911
diff changeset
80 idx{2} = perm;
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
81 x = horzcat (real(x), imag(x));
4914
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4911
diff changeset
82 x = x(idx{:});
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
83
4914
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4911
diff changeset
84 fmt = strcat (deblank (repmat (fmt, 1, nc)), "\n");
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4911
diff changeset
85 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
86
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
87 ## 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
88 while (true)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
89 tmp2 = strrep (tmp, " i\n", "i\n");
4914
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4911
diff changeset
90 if (length (tmp) == length (tmp2))
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
91 break;
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
92 else
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
93 tmp = tmp2;
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
94 endif
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
95 endwhile
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
96 while (true)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
97 tmp2 = strrep (tmp, " i", "i ");
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
98 if (tmp == tmp2)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
99 break;
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
100 else
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
101 tmp = tmp2;
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
102 endif
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
103 endwhile
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
104
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
105 tmp(length (tmp)) = "";
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
106 retval = split (tmp, "\n");
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
107 else
4229
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
108 if (nargin == 2)
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
109 if (isstr (arg))
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
110 fmt = arg;
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
111 else
4919
a1073eef650c [project @ 2004-07-27 15:22:50 by jwe]
jwe
parents: 4918
diff changeset
112 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
113 fmt = sprintf ("%%%dd ", arg);
d2a7208f35d4 [project @ 2004-07-27 15:18:04 by jwe]
jwe
parents: 4914
diff changeset
114 else
d2a7208f35d4 [project @ 2004-07-27 15:18:04 by jwe]
jwe
parents: 4914
diff changeset
115 fmt = sprintf ("%%%d.%dg", arg+7, arg);
d2a7208f35d4 [project @ 2004-07-27 15:18:04 by jwe]
jwe
parents: 4914
diff changeset
116 endif
4229
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
117 endif
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
118 else
4691
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents: 4295
diff changeset
119 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
120 if (max (abs (x(:))) == 0)
4911
14027e0bafa4 [project @ 2004-07-22 19:58:06 by jwe]
jwe
parents: 4878
diff changeset
121 dgt = 1;
14027e0bafa4 [project @ 2004-07-22 19:58:06 by jwe]
jwe
parents: 4878
diff changeset
122 else
4914
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4911
diff changeset
123 dgt = floor (log10 (max (abs(x(:))))) + (min (real (x(:))) < 0) + 1;
4911
14027e0bafa4 [project @ 2004-07-22 19:58:06 by jwe]
jwe
parents: 4878
diff changeset
124 endif
4914
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4911
diff changeset
125 fmt = sprintf ("%%%dd ", dgt);
4691
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents: 4295
diff changeset
126 elseif (isscalar (x))
4295
fea24da316a2 [project @ 2003-01-11 04:23:24 by jwe]
jwe
parents: 4229
diff changeset
127 fmt = "%.4g";
fea24da316a2 [project @ 2003-01-11 04:23:24 by jwe]
jwe
parents: 4229
diff changeset
128 else
fea24da316a2 [project @ 2003-01-11 04:23:24 by jwe]
jwe
parents: 4229
diff changeset
129 fmt = "%11.4g";
fea24da316a2 [project @ 2003-01-11 04:23:24 by jwe]
jwe
parents: 4229
diff changeset
130 endif
4229
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
131 endif
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
132 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
133 nd = ndims (x);
1c0442da75fd [project @ 2004-07-23 16:55:13 by jwe]
jwe
parents: 4911
diff changeset
134 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
135 tmp(length (tmp)) = "";
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4691
diff changeset
136 retval = split (tmp, "\n");
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
137 endif
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
138
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
139 endfunction