annotate scripts/quaternion/quaternion.m @ 7580:b4aa9ef3d3ef

Port dlmread, dlmwrite, csvread and csvwrite from octave-forge
author David Bateman <dbateman@free.fr>
date Wed, 12 Mar 2008 01:04:54 +0100
parents a1dbe9d80eee
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
1 ## Copyright (C) 1998, 1999, 2000, 2002, 2005, 2006, 2007
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
2 ## Auburn University. All rights reserved.
3452
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
3 ##
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
4 ## This file is part of Octave.
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
5 ##
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
6 ## Octave is free software; you can redistribute it and/or modify it
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
7 ## 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: 6046
diff changeset
8 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
9 ## your option) any later version.
3452
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
10 ##
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
11 ## Octave is distributed in the hope that it will be useful, but
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
14 ## General Public License for more details.
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
15 ##
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
16 ## 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: 6046
diff changeset
17 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
18 ## <http://www.gnu.org/licenses/>.
3452
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
19
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
20 ## -*- texinfo -*-
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
21 ## @deftypefn {Function File} {[@var{a}, @var{b}, @var{c}, @var{d}] =} quaternion (w)
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
22 ## @deftypefnx {Function File} {[@var{vv}, @var{theta}] =} quaternion (w)
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
23 ## @deftypefnx {Function File} {@var{w} =} quaternion (@var{a}, @var{b}, @var{c}, @var{d})
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
24 ## @deftypefnx {Function File} {@var{w} =} quaternion (@var{vv}, @var{theta})
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
25 ## Construct or extract a quaternion
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
26 ##
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
27 ## @example
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
28 ## w = a*i + b*j + c*k + d
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
29 ## @end example
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
30 ##
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
31 ## @noindent
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
32 ## from given data.
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
33 ## @end deftypefn
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
34
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
35 ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu>
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
36 ## Adapted-By: jwe
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
37
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
38 function [a, b, c, d] = quaternion (w, x, y, z)
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
39
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
40 switch (nargin)
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
41 case(1)
4030
22bd65326ec1 [project @ 2002-08-09 18:58:13 by jwe]
jwe
parents: 3458
diff changeset
42 if (! (isvector (w) && length (w) == 4))
3452
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
43 error ("input vector must be of length 4)");
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
44 endif
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
45 ## extract data
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
46 switch (nargout)
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
47 case(4)
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
48 a = w(1);
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
49 b = w(2);
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
50 c = w(3);
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
51 d = w(4);
3224
1e7532b9173b [project @ 1998-12-04 22:08:23 by jwe]
jwe
parents:
diff changeset
52
3452
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
53 case(2)
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
54 if (abs (norm (w) - 1) > 1e-12)
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
55 warning ("quaternion: ||w||=%e, setting=1 for vv, theta", norm(w));
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
56 w = w/norm(w);
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
57 endif
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
58 [a, b, c, d] = quaternion (w);
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
59 theta = acos (d) * 2;
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
60 if (abs (theta) > pi)
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
61 theta = theta - sign (theta) * pi;
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
62 endif
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
63 sin_th_2 = norm ([a, b, c]);
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
64
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
65 if (sin_th_2 != 0)
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
66 vv = [a, b, c] / sin_th_2;
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
67 else
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
68 vv = [a, b, c];
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
69 endif
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
70 a = vv;
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
71 b = theta;
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
72 otherwise
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5307
diff changeset
73 print_usage ();
3452
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
74 endswitch
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
75
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
76 case(2)
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
77 if (nargout != 1)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5307
diff changeset
78 print_usage ();
3224
1e7532b9173b [project @ 1998-12-04 22:08:23 by jwe]
jwe
parents:
diff changeset
79 endif
3452
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
80 vv = w;
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
81 theta = x;
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
82
4030
22bd65326ec1 [project @ 2002-08-09 18:58:13 by jwe]
jwe
parents: 3458
diff changeset
83 if (! isvector (vv) || length (vv) != 3)
3452
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
84 error ("vv must be a length three vector");
4030
22bd65326ec1 [project @ 2002-08-09 18:58:13 by jwe]
jwe
parents: 3458
diff changeset
85 elseif (! isscalar (theta))
3452
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
86 error ("theta must be a scalar");
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
87 elseif (norm (vv) == 0)
3458
d25bc039237b [project @ 2000-01-19 09:36:14 by jwe]
jwe
parents: 3457
diff changeset
88 error ("quaternion: vv is zero");
3452
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
89 elseif (abs (norm (vv) - 1) > 1e-12)
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
90 warning ("quaternion: ||vv|| != 1, normalizing")
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
91 vv = vv / norm (vv);
3224
1e7532b9173b [project @ 1998-12-04 22:08:23 by jwe]
jwe
parents:
diff changeset
92 endif
1e7532b9173b [project @ 1998-12-04 22:08:23 by jwe]
jwe
parents:
diff changeset
93
3452
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
94 if (abs (theta) > 2*pi)
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
95 warning ("quaternion: |theta| > 2 pi, normalizing")
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
96 theta = rem (theta, 2*pi);
3224
1e7532b9173b [project @ 1998-12-04 22:08:23 by jwe]
jwe
parents:
diff changeset
97 endif
3452
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
98 vv = vv * sin (theta / 2);
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
99 d = cos (theta / 2);
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
100 a = quaternion (vv(1), vv(2), vv(3), d);
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
101
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
102 case(4)
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
103 if (nargout != 1)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5307
diff changeset
104 print_usage ();
3452
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
105 endif
4030
22bd65326ec1 [project @ 2002-08-09 18:58:13 by jwe]
jwe
parents: 3458
diff changeset
106 if (! (isscalar (w) && isscalar (x) && isscalar (y) && isscalar (z)))
3458
d25bc039237b [project @ 2000-01-19 09:36:14 by jwe]
jwe
parents: 3457
diff changeset
107 error ("input values must be scalars");
3452
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
108 endif
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
109 a = [w, x, y, z];
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
110
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
111 otherwise
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5307
diff changeset
112 print_usage ();
3452
a892190f4977 [project @ 2000-01-18 06:00:57 by jwe]
jwe
parents: 3426
diff changeset
113
3224
1e7532b9173b [project @ 1998-12-04 22:08:23 by jwe]
jwe
parents:
diff changeset
114 endswitch
1e7532b9173b [project @ 1998-12-04 22:08:23 by jwe]
jwe
parents:
diff changeset
115
1e7532b9173b [project @ 1998-12-04 22:08:23 by jwe]
jwe
parents:
diff changeset
116 endfunction