annotate scripts/polynomial/mpoles.m @ 6964:33f20a41aeea

[project @ 2007-10-06 04:31:18 by jwe]
author jwe
date Sat, 06 Oct 2007 04:31:18 +0000
parents
children cc049a392a97
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6964
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
1 ## Copyright (C) 2007 Ben Abbott
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
2 ##
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
4 ##
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
7 ## the Free Software Foundation; either version 2, or (at your option)
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
8 ## any later version.
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
9 ##
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
14 ##
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, write to the Free
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
17 ## Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
18 ## 02110-1301, USA.
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
19
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
20 ## -*- texinfo -*-
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
21 ## @deftypefn {Function File} {[@var{multp}, @var{indx}] =} mpoles (@var{p})
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
22 ## @deftypefnx {Function File} {[@var{multp}, @var{indx}] =} mpoles (@var{p}, @var{tol})
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
23 ## @deftypefnx {Function File} {[@var{multp}, @var{indx}] =} mpoles (@var{p}, @var{tol}, @var{reorder})
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
24 ## Identifiy unique poles in @var{p} and associates their multiplicity,
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
25 ## ordering them from largest to smallest.
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
26 ##
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
27 ## If the relative difference of the poles is less than @var{tol}, then
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
28 ## they are considered to be multiples. The default value for @var{tol}
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
29 ## is 0.001.
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
30 ##
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
31 ## If the optional parameter @var{reorder} is zero, poles are not sorted.
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
32 ##
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
33 ## The value @var{multp} is a vector specifying the multiplicity of the
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
34 ## poles. @var{multp}(:) refers to mulitplicity of @var{p}(@var{indx}(:)).
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
35 ##
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
36 ## For example,
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
37 ##
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
38 ## @example
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
39 ## @group
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
40 ## p = [2 3 1 1 2];
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
41 ## [m, n] = mpoles(p);
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
42 ## @result{} m = [1; 1; 2; 1; 2]
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
43 ## @result{} n = [2; 5; 1; 4; 3]
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
44 ## @result{} p(n) = [3, 2, 2, 1, 1]
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
45 ## @end group
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
46 ## @end example
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
47 ##
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
48 ## @seealso{poly, roots, conv, deconv, polyval, polyderiv, polyinteg, residue}
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
49 ## @end deftypefn
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
50
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
51 ## Author: Ben Abbott <bpabbott@mac.com>
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
52 ## Created: Sept 30, 2007
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
53
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
54 function [multp, indx] = mpoles (p, tol, reorder)
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
55
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
56 if (nargin < 1 || nargin > 3)
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
57 print_usage ();
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
58 endif
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
59
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
60 if (nargin < 2 || isempty (tol))
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
61 tol = 0.001;
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
62 endif
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
63
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
64 if (nargin < 3 || isempty (reorder))
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
65 reorder = true;
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
66 endif
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
67
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
68 Np = numel (p);
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
69
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
70 ## Force the poles to be a column vector.
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
71
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
72 p = p(:);
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
73
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
74 ## Sort the poles according to their magnitidues, largest first.
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
75
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
76 if (reorder)
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
77 ## Sort with smallest magnitude first.
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
78 [p, ordr] = sort (p);
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
79 ## Reverse order, largest maginitude first.
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
80 n = Np:-1:1;
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
81 p = p(n);
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
82 ordr = ordr(n);
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
83 else
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
84 ordr = 1:Np;
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
85 endif
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
86
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
87 ## Find pole multiplicty by comparing the relative differnce in the
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
88 ## poles.
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
89
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
90 multp = zeros (Np, 1);
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
91 indx = [];
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
92 n = find (multp == 0, 1);
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
93 while (n)
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
94 dp = abs (p-p(n));
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
95 if (p(n) == 0.0)
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
96 p0 = mean (abs (p(find (abs (p) > 0))));
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
97 if (isempty (p0))
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
98 p0 = 1;
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
99 end
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
100 else
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
101 p0 = abs (p(n));
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
102 endif
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
103 k = find (dp < tol * p0);
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
104 m = 1:numel (k);
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
105 multp(k) = m;
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
106 indx = [indx; k];
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
107 n = find (multp == 0, 1);
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
108 endwhile
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
109 multp = multp(indx);
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
110 indx = indx(ordr);
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
111
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
112 endfunction