annotate scripts/strings/com2str.m @ 3501:8b21bcbc1080

[project @ 2000-01-31 06:43:15 by jwe]
author jwe
date Mon, 31 Jan 2000 06:43:18 +0000
parents 7923abdeb4e5
children 22bd65326ec1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3431
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
1 ## Copyright (C) 1998 Auburn University. All rights reserved.
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
2 ##
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
4 ##
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by the
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
7 ## Free Software Foundation; either version 2, or (at your option) any
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
8 ## later version.
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
9 ##
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but WITHOUT
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
11 ## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
12 ## FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
13 ## for more details.
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
14 ##
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, write to the Free
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
17 ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA.
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
18
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
3501
8b21bcbc1080 [project @ 2000-01-31 06:43:15 by jwe]
jwe
parents: 3500
diff changeset
20 ## @deftypefn {Function File} {} com2str (@var{zz}, @var{flg})
3431
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
21 ##
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
22 ## convert complex number to a string
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
23 ## @strong{Inputs}
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
24 ## @table @var
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
25 ## @item zz
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
26 ## complex number
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
27 ## @item flg
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
28 ## format flag
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
29 ## 0 (default): -1, 0, 1, 1i, 1 + 0.5i
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
30 ## 1 (for use with zpout): -1, 0, + 1, + 1i, + 1 + 0.5i
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
31 ## @end table
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
32 ## @end deftypefn
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
33
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
34 function retval = com2str (zz, flg)
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
35
3457
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3431
diff changeset
36 if (nargin < 1 || nargin > 2)
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3431
diff changeset
37 usage ("com2str (zz, flg)");
3431
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
38 endif
3457
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3431
diff changeset
39 if (nargin == 1)
3431
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
40 flg = 0;
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
41 endif
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
42
3457
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3431
diff changeset
43 if (! (is_scalar (zz) && is_scalar (flg)))
3458
d25bc039237b [project @ 2000-01-19 09:36:14 by jwe]
jwe
parents: 3457
diff changeset
44 error ("com2str: arguments must be a scalar");
3431
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
45 endif
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
46
3457
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3431
diff changeset
47 if (flg != 0 && flg != 1)
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3431
diff changeset
48 error ("invalid flg value: %d", flg);
3431
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
49 endif
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
50
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
51 sgns = "+-";
3457
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3431
diff changeset
52 rz = real (zz);
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3431
diff changeset
53 iz = imag (zz);
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3431
diff changeset
54 az = abs (zz);
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3431
diff changeset
55 if (iz == 0)
3431
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
56 ## strictly a real number
3457
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3431
diff changeset
57 switch (flg)
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3431
diff changeset
58 case(0)
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3431
diff changeset
59 retval = num2str (rz);
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3431
diff changeset
60 case(1)
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3431
diff changeset
61 retval = [sgns(1+(rz<0)), " ", num2str(abs(rz))];
3431
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
62 endswitch
3457
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3431
diff changeset
63 elseif (rz == 0)
3431
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
64 ## strictly an imaginary number
3457
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3431
diff changeset
65 switch (flg)
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3431
diff changeset
66 case(0)
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3431
diff changeset
67 retval = num2str (iz);
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3431
diff changeset
68 case(1)
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3431
diff changeset
69 retval = [sgns(1+(iz<0)), " ", num2str(abs(iz)), "i"];
3431
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
70 endswitch
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
71 else
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
72 ## complex number
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
73 ## strictly an imaginary number
3457
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3431
diff changeset
74 switch (flg)
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3431
diff changeset
75 case(0)
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3431
diff changeset
76 retval = [num2str(rz), " ", com2str(i*iz,1)];
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3431
diff changeset
77 case(1)
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe]
jwe
parents: 3431
diff changeset
78 retval = [sgns(1+(rz<0)), " ", num2str(abs(rz)), " ", com2str(i*iz,1)];
3431
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
79 endswitch
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
80 endif
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
81
99ab64f4a09d [project @ 2000-01-14 03:53:03 by jwe]
jwe
parents:
diff changeset
82 endfunction