Mercurial > hg > octave-lyh

annotate scripts/general/int2str.m @ 14459:a22a41ab6824

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Add Colin Macdonald and Mike Miller to contributors.in
author Jordi Gutiérrez Hermoso <jordigh@octave.org>
date Tue, 13 Mar 2012 01:30:26 -0400
parents cbcaf5602469
children 5d3a684236b0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 12780
diff changeset
1 ## Copyright (C) 1993-2012 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
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7005
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7005
diff changeset
8 ## your option) any later version.
2313
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
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7005
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7005
diff changeset
17 ## <http://www.gnu.org/licenses/>.
245
16a24e76d6e0 [project @ 1993-12-03 02:00:15 by jwe]
jwe
parents: 4
diff changeset
18
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2847
diff changeset
19 ## -*- texinfo -*-
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2847
diff changeset
20 ## @deftypefn {Function File} {} int2str (@var{n})
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
21 ## Convert an integer (or array of integers) to a string (or a character
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
22 ## array).
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
23 ##
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
24 ## @example
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
25 ## @group
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
26 ## int2str (123)
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
27 ## @result{} "123"
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
28 ##
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
29 ## s = int2str ([1, 2, 3; 4, 5, 6])
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
30 ## @result{} s =
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
31 ## 1 2 3
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
32 ## 4 5 6
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
33 ##
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
34 ## whos s
14402
cbcaf5602469 doc: Make spacing nicer for Strings chapter of manual.
Rik <octave@nomad.inbox5.com>
parents: 14363
diff changeset
35 ## @result{}
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
36 ## Attr Name Size Bytes Class
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
37 ## ==== ==== ==== ===== =====
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
38 ## s 2x7 14 char
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
39 ## @end group
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
40 ## @end example
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
41 ##
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
42 ## This function is not very flexible. For better control over the
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
43 ## results, use @code{sprintf} (@pxref{Formatted Output}).
8442
502e58a0d44f Fix docstrings, add examples, references and tests to string functions
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 7540
diff changeset
44 ## @seealso{sprintf, num2str, mat2str}
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 2847
diff changeset
45 ## @end deftypefn
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
46
2314
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
47 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
48
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10549
diff changeset
49 function retval = int2str (n)
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
50
12780
c99714aeb008 int2str.m: Return "" for null input []. (Bug #33524)
Rik <octave@nomad.inbox5.com>
parents: 12676
diff changeset
51 if (nargin != 1)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5642
diff changeset
52 print_usage ();
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
53 endif
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
54
12780
c99714aeb008 int2str.m: Return "" for null input []. (Bug #33524)
Rik <octave@nomad.inbox5.com>
parents: 12676
diff changeset
55 if (isempty (n))
c99714aeb008 int2str.m: Return "" for null input []. (Bug #33524)
Rik <octave@nomad.inbox5.com>
parents: 12676
diff changeset
56 retval = '';
c99714aeb008 int2str.m: Return "" for null input []. (Bug #33524)
Rik <octave@nomad.inbox5.com>
parents: 12676
diff changeset
57 return;
c99714aeb008 int2str.m: Return "" for null input []. (Bug #33524)
Rik <octave@nomad.inbox5.com>
parents: 12676
diff changeset
58 endif
c99714aeb008 int2str.m: Return "" for null input []. (Bug #33524)
Rik <octave@nomad.inbox5.com>
parents: 12676
diff changeset
59
c99714aeb008 int2str.m: Return "" for null input []. (Bug #33524)
Rik <octave@nomad.inbox5.com>
parents: 12676
diff changeset
60 n = round (real(n));
c99714aeb008 int2str.m: Return "" for null input []. (Bug #33524)
Rik <octave@nomad.inbox5.com>
parents: 12676
diff changeset
61 sz = size(n);
c99714aeb008 int2str.m: Return "" for null input []. (Bug #33524)
Rik <octave@nomad.inbox5.com>
parents: 12676
diff changeset
62 nd = ndims (n);
c99714aeb008 int2str.m: Return "" for null input []. (Bug #33524)
Rik <octave@nomad.inbox5.com>
parents: 12676
diff changeset
63 nc = columns (n);
c99714aeb008 int2str.m: Return "" for null input []. (Bug #33524)
Rik <octave@nomad.inbox5.com>
parents: 12676
diff changeset
64 if (nc > 1)
c99714aeb008 int2str.m: Return "" for null input []. (Bug #33524)
Rik <octave@nomad.inbox5.com>
parents: 12676
diff changeset
65 idx = repmat ({':'}, nd, 1);
c99714aeb008 int2str.m: Return "" for null input []. (Bug #33524)
Rik <octave@nomad.inbox5.com>
parents: 12676
diff changeset
66 idx(2) = 1;
c99714aeb008 int2str.m: Return "" for null input []. (Bug #33524)
Rik <octave@nomad.inbox5.com>
parents: 12676
diff changeset
67 ifmt = get_fmt (n(idx{:}), 0);
c99714aeb008 int2str.m: Return "" for null input []. (Bug #33524)
Rik <octave@nomad.inbox5.com>
parents: 12676
diff changeset
68 idx(2) = 2:sz(2);
c99714aeb008 int2str.m: Return "" for null input []. (Bug #33524)
Rik <octave@nomad.inbox5.com>
parents: 12676
diff changeset
69 rfmt = get_fmt (n(idx{:}), 2);
c99714aeb008 int2str.m: Return "" for null input []. (Bug #33524)
Rik <octave@nomad.inbox5.com>
parents: 12676
diff changeset
70 fmt = cstrcat (ifmt, repmat (rfmt, 1, nc-1), "\n");
c99714aeb008 int2str.m: Return "" for null input []. (Bug #33524)
Rik <octave@nomad.inbox5.com>
parents: 12676
diff changeset
71 else
c99714aeb008 int2str.m: Return "" for null input []. (Bug #33524)
Rik <octave@nomad.inbox5.com>
parents: 12676
diff changeset
72 fmt = cstrcat (get_fmt (n, 0), "\n");
c99714aeb008 int2str.m: Return "" for null input []. (Bug #33524)
Rik <octave@nomad.inbox5.com>
parents: 12676
diff changeset
73 endif
c99714aeb008 int2str.m: Return "" for null input []. (Bug #33524)
Rik <octave@nomad.inbox5.com>
parents: 12676
diff changeset
74 tmp = sprintf (fmt, permute (n, [2, 1, 3 : nd]));
c99714aeb008 int2str.m: Return "" for null input []. (Bug #33524)
Rik <octave@nomad.inbox5.com>
parents: 12676
diff changeset
75 tmp(end) = "";
c99714aeb008 int2str.m: Return "" for null input []. (Bug #33524)
Rik <octave@nomad.inbox5.com>
parents: 12676
diff changeset
76 retval = char (strsplit (tmp, "\n"));
c99714aeb008 int2str.m: Return "" for null input []. (Bug #33524)
Rik <octave@nomad.inbox5.com>
parents: 12676
diff changeset
77
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
78 endfunction
4305
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
79
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
80 function fmt = get_fmt (x, sep)
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
81
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
82 t = x(:);
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
83 t = t(t != 0);
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
84 if (isempty (t))
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
85 ## All zeros.
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
86 fmt = sprintf ("%%%dd", 1 + sep);
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
87 else
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
88 ## Maybe have some zeros.
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
89 nan_inf = isinf (t) | isnan (t);
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
90 if (any (nan_inf))
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
91 if (any (t(nan_inf) < 0))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9576
diff changeset
92 min_fw = 4 + sep;
4305
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
93 else
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9576
diff changeset
94 min_fw = 3 + sep;
4305
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
95 endif
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
96 else
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
97 min_fw = 1 + sep;
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
98 endif
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
99 t = t(! nan_inf);
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
100 if (isempty (t))
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
101 ## Only zeros, Inf, and NaN.
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
102 fmt = sprintf ("%%%dd", min_fw);
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
103 else
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
104 ## Could have anything.
9576
d73c9bd101ef fix int2str
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
105 tfw = floor (log10 (double (abs (t)))) + 1 + sep;
4309
a9560cebae6e [project @ 2003-01-28 23:24:58 by jwe]
jwe
parents: 4305
diff changeset
106 fw = max (tfw);
4305
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
107 if (any (t(tfw == fw) < 0))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9576
diff changeset
108 fw++;
4305
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
109 endif
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
110 fmt = sprintf ("%%%dd", max (fw, min_fw));
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
111 endif
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
112 endif
98e65d1728a1 [project @ 2003-01-23 16:48:11 by jwe]
jwe
parents: 4303
diff changeset
113
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5307
diff changeset
114 endfunction
7411
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7208
diff changeset
115
12780
c99714aeb008 int2str.m: Return "" for null input []. (Bug #33524)
Rik <octave@nomad.inbox5.com>
parents: 12676
diff changeset
116
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
117 %!assert (int2str (-123), "-123")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
118 %!assert (int2str (1.2), "1")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
119 %!assert (int2str ([1, 2, 3; 4, 5, 6]), ["1 2 3";"4 5 6"])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
120 %!assert (int2str ([]), "")
7411
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7208
diff changeset
121
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
122 %!error int2str ()
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
123 %!error int2str (1, 2)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
124