annotate scripts/general/num2str.m @ 4229:40153a2affd6

[project @ 2002-12-18 20:37:32 by jwe]
author jwe
date Wed, 18 Dec 2002 20:37:32 +0000
parents ae7adbb591e8
children fea24da316a2
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
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 int2str}
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
4229
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
34 if (nargin == 1 || nargin == 2)
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
35 if (nargin == 2)
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
36 if (isstr (arg))
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
37 fmt = arg;
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
38 else
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
39 fmt = sprintf ("%%.%dg", arg);
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
40 endif
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
41 else
4229
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
42 fmt = "%11.4g";
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
43 endif
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
44 if (iscomplex (x))
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
45 error ("num2str: sorry, can't handle complex numbers yet");
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
46 else
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
47 fmt = strcat (repmat (fmt, 1, columns (x)), "\n");
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
48 tmp = sprintf (fmt, x.');
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
49 tmp(length (tmp)) = "";
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
50 retval = split (tmp, "\n");
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
51 endif
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
52 else
4229
40153a2affd6 [project @ 2002-12-18 20:37:32 by jwe]
jwe
parents: 3408
diff changeset
53 usage ("num2str (x) or num2str (x, precision) or num2str (x, fmt)");
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
54 endif
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
55
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
56 endfunction