annotate scripts/polynomial/mpoles.m @ 27919:1891570abac8

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2020.
author John W. Eaton <jwe@octave.org>
date Mon, 06 Jan 2020 22:29:51 -0500
parents b442ec6dda5c
children bd51beb6205e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27919
1891570abac8 update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 27918
diff changeset
1 ## Copyright (C) 2007-2020 The Octave Project Developers
27918
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
2 ##
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
3 ## See the file COPYRIGHT.md in the top-level directory of this distribution
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
4 ## or <https://octave.org/COPYRIGHT.html/>.
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
5 ##
6964
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
6 ##
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
7 ## This file is part of Octave.
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
8 ##
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
9 ## Octave is free software: you can redistribute it and/or modify it
6964
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
10 ## under the terms of the GNU General Public License as published by
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
11 ## the Free Software Foundation, either version 3 of the License, or
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
12 ## (at your option) any later version.
6964
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
13 ##
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
14 ## 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
15 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
16 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
17 ## GNU General Public License for more details.
6964
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
18 ##
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
19 ## 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: 6998
diff changeset
20 ## along with Octave; see the file COPYING. If not, see
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
21 ## <https://www.gnu.org/licenses/>.
6964
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
22
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
23 ## -*- texinfo -*-
20852
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20165
diff changeset
24 ## @deftypefn {} {[@var{multp}, @var{idxp}] =} mpoles (@var{p})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20165
diff changeset
25 ## @deftypefnx {} {[@var{multp}, @var{idxp}] =} mpoles (@var{p}, @var{tol})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20165
diff changeset
26 ## @deftypefnx {} {[@var{multp}, @var{idxp}] =} mpoles (@var{p}, @var{tol}, @var{reorder})
20165
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
27 ## Identify unique poles in @var{p} and their associated multiplicity.
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
28 ##
20165
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
29 ## The output is ordered from largest pole to smallest pole.
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
30 ##
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
31 ## If the relative difference of two poles is less than @var{tol} then they are
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
32 ## considered to be multiples. The default value for @var{tol} is 0.001.
6964
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
33 ##
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
34 ## 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
35 ##
20165
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
36 ## The output @var{multp} is a vector specifying the multiplicity of the poles.
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
37 ## @code{@var{multp}(n)} refers to the multiplicity of the Nth pole
14104
614505385171 doc: Overhaul docstrings for polynomial functions.
Rik <octave@nomad.inbox5.com>
parents: 13963
diff changeset
38 ## @code{@var{p}(@var{idxp}(n))}.
6964
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
39 ##
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
40 ## For example:
6964
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
41 ##
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
42 ## @example
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
43 ## @group
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
44 ## p = [2 3 1 1 2];
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
45 ## [m, n] = mpoles (p)
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
46 ## @result{} m = [1; 1; 2; 1; 2]
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
47 ## @result{} n = [2; 5; 1; 4; 3]
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
48 ## @result{} p(n) = [3, 2, 2, 1, 1]
6964
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
49 ## @end group
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
50 ## @end example
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
51 ##
14104
614505385171 doc: Overhaul docstrings for polynomial functions.
Rik <octave@nomad.inbox5.com>
parents: 13963
diff changeset
52 ## @seealso{residue, poly, roots, conv, deconv}
6964
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
53 ## @end deftypefn
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
54
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
55 ## Author: Ben Abbott <bpabbott@mac.com>
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
56 ## Created: Sept 30, 2007
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
57
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
58 function [multp, indx] = mpoles (p, tol, reorder)
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 < 1 || nargin > 3)
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
61 print_usage ();
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 < 2 || isempty (tol))
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
65 tol = 0.001;
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 if (nargin < 3 || isempty (reorder))
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
69 reorder = true;
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
70 endif
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 Np = numel (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 ## Force the poles to be a column vector.
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 p = p(:);
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
77
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
78 ## Sort the poles according to their magnitidues, largest first.
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
79
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
80 if (reorder)
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
81 ## Sort with smallest magnitude first.
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
82 [p, ordr] = sort (p);
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
83 ## Reverse order, largest maginitude first.
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
84 n = Np:-1:1;
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
85 p = p(n);
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
86 ordr = ordr(n);
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
87 else
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
88 ordr = 1:Np;
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
89 endif
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
90
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
91 ## Find pole multiplicty by comparing the relative differnce in the
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
92 ## poles.
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
93
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
94 multp = zeros (Np, 1);
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
95 indx = [];
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
96 n = find (multp == 0, 1);
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
97 while (n)
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
98 dp = abs (p-p(n));
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
99 if (p(n) == 0.0)
9360
df42106beec8 mpoles.m: Fix infinite loop for a multiplicity of poles at zero. Test added.
Ben Abbott <bpabbott@mac.com>
parents: 9245
diff changeset
100 if (any (abs (p) > 0 & isfinite (p)))
df42106beec8 mpoles.m: Fix infinite loop for a multiplicity of poles at zero. Test added.
Ben Abbott <bpabbott@mac.com>
parents: 9245
diff changeset
101 p0 = mean (abs (p(abs (p) > 0 & isfinite (p))));
df42106beec8 mpoles.m: Fix infinite loop for a multiplicity of poles at zero. Test added.
Ben Abbott <bpabbott@mac.com>
parents: 9245
diff changeset
102 else
6964
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
103 p0 = 1;
7151
aeeb646f6538 [project @ 2007-11-09 19:34:17 by jwe]
jwe
parents: 7016
diff changeset
104 endif
6964
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
105 else
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
106 p0 = abs (p(n));
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
107 endif
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
108 k = find (dp < tol * p0);
7360
1e716cb4b2a3 [project @ 2008-01-11 02:59:02 by jwe]
jwe
parents: 7151
diff changeset
109 ## Poles can only be members of one multiplicity group.
1e716cb4b2a3 [project @ 2008-01-11 02:59:02 by jwe]
jwe
parents: 7151
diff changeset
110 if (numel (indx))
1e716cb4b2a3 [project @ 2008-01-11 02:59:02 by jwe]
jwe
parents: 7151
diff changeset
111 k = k(! ismember (k, indx));
1e716cb4b2a3 [project @ 2008-01-11 02:59:02 by jwe]
jwe
parents: 7151
diff changeset
112 endif
6964
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
113 m = 1:numel (k);
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
114 multp(k) = m;
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
115 indx = [indx; k];
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
116 n = find (multp == 0, 1);
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
117 endwhile
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
118 multp = multp(indx);
6998
cc049a392a97 [project @ 2007-10-10 16:51:51 by jwe]
jwe
parents: 6964
diff changeset
119 indx = ordr(indx);
6964
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
120
33f20a41aeea [project @ 2007-10-06 04:31:18 by jwe]
jwe
parents:
diff changeset
121 endfunction
9360
df42106beec8 mpoles.m: Fix infinite loop for a multiplicity of poles at zero. Test added.
Ben Abbott <bpabbott@mac.com>
parents: 9245
diff changeset
122
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
123
9360
df42106beec8 mpoles.m: Fix infinite loop for a multiplicity of poles at zero. Test added.
Ben Abbott <bpabbott@mac.com>
parents: 9245
diff changeset
124 %!test
df42106beec8 mpoles.m: Fix infinite loop for a multiplicity of poles at zero. Test added.
Ben Abbott <bpabbott@mac.com>
parents: 9245
diff changeset
125 %! [mp, n] = mpoles ([0 0], 0.01);
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
126 %! assert (mp, [1; 2]);