annotate scripts/deprecated/com2str.m @ 4898:8fd9495f5054

[project @ 2004-06-04 13:29:33 by jwe]
author jwe
date Fri, 04 Jun 2004 13:29:34 +0000
parents 4eaf35cfdb11
children 4c8a2e4e0717
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
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
17 ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA.
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
18
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
20 ## @deftypefn {Function File} {} com2str (@var{zz}, @var{flg})
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
21 ## This function has been deprecated. Use num2str instead.
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
22 ##
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
23 ## Convert complex number to a string.
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
24 ## @strong{Inputs}
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
25 ## @table @var
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
26 ## @item zz
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
27 ## complex number
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
28 ## @item flg
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
29 ## format flag
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
30 ## 0 (default): -1, 0, 1, 1i, 1 + 0.5i
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
31 ## 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
32 ## @end table
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
33 ## @end deftypefn
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
34
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
35 function retval = com2str (zz, flg)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
36
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
37 if (nargin < 1 || nargin > 2)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
38 usage ("com2str (zz, flg)");
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
39 endif
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
40 if (nargin == 1)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
41 flg = 0;
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
42 endif
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
43
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
44 if (! (isscalar (zz) && isscalar (flg)))
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
45 error ("com2str: arguments must be a scalar");
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
46 endif
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
47
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
48 if (flg != 0 && flg != 1)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
49 error ("invalid flg value: %d", flg);
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
50 endif
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
51
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
52 sgns = "+-";
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
53 rz = real (zz);
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
54 iz = imag (zz);
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
55 az = abs (zz);
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
56 if (iz == 0)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
57 ## strictly a real number
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
58 switch (flg)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
59 case(0)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
60 retval = num2str (rz);
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
61 case(1)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
62 retval = [sgns(1+(rz<0)), " ", num2str(abs(rz))];
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
63 endswitch
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
64 elseif (rz == 0)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
65 ## strictly an imaginary number
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
66 switch (flg)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
67 case(0)
4898
8fd9495f5054 [project @ 2004-06-04 13:29:33 by jwe]
jwe
parents: 4878
diff changeset
68 retval = [num2str(iz), "i"];
4878
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
69 case(1)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
70 retval = [sgns(1+(iz<0)), " ", num2str(abs(iz)), "i"];
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
71 endswitch
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
72 else
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
73 ## complex number
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
74 ## strictly an imaginary number
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
75 switch (flg)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
76 case(0)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
77 retval = [num2str(rz), " ", com2str(i*iz,1)];
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
78 case(1)
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
79 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
80 endswitch
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
81 endif
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
82
4eaf35cfdb11 [project @ 2004-04-23 15:42:10 by jwe]
jwe
parents:
diff changeset
83 endfunction