annotate scripts/general/int2str.m @ 4878:4eaf35cfdb11

[project @ 2004-04-23 15:42:10 by jwe]
author jwe
date Fri, 23 Apr 2004 15:42:10 +0000
parents a9560cebae6e
children c08cb1098afc
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: 2325
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
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
17 ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
18 ## 02111-1307, 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
3408
ae7adbb591e8 [project @ 2000-01-06 08:29:11 by jwe]
jwe
parents: 3407
diff changeset
28 ## @seealso{sprintf and num2str}
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
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
32 function retval = int2str (x)
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
33
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
34 if (nargin == 1)
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4309
diff changeset
35 x = round (real(x));
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4309
diff changeset
36 sz = size(x);
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4309
diff changeset
37 nd = ndims (x);
4305
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
38 nc = columns (x);
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
39 if (nc > 1)
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4309
diff changeset
40 idx = cell ();
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4309
diff changeset
41 for i = 1:nd
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4309
diff changeset
42 idx {i} = 1:sz(i);
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4309
diff changeset
43 endfor
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4309
diff changeset
44 idx(2) = 1;
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4309
diff changeset
45 ifmt = get_fmt (x(idx{:}), 0);
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4309
diff changeset
46 idx(2) = 2:sz(2);
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4309
diff changeset
47 rfmt = get_fmt (x(idx{:}), 2);
4305
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
48 fmt = strcat (ifmt, repmat (rfmt, 1, nc-1), "\n")
4303
e15a96673976 [project @ 2003-01-23 03:03:08 by jwe]
jwe
parents: 4229
diff changeset
49 else
4305
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
50 fmt = strcat (get_fmt (x, 0), "\n");
4303
e15a96673976 [project @ 2003-01-23 03:03:08 by jwe]
jwe
parents: 4229
diff changeset
51 endif
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents: 4309
diff changeset
52 tmp = sprintf (fmt, permute (x, [2, 1, 3 : nd]));
4305
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
53 tmp(end) = "";
4229
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
54 retval = split (tmp, "\n");
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
55 else
904
3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe]
jwe
parents: 419
diff changeset
56 usage ("int2str (x)");
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
57 endif
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
58
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
59 endfunction
4305
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
60
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
61 function fmt = get_fmt (x, sep)
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
62
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
63 t = x(:);
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
64 t = t(t != 0);
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
65 if (isempty (t))
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
66 ## All zeros.
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
67 fmt = sprintf ("%%%dd", 1 + sep);
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
68 else
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
69 ## Maybe have some zeros.
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
70 nan_inf = isinf (t) | isnan (t);
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
71 if (any (nan_inf))
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
72 if (any (t(nan_inf) < 0))
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
73 min_fw = 4 + sep;
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
74 else
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
75 min_fw = 3 + sep;
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
76 endif
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
77 else
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
78 min_fw = 1 + sep;
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
79 endif
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
80 t = t(! nan_inf);
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
81 if (isempty (t))
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
82 ## Only zeros, Inf, and NaN.
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
83 fmt = sprintf ("%%%dd", min_fw);
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
84 else
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
85 ## Could have anything.
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
86 tfw = floor (log10 (abs (t))) + 1 + sep;
4309
a9560cebae6e [project @ 2003-01-28 23:24:58 by jwe]
jwe
parents: 4305
diff changeset
87 fw = max (tfw);
4305
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
88 if (any (t(tfw == fw) < 0))
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
89 fw++;
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
90 endif
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
91 fmt = sprintf ("%%%dd", max (fw, min_fw));
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
92 endif
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
93 endif
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
94
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
95 endfunction