Mercurial > hg > octave-nkf

annotate scripts/general/cart2pol.m @ 8920:eb63fbe60fab

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
update copyright notices
author John W. Eaton <jwe@octave.org>
date Sat, 07 Mar 2009 10:41:27 -0500
parents fb1b87ea4af9
children 742cf6388a8f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8920
eb63fbe60fab update copyright notices
John W. Eaton <jwe@octave.org>
parents: 8533
diff changeset
1 ## Copyright (C) 2000, 2001, 2002, 2004, 2005, 2006, 2007, 2009 Kai Habel
3803
63c75bc3db82 [project @ 2001-02-28 08:24:40 by jwe]
jwe
parents:
diff changeset
2 ##
63c75bc3db82 [project @ 2001-02-28 08:24:40 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
63c75bc3db82 [project @ 2001-02-28 08:24:40 by jwe]
jwe
parents:
diff changeset
4 ##
63c75bc3db82 [project @ 2001-02-28 08:24:40 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
63c75bc3db82 [project @ 2001-02-28 08:24:40 by jwe]
jwe
parents:
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: 6786
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: 6786
diff changeset
8 ## your option) any later version.
3803
63c75bc3db82 [project @ 2001-02-28 08:24:40 by jwe]
jwe
parents:
diff changeset
9 ##
63c75bc3db82 [project @ 2001-02-28 08:24:40 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
63c75bc3db82 [project @ 2001-02-28 08:24:40 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
63c75bc3db82 [project @ 2001-02-28 08:24:40 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
63c75bc3db82 [project @ 2001-02-28 08:24:40 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
63c75bc3db82 [project @ 2001-02-28 08:24:40 by jwe]
jwe
parents:
diff changeset
14 ##
63c75bc3db82 [project @ 2001-02-28 08:24:40 by jwe]
jwe
parents:
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: 6786
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: 6786
diff changeset
17 ## <http://www.gnu.org/licenses/>.
3803
63c75bc3db82 [project @ 2001-02-28 08:24:40 by jwe]
jwe
parents:
diff changeset
18
63c75bc3db82 [project @ 2001-02-28 08:24:40 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
5610
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents: 5307
diff changeset
20 ## @deftypefn {Function File} {[@var{theta}, @var{r}] =} cart2pol (@var{x}, @var{y})
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents: 5307
diff changeset
21 ## @deftypefnx {Function File} {[@var{theta}, @var{r}, @var{z}] =} cart2pol (@var{x}, @var{y}, @var{z})
3803
63c75bc3db82 [project @ 2001-02-28 08:24:40 by jwe]
jwe
parents:
diff changeset
22 ## Transform cartesian to polar or cylindrical coordinates.
8533
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
23 ## @var{x}, @var{y} (and @var{z}) must be of same shape, or scalar.
8491
aaff46fef256 [docs] fix hypenation: x - axis => x-axis, etc
Brian Gough <bjg@gnu.org>
parents: 7017
diff changeset
24 ## @var{theta} describes the angle relative to the x-axis.
aaff46fef256 [docs] fix hypenation: x - axis => x-axis, etc
Brian Gough <bjg@gnu.org>
parents: 7017
diff changeset
25 ## @var{r} is the distance to the z-axis (0, 0, z).
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5610
diff changeset
26 ## @seealso{pol2cart, cart2sph, sph2cart}
3803
63c75bc3db82 [project @ 2001-02-28 08:24:40 by jwe]
jwe
parents:
diff changeset
27 ## @end deftypefn
63c75bc3db82 [project @ 2001-02-28 08:24:40 by jwe]
jwe
parents:
diff changeset
28
63c75bc3db82 [project @ 2001-02-28 08:24:40 by jwe]
jwe
parents:
diff changeset
29 ## Author: Kai Habel <kai.habel@gmx.de>
63c75bc3db82 [project @ 2001-02-28 08:24:40 by jwe]
jwe
parents:
diff changeset
30 ## Adapted-by: jwe
63c75bc3db82 [project @ 2001-02-28 08:24:40 by jwe]
jwe
parents:
diff changeset
31
8533
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
32 function [theta, r, z] = cart2pol (x, y, z)
3803
63c75bc3db82 [project @ 2001-02-28 08:24:40 by jwe]
jwe
parents:
diff changeset
33
63c75bc3db82 [project @ 2001-02-28 08:24:40 by jwe]
jwe
parents:
diff changeset
34 if (nargin < 2 || nargin > 3)
63c75bc3db82 [project @ 2001-02-28 08:24:40 by jwe]
jwe
parents:
diff changeset
35 error ("cart2pol: number of arguments must be 2 or 3");
63c75bc3db82 [project @ 2001-02-28 08:24:40 by jwe]
jwe
parents:
diff changeset
36 endif
63c75bc3db82 [project @ 2001-02-28 08:24:40 by jwe]
jwe
parents:
diff changeset
37
63c75bc3db82 [project @ 2001-02-28 08:24:40 by jwe]
jwe
parents:
diff changeset
38 if (nargin == 2 && nargout > 2)
63c75bc3db82 [project @ 2001-02-28 08:24:40 by jwe]
jwe
parents:
diff changeset
39 error ("cart2pol: number of output arguments must not be greater than number of input arguments");
63c75bc3db82 [project @ 2001-02-28 08:24:40 by jwe]
jwe
parents:
diff changeset
40 endif
63c75bc3db82 [project @ 2001-02-28 08:24:40 by jwe]
jwe
parents:
diff changeset
41
8533
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
42 if ((ismatrix (x) && ismatrix (y) && (nargin == 2 || ismatrix (z)))
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
43 && (size_equal (x, y) || isscalar (x) || isscalar (y))
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
44 && (nargin == 2 || size_equal (x, z) || isscalar (x) || isscalar (z))
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
45 && (nargin == 2 || size_equal (y, z) || isscalar (y) || isscalar (z)))
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
46
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
47 theta = atan2 (y, x);
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
48 r = sqrt (x .^ 2 + y .^ 2);
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
49
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
50 else
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
51 error ("cart2pol: arguments must be matrices of same size, or scalar");
3803
63c75bc3db82 [project @ 2001-02-28 08:24:40 by jwe]
jwe
parents:
diff changeset
52 endif
63c75bc3db82 [project @ 2001-02-28 08:24:40 by jwe]
jwe
parents:
diff changeset
53
8533
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
54 endfunction
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
55
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
56 %!test
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
57 %! x = [0, 1, 2];
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
58 %! y = 0;
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
59 %! [t, r] = cart2pol (x, y);
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
60 %! assert (t, [0, 0, 0]);
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
61 %! assert (r, x);
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
62
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
63 %!test
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
64 %! x = [0, 1, 2];
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
65 %! y = [0, 1, 2];
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
66 %! [t, r] = cart2pol (x, y);
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
67 %! assert (t, [0, pi/4, pi/4], sqrt(eps));
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
68 %! assert (r, sqrt(2)*[0, 1, 2], sqrt(eps));
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
69
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
70 %!test
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
71 %! x = [0, 1, 2];
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
72 %! y = [0, 1, 2];
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
73 %! z = [0, 1, 2];
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
74 %! [t, r, z2] = cart2pol (x, y, z);
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
75 %! assert (t, [0, pi/4, pi/4], sqrt(eps));
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
76 %! assert (r, sqrt(2)*[0, 1, 2], sqrt(eps));
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
77 %! assert (z, z2);
3803
63c75bc3db82 [project @ 2001-02-28 08:24:40 by jwe]
jwe
parents:
diff changeset
78
8533
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
79 %!test
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
80 %! x = [0, 1, 2];
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
81 %! y = 0;
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
82 %! z = 0;
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
83 %! [t, r, z2] = cart2pol (x, y, z);
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
84 %! assert (t, [0, 0, 0], eps);
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
85 %! assert (r, x, eps);
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
86 %! assert (z, z2);
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
87
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
88 %!test
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
89 %! x = 0;
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
90 %! y = [0, 1, 2];
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
91 %! z = 0;
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
92 %! [t, r, z2] = cart2pol (x, y, z);
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
93 %! assert (t, [0, 1, 1]*pi/2, eps);
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
94 %! assert (r, y, eps);
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
95 %! assert (z, z2);
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
96
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
97 %!test
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
98 %! x = 0;
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
99 %! y = 0;
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
100 %! z = [0, 1, 2];
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
101 %! [t, r, z2] = cart2pol (x, y, z);
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
102 %! assert (t, 0);
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
103 %! assert (r, 0);
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
104 %! assert (z, z2);
fb1b87ea4af9 Permit scalars when transforming coordinates.
Ben Abbott <bpabbott@mac.com>
parents: 8491
diff changeset
105