Mercurial > octave
annotate scripts/polynomial/roots.m @ 10821:693e22af08ae
Grammarcheck documentation of m-files
Add newlines between @item fields for readability.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Mon, 26 Jul 2010 21:25:36 -0700 |
| parents | f0c3d3fc4903 |
| children | fd0a3ac60b0e |
| rev | line source |
|---|---|
| 7017 | 1 ## Copyright (C) 1994, 1995, 1996, 1997, 1999, 2000, 2004, 2005, 2006, |
| 8920 | 2 ## 2007, 2008, 2009 John W. Eaton |
| 2313 | 3 ## |
| 4 ## This file is part of Octave. | |
| 5 ## | |
| 6 ## Octave is free software; you can redistribute it and/or modify it | |
| 7 ## under the terms of the GNU General Public License as published by | |
| 7016 | 8 ## the Free Software Foundation; either version 3 of the License, or (at |
| 9 ## your option) any later version. | |
| 2313 | 10 ## |
| 11 ## Octave is distributed in the hope that it will be useful, but | |
| 12 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 14 ## General Public License for more details. | |
| 15 ## | |
| 16 ## You should have received a copy of the GNU General Public License | |
| 7016 | 17 ## along with Octave; see the file COPYING. If not, see |
| 18 ## <http://www.gnu.org/licenses/>. | |
| 1025 | 19 |
| 3368 | 20 ## -*- texinfo -*- |
| 21 ## @deftypefn {Function File} {} roots (@var{v}) | |
| 3426 | 22 ## |
| 3499 | 23 ## For a vector @var{v} with @math{N} components, return |
| 3368 | 24 ## the roots of the polynomial |
| 25 ## @tex | |
| 26 ## $$ | |
| 27 ## v_1 z^{N-1} + \cdots + v_{N-1} z + v_N. | |
| 28 ## $$ | |
| 29 ## @end tex | |
| 6850 | 30 ## @ifnottex |
| 3426 | 31 ## |
| 3368 | 32 ## @example |
|
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
33 ## v(1) * z^(N-1) + @dots{} + v(N-1) * z + v(N) |
| 3368 | 34 ## @end example |
|
10821
693e22af08ae
Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents:
9211
diff
changeset
|
35 ## |
| 6850 | 36 ## @end ifnottex |
| 37 ## | |
| 38 ## As an example, the following code finds the roots of the quadratic | |
| 39 ## polynomial | |
| 40 ## @tex | |
| 41 ## $$ p(x) = x^2 - 5. $$ | |
| 42 ## @end tex | |
| 43 ## @ifnottex | |
|
10821
693e22af08ae
Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents:
9211
diff
changeset
|
44 ## |
| 6850 | 45 ## @example |
| 46 ## p(x) = x^2 - 5. | |
| 47 ## @end example | |
|
10821
693e22af08ae
Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents:
9211
diff
changeset
|
48 ## |
| 6850 | 49 ## @end ifnottex |
|
10821
693e22af08ae
Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents:
9211
diff
changeset
|
50 ## |
| 6850 | 51 ## @example |
|
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
52 ## @group |
| 6850 | 53 ## c = [1, 0, -5]; |
| 54 ## roots(c) | |
| 55 ## @result{} 2.2361 | |
| 56 ## @result{} -2.2361 | |
|
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
57 ## @end group |
| 6850 | 58 ## @end example |
|
10821
693e22af08ae
Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents:
9211
diff
changeset
|
59 ## |
| 6850 | 60 ## Note that the true result is |
| 61 ## @tex | |
| 62 ## $\pm \sqrt{5}$ | |
| 63 ## @end tex | |
| 64 ## @ifnottex | |
| 65 ## @math{+/- sqrt(5)} | |
| 66 ## @end ifnottex | |
| 67 ## which is roughly | |
| 68 ## @tex | |
| 69 ## $\pm 2.2361$. | |
| 70 ## @end tex | |
| 71 ## @ifnottex | |
| 72 ## @math{+/- 2.2361}. | |
| 73 ## @end ifnottex | |
| 74 ## @seealso{compan} | |
| 3368 | 75 ## @end deftypefn |
| 2311 | 76 |
| 5428 | 77 ## Author: KH <Kurt.Hornik@wu-wien.ac.at> |
| 2312 | 78 ## Created: 24 December 1993 |
| 79 ## Adapted-By: jwe | |
| 80 | |
| 787 | 81 function r = roots (v) |
| 904 | 82 |
| 6372 | 83 if (nargin != 1 || min (size (v)) > 1) |
| 6046 | 84 print_usage (); |
|
7558
690c91f741b8
Apply a scaling factor to leading zero removal in roots.m
Sebastien Loisel
parents:
7411
diff
changeset
|
85 elseif (any (isnan(v) | isinf(v))) |
| 8664 | 86 error ("roots: inputs must not contain Inf or NaN"); |
| 1598 | 87 endif |
| 2325 | 88 |
|
7558
690c91f741b8
Apply a scaling factor to leading zero removal in roots.m
Sebastien Loisel
parents:
7411
diff
changeset
|
89 n = numel (v); |
|
690c91f741b8
Apply a scaling factor to leading zero removal in roots.m
Sebastien Loisel
parents:
7411
diff
changeset
|
90 v = v(:); |
| 1025 | 91 |
| 2303 | 92 ## If v = [ 0 ... 0 v(k+1) ... v(k+l) 0 ... 0 ], we can remove the |
| 2325 | 93 ## leading k zeros and n - k - l roots of the polynomial are zero. |
| 904 | 94 |
|
7558
690c91f741b8
Apply a scaling factor to leading zero removal in roots.m
Sebastien Loisel
parents:
7411
diff
changeset
|
95 if (isempty (v)) |
|
690c91f741b8
Apply a scaling factor to leading zero removal in roots.m
Sebastien Loisel
parents:
7411
diff
changeset
|
96 f = v; |
|
690c91f741b8
Apply a scaling factor to leading zero removal in roots.m
Sebastien Loisel
parents:
7411
diff
changeset
|
97 else |
|
690c91f741b8
Apply a scaling factor to leading zero removal in roots.m
Sebastien Loisel
parents:
7411
diff
changeset
|
98 f = find (v ./ max (abs (v))); |
|
690c91f741b8
Apply a scaling factor to leading zero removal in roots.m
Sebastien Loisel
parents:
7411
diff
changeset
|
99 endif |
|
690c91f741b8
Apply a scaling factor to leading zero removal in roots.m
Sebastien Loisel
parents:
7411
diff
changeset
|
100 m = numel (f); |
| 2325 | 101 |
| 1598 | 102 if (m > 0 && n > 1) |
| 103 v = v(f(1):f(m)); | |
| 787 | 104 l = max (size (v)); |
| 105 if (l > 1) | |
| 106 A = diag (ones (1, l-2), -1); | |
| 1598 | 107 A(1,:) = -v(2:l) ./ v(1); |
| 2325 | 108 r = eig (A); |
| 1598 | 109 if (f(m) < n) |
| 110 tmp = zeros (n - f(m), 1); | |
| 3426 | 111 r = [r; tmp]; |
| 787 | 112 endif |
| 113 else | |
| 114 r = zeros (n - f(m), 1); | |
| 115 endif | |
| 116 else | |
| 1598 | 117 r = []; |
| 787 | 118 endif |
| 2325 | 119 |
| 787 | 120 endfunction |
| 7411 | 121 |
|
7558
690c91f741b8
Apply a scaling factor to leading zero removal in roots.m
Sebastien Loisel
parents:
7411
diff
changeset
|
122 %!test |
|
690c91f741b8
Apply a scaling factor to leading zero removal in roots.m
Sebastien Loisel
parents:
7411
diff
changeset
|
123 %! p = [poly([3 3 3 3]), 0 0 0 0]; |
|
690c91f741b8
Apply a scaling factor to leading zero removal in roots.m
Sebastien Loisel
parents:
7411
diff
changeset
|
124 %! r = sort (roots (p)); |
|
690c91f741b8
Apply a scaling factor to leading zero removal in roots.m
Sebastien Loisel
parents:
7411
diff
changeset
|
125 %! assert (r, [0; 0; 0; 0; 3; 3; 3; 3], 0.001) |
|
690c91f741b8
Apply a scaling factor to leading zero removal in roots.m
Sebastien Loisel
parents:
7411
diff
changeset
|
126 |
| 7411 | 127 %!assert(all (all (abs (roots ([1, -6, 11, -6]) - [3; 2; 1]) < sqrt (eps)))); |
| 128 | |
| 129 %!assert(isempty (roots ([]))); | |
| 130 | |
| 131 %!error roots ([1, 2; 3, 4]); | |
|
7558
690c91f741b8
Apply a scaling factor to leading zero removal in roots.m
Sebastien Loisel
parents:
7411
diff
changeset
|
132 |
|
690c91f741b8
Apply a scaling factor to leading zero removal in roots.m
Sebastien Loisel
parents:
7411
diff
changeset
|
133 %!assert(isempty (roots (1))); |
| 7411 | 134 |
|
10821
693e22af08ae
Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents:
9211
diff
changeset
|
135 %!error roots ([1, 2; 3, 4]); |
|
7558
690c91f741b8
Apply a scaling factor to leading zero removal in roots.m
Sebastien Loisel
parents:
7411
diff
changeset
|
136 |
|
690c91f741b8
Apply a scaling factor to leading zero removal in roots.m
Sebastien Loisel
parents:
7411
diff
changeset
|
137 %!error roots ([1 Inf 1]); |
|
690c91f741b8
Apply a scaling factor to leading zero removal in roots.m
Sebastien Loisel
parents:
7411
diff
changeset
|
138 |
|
690c91f741b8
Apply a scaling factor to leading zero removal in roots.m
Sebastien Loisel
parents:
7411
diff
changeset
|
139 %!error roots ([1 NaN 1]); |
|
690c91f741b8
Apply a scaling factor to leading zero removal in roots.m
Sebastien Loisel
parents:
7411
diff
changeset
|
140 |
|
690c91f741b8
Apply a scaling factor to leading zero removal in roots.m
Sebastien Loisel
parents:
7411
diff
changeset
|
141 %!assert(roots ([1e-200, -1e200, 1]), 1e-200) |
|
690c91f741b8
Apply a scaling factor to leading zero removal in roots.m
Sebastien Loisel
parents:
7411
diff
changeset
|
142 %!assert(roots ([1e-200, -1e200 * 1i, 1]), -1e-200 * 1i) |