annotate scripts/deprecated/com2str.m @ 6650:10da0f6d85c2 ss-2-9-11

[project @ 2007-05-22 06:48:18 by jwe]
author jwe
date Tue, 22 May 2007 06:48:18 +0000
parents 34f96dd5441b
children 93c65f2a5668
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
1 ## Copyright (C) 1998 Auburn University. All rights reserved.
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
2 ##
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
4 ##
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by the
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
7 ## Free Software Foundation; either version 2, or (at your option) any
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
8 ## later version.
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
9 ##
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but WITHOUT
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
11 ## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
12 ## FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
13 ## for more details.
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
14 ##
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
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: 4898
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: 4898
diff changeset
18 ## 02110-1301 USA.
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
19
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
20 ## -*- texinfo -*-
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
21 ## @deftypefn {Function File} {} com2str (@var{zz}, @var{flg})
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
22 ## This function has been deprecated. Use num2str instead.
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
23 ##
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
24 ## Convert complex number to a string.
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
25 ## @strong{Inputs}
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
26 ## @table @var
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
27 ## @item zz
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
28 ## complex number
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
29 ## @item flg
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
30 ## format flag
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
31 ## 0 (default): -1, 0, 1, 1i, 1 + 0.5i
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
32 ## 1 (for use with zpout): -1, 0, + 1, + 1i, + 1 + 0.5i
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
33 ## @end table
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
34 ## @end deftypefn
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
35
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
36 function retval = com2str (zz, flg)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
37
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
38 if (nargin < 1 || nargin > 2)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5307
diff changeset
39 print_usage ();
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
40 endif
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
41 if (nargin == 1)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
42 flg = 0;
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
43 endif
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
44
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
45 if (! (isscalar (zz) && isscalar (flg)))
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
46 error ("com2str: arguments must be a scalar");
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
47 endif
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
48
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
49 if (flg != 0 && flg != 1)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
50 error ("invalid flg value: %d", flg);
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
51 endif
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
52
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
53 sgns = "+-";
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
54 rz = real (zz);
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
55 iz = imag (zz);
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
56 az = abs (zz);
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
57 if (iz == 0)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
58 ## strictly a real number
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
59 switch (flg)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
60 case(0)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
61 retval = num2str (rz);
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
62 case(1)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
63 retval = [sgns(1+(rz<0)), " ", num2str(abs(rz))];
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
64 endswitch
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
65 elseif (rz == 0)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
66 ## strictly an imaginary number
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
67 switch (flg)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
68 case(0)
4898
8fd9495f5054 [project @ 2004-06-04 13:29:33 by jwe]
jwe
parents: 4878
diff changeset
69 retval = [num2str(iz), "i"];
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
70 case(1)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
71 retval = [sgns(1+(iz<0)), " ", num2str(abs(iz)), "i"];
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
72 endswitch
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
73 else
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
74 ## complex number
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
75 ## strictly an imaginary number
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
76 switch (flg)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
77 case(0)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
78 retval = [num2str(rz), " ", com2str(i*iz,1)];
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
79 case(1)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
80 retval = [sgns(1+(rz<0)), " ", num2str(abs(rz)), " ", com2str(i*iz,1)];
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
81 endswitch
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
82 endif
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
83
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
84 endfunction