annotate scripts/polynomial/roots.m @ 7017:a1dbe9d80eee

[project @ 2007-10-12 21:27:11 by jwe]
author jwe
date Fri, 12 Oct 2007 21:27:37 +0000
parents 93c65f2a5668
children 83a8781b529d b1368dc9e719
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) 1994, 1995, 1996, 1997, 1999, 2000, 2004, 2005, 2006,
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
2 ## 2007 John W. Eaton
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
3 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
4 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
5 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
6 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
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: 6850
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: 6850
diff changeset
9 ## your option) any later version.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
10 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
11 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
14 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
15 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
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: 6850
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: 6850
diff changeset
18 ## <http://www.gnu.org/licenses/>.
1025
f558749713f1 [project @ 1995-01-11 20:52:10 by jwe]
jwe
parents: 944
diff changeset
19
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 2847
diff changeset
20 ## -*- texinfo -*-
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 2847
diff changeset
21 ## @deftypefn {Function File} {} roots (@var{v})
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3368
diff changeset
22 ##
3499
3e3e14ad5149 [project @ 2000-01-31 05:18:07 by jwe]
jwe
parents: 3426
diff changeset
23 ## For a vector @var{v} with @math{N} components, return
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 2847
diff changeset
24 ## the roots of the polynomial
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 2847
diff changeset
25 ## @iftex
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 2847
diff changeset
26 ## @tex
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 2847
diff changeset
27 ## $$
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 2847
diff changeset
28 ## v_1 z^{N-1} + \cdots + v_{N-1} z + v_N.
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 2847
diff changeset
29 ## $$
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 2847
diff changeset
30 ## @end tex
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 2847
diff changeset
31 ## @end iftex
6850
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
32 ## @ifnottex
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3368
diff changeset
33 ##
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 2847
diff changeset
34 ## @example
5016
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 3499
diff changeset
35 ## v(1) * z^(N-1) + ... + v(N-1) * z + v(N)
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 2847
diff changeset
36 ## @end example
6850
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
37 ## @end ifnottex
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
38 ##
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
39 ## As an example, the following code finds the roots of the quadratic
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
40 ## polynomial
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
41 ## @iftex
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
42 ## @tex
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
43 ## $$ p(x) = x^2 - 5. $$
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
44 ## @end tex
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
45 ## @end iftex
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
46 ## @ifnottex
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
47 ## @example
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
48 ## p(x) = x^2 - 5.
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
49 ## @end example
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
50 ## @end ifnottex
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
51 ## @example
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
52 ## c = [1, 0, -5];
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
53 ## roots(c)
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
54 ## @result{} 2.2361
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
55 ## @result{} -2.2361
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
56 ## @end example
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
57 ## Note that the true result is
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
58 ## @iftex
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
59 ## @tex
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
60 ## $\pm \sqrt{5}$
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
61 ## @end tex
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
62 ## @end iftex
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
63 ## @ifnottex
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
64 ## @math{+/- sqrt(5)}
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
65 ## @end ifnottex
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
66 ## which is roughly
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
67 ## @iftex
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
68 ## @tex
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
69 ## $\pm 2.2361$.
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
70 ## @end tex
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
71 ## @end iftex
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
72 ## @ifnottex
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
73 ## @math{+/- 2.2361}.
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
74 ## @end ifnottex
9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe]
jwe
parents: 6372
diff changeset
75 ## @seealso{compan}
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 2847
diff changeset
76 ## @end deftypefn
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
77
5428
2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe]
jwe
parents: 5307
diff changeset
78 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
2312
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
79 ## Created: 24 December 1993
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
80 ## Adapted-By: jwe
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
81
787
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
82 function r = roots (v)
904
3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe]
jwe
parents: 787
diff changeset
83
6372
a9a95bb1bf9e [project @ 2007-03-01 15:39:30 by jwe]
jwe
parents: 6046
diff changeset
84 if (nargin != 1 || min (size (v)) > 1)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5428
diff changeset
85 print_usage ();
1598
3739611f0803 [project @ 1995-11-01 01:35:40 by jwe]
jwe
parents: 1337
diff changeset
86 endif
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2313
diff changeset
87
1598
3739611f0803 [project @ 1995-11-01 01:35:40 by jwe]
jwe
parents: 1337
diff changeset
88 n = length (v);
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2313
diff changeset
89 v = reshape (v, 1, n);
1025
f558749713f1 [project @ 1995-01-11 20:52:10 by jwe]
jwe
parents: 944
diff changeset
90
2303
5cffc4b8de57 [project @ 1996-06-24 09:15:24 by jwe]
jwe
parents: 1887
diff changeset
91 ## If v = [ 0 ... 0 v(k+1) ... v(k+l) 0 ... 0 ], we can remove the
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2313
diff changeset
92 ## leading k zeros and n - k - l roots of the polynomial are zero.
904
3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe]
jwe
parents: 787
diff changeset
93
787
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
94 f = find (v);
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
95 m = max (size (f));
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2313
diff changeset
96
1598
3739611f0803 [project @ 1995-11-01 01:35:40 by jwe]
jwe
parents: 1337
diff changeset
97 if (m > 0 && n > 1)
3739611f0803 [project @ 1995-11-01 01:35:40 by jwe]
jwe
parents: 1337
diff changeset
98 v = v(f(1):f(m));
787
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
99 l = max (size (v));
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
100 if (l > 1)
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
101 A = diag (ones (1, l-2), -1);
1598
3739611f0803 [project @ 1995-11-01 01:35:40 by jwe]
jwe
parents: 1337
diff changeset
102 A(1,:) = -v(2:l) ./ v(1);
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2313
diff changeset
103 r = eig (A);
1598
3739611f0803 [project @ 1995-11-01 01:35:40 by jwe]
jwe
parents: 1337
diff changeset
104 if (f(m) < n)
3739611f0803 [project @ 1995-11-01 01:35:40 by jwe]
jwe
parents: 1337
diff changeset
105 tmp = zeros (n - f(m), 1);
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3368
diff changeset
106 r = [r; tmp];
787
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
107 endif
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
108 else
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
109 r = zeros (n - f(m), 1);
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
110 endif
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
111 else
1598
3739611f0803 [project @ 1995-11-01 01:35:40 by jwe]
jwe
parents: 1337
diff changeset
112 r = [];
787
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
113 endif
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2313
diff changeset
114
787
c5d35bb139b6 [project @ 1994-10-11 00:34:13 by jwe]
jwe
parents:
diff changeset
115 endfunction