octave: scripts/polynomial/polygcd.m annotate

annotate scripts/polynomial/polygcd.m @ 30564:796f54d4ddbf stable

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2021. In all .txi and .texi files except gpl.txi and gpl.texi in the doc/liboctave and doc/interpreter directories, change the copyright to "Octave Project Developers", the same as used for other source files. Update copyright notices for 2022 (not done since 2019). For gpl.txi and gpl.texi, change the copyright notice to be "Free Software Foundation, Inc." and leave the date at 2007 only because this file only contains the text of the GPL, not anything created by the Octave Project Developers. Add Paul Thomas to contributors.in.

author	John W. Eaton <jwe@octave.org>
date	Tue, 28 Dec 2021 18:22:40 -0500
parents	01de0045b2e3
children	597f3ee61a48

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ########################################################################
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 ##
30564 796f54d4ddbf update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 30330 diff changeset	3 ## Copyright (C) 2000-2022 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	4 ##
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 ## See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 ## distribution or <https://octave.org/copyright/>.
5216 5ed60b8b1ac4 [project @ 2005-03-16 19:51:39 by jwe] jwe parents: diff changeset	7 ##
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6850 diff changeset	8 ## This file is part of Octave.
5216 5ed60b8b1ac4 [project @ 2005-03-16 19:51:39 by jwe] jwe parents: diff changeset	9 ##
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	10 ## Octave is free software: you can redistribute it and/or modify it
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6850 diff changeset	11 ## 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	12 ## 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	13 ## (at your option) any later version.
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6850 diff changeset	14 ##
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6850 diff changeset	15 ## Octave is distributed in the hope that it will be useful, but
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6850 diff changeset	16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	18 ## GNU General Public License for more details.
5216 5ed60b8b1ac4 [project @ 2005-03-16 19:51:39 by jwe] jwe parents: diff changeset	19 ##
5ed60b8b1ac4 [project @ 2005-03-16 19:51:39 by jwe] jwe parents: diff changeset	20 ## 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	21 ## 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	22 ## <https://www.gnu.org/licenses/>.
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 ##
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ########################################################################
5216 5ed60b8b1ac4 [project @ 2005-03-16 19:51:39 by jwe] jwe parents: diff changeset	25
5ed60b8b1ac4 [project @ 2005-03-16 19:51:39 by jwe] jwe parents: diff changeset	26 ## -- texinfo --
20852 516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20165 diff changeset	27 ## @deftypefn {} {@var{q} =} polygcd (@var{b}, @var{a})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20165 diff changeset	28 ## @deftypefnx {} {@var{q} =} polygcd (@var{b}, @var{a}, @var{tol})
5216 5ed60b8b1ac4 [project @ 2005-03-16 19:51:39 by jwe] jwe parents: diff changeset	29 ##
20165 f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	30 ## Find the greatest common divisor of two polynomials.
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	31 ##
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	32 ## This is equivalent to the polynomial found by multiplying together all the
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	33 ## common roots. Together with deconv, you can reduce a ratio of two
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	34 ## polynomials.
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	35 ##
14868 5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14363 diff changeset	36 ## The tolerance @var{tol} defaults to @code{sqrt (eps)}.
5216 5ed60b8b1ac4 [project @ 2005-03-16 19:51:39 by jwe] jwe parents: diff changeset	37 ##
14327 4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	38 ## @strong{Caution:} This is a numerically unstable algorithm and should not
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	39 ## be used on large polynomials.
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10549 diff changeset	40 ##
14104 614505385171 doc: Overhaul docstrings for polynomial functions. Rik <octave@nomad.inbox5.com> parents: 13963 diff changeset	41 ## Example code:
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10549 diff changeset	42 ##
5216 5ed60b8b1ac4 [project @ 2005-03-16 19:51:39 by jwe] jwe parents: diff changeset	43 ## @example
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	44 ## @group
14327 4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	45 ## polygcd (poly (1:8), poly (3:12)) - poly (3:8)
6850 9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe] jwe parents: 6046 diff changeset	46 ## @result{} [ 0, 0, 0, 0, 0, 0, 0 ]
14868 5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14363 diff changeset	47 ## deconv (poly (1:8), polygcd (poly (1:8), poly (3:12))) - poly (1:2)
6850 9398f6a81bdf [project @ 2007-08-31 17:29:22 by jwe] jwe parents: 6046 diff changeset	48 ## @result{} [ 0, 0, 0 ]
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	49 ## @end group
5216 5ed60b8b1ac4 [project @ 2005-03-16 19:51:39 by jwe] jwe parents: diff changeset	50 ## @end example
14104 614505385171 doc: Overhaul docstrings for polynomial functions. Rik <octave@nomad.inbox5.com> parents: 13963 diff changeset	51 ## @seealso{poly, roots, conv, deconv, residue}
5642 2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5382 diff changeset	52 ## @end deftypefn
5216 5ed60b8b1ac4 [project @ 2005-03-16 19:51:39 by jwe] jwe parents: diff changeset	53
5217 e88886a6934d [project @ 2005-03-16 20:03:01 by jwe] jwe parents: 5216 diff changeset	54 function x = polygcd (b, a, tol)
e88886a6934d [project @ 2005-03-16 20:03:01 by jwe] jwe parents: 5216 diff changeset	55
28789 28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 27923 diff changeset	56 if (nargin < 2)
28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 27923 diff changeset	57 print_usage ();
28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 27923 diff changeset	58 endif
28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 27923 diff changeset	59
28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 27923 diff changeset	60 if (nargin == 2)
28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 27923 diff changeset	61 if (isa (a, "single") \|\| isa (b, "single"))
28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 27923 diff changeset	62 tol = sqrt (eps ("single"));
28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 27923 diff changeset	63 else
28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 27923 diff changeset	64 tol = sqrt (eps);
5216 5ed60b8b1ac4 [project @ 2005-03-16 19:51:39 by jwe] jwe parents: diff changeset	65 endif
28789 28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 27923 diff changeset	66 endif
28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 27923 diff changeset	67 ## FIXME: No input validation of tol if it was user-supplied
28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 27923 diff changeset	68
28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 27923 diff changeset	69
28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 27923 diff changeset	70 if (length (a) == 1 \|\| length (b) == 1)
28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 27923 diff changeset	71 if (a == 0)
28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 27923 diff changeset	72 x = b;
28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 27923 diff changeset	73 elseif (b == 0)
28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 27923 diff changeset	74 x = a;
5217 e88886a6934d [project @ 2005-03-16 20:03:01 by jwe] jwe parents: 5216 diff changeset	75 else
28789 28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 27923 diff changeset	76 x = 1;
5217 e88886a6934d [project @ 2005-03-16 20:03:01 by jwe] jwe parents: 5216 diff changeset	77 endif
e88886a6934d [project @ 2005-03-16 20:03:01 by jwe] jwe parents: 5216 diff changeset	78 else
28789 28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 27923 diff changeset	79 a /= a(1);
28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 27923 diff changeset	80 while (1)
28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 27923 diff changeset	81 [d, r] = deconv (b, a);
28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 27923 diff changeset	82 nz = find (abs (r) > tol);
28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 27923 diff changeset	83 if (isempty (nz))
28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 27923 diff changeset	84 x = a;
28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 27923 diff changeset	85 break;
28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 27923 diff changeset	86 else
28912 0de38a6ef693 maint: Use Octave convention of space after function name in scripts dir. Rik <rik@octave.org> parents: 28789 diff changeset	87 r = r(nz(1):length (r));
28789 28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 27923 diff changeset	88 endif
28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 27923 diff changeset	89 b = a;
28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 27923 diff changeset	90 a = r / r(1);
28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 27923 diff changeset	91 endwhile
5216 5ed60b8b1ac4 [project @ 2005-03-16 19:51:39 by jwe] jwe parents: diff changeset	92 endif
5217 e88886a6934d [project @ 2005-03-16 20:03:01 by jwe] jwe parents: 5216 diff changeset	93
e88886a6934d [project @ 2005-03-16 20:03:01 by jwe] jwe parents: 5216 diff changeset	94 endfunction
13045 92cb87addf25 codesprint: Add tests to polygcd Carlo de Falco <kingcrimson@tiscali.it> parents: 11523 diff changeset	95
92cb87addf25 codesprint: Add tests to polygcd Carlo de Falco <kingcrimson@tiscali.it> parents: 11523 diff changeset	96
92cb87addf25 codesprint: Add tests to polygcd Carlo de Falco <kingcrimson@tiscali.it> parents: 11523 diff changeset	97 %!test
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	98 %! poly1 = [1 6 11 6]; # (x+1)(x+2)(x+3);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	99 %! poly2 = [1 3 2]; # (x+1)(x+2);
13045 92cb87addf25 codesprint: Add tests to polygcd Carlo de Falco <kingcrimson@tiscali.it> parents: 11523 diff changeset	100 %! poly3 = polygcd (poly1, poly2);
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	101 %! assert (poly3, poly2, sqrt (eps));
13045 92cb87addf25 codesprint: Add tests to polygcd Carlo de Falco <kingcrimson@tiscali.it> parents: 11523 diff changeset	102
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	103 %!assert (polygcd (poly (1:8), poly (3:12)), poly (3:8), sqrt (eps))
30330 01de0045b2e3 maint: Shorten some long lines to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 29359 diff changeset	104 %!assert (deconv (poly (1:8), polygcd (poly (1:8), poly (3:12))),
01de0045b2e3 maint: Shorten some long lines to <= 80 characters (bug #57599) Rik <rik@octave.org> parents: 29359 diff changeset	105 %! poly (1:2), sqrt (eps))
13045 92cb87addf25 codesprint: Add tests to polygcd Carlo de Falco <kingcrimson@tiscali.it> parents: 11523 diff changeset	106
13141 e81ddf9cacd5 maint: untabify and remove trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 13045 diff changeset	107 %!test
19224 5d3111977623 Change a polygcd test to one that is more numerically accurate (bug #42742). Daniel J Sebald <daniel.sebald@ieee.org> parents: 17744 diff changeset	108 %! for ii=1:100
5d3111977623 Change a polygcd test to one that is more numerically accurate (bug #42742). Daniel J Sebald <daniel.sebald@ieee.org> parents: 17744 diff changeset	109 %! ## Exhibits numerical problems for multipliers of ~4 and greater.
5d3111977623 Change a polygcd test to one that is more numerically accurate (bug #42742). Daniel J Sebald <daniel.sebald@ieee.org> parents: 17744 diff changeset	110 %! p = (unique (randn (10, 1)) * 3).';
13045 92cb87addf25 codesprint: Add tests to polygcd Carlo de Falco <kingcrimson@tiscali.it> parents: 11523 diff changeset	111 %! p1 = p(3:end);
92cb87addf25 codesprint: Add tests to polygcd Carlo de Falco <kingcrimson@tiscali.it> parents: 11523 diff changeset	112 %! p2 = p(1:end-2);
19224 5d3111977623 Change a polygcd test to one that is more numerically accurate (bug #42742). Daniel J Sebald <daniel.sebald@ieee.org> parents: 17744 diff changeset	113 %! assert (polygcd (poly (-p1), poly (-p2)),
5d3111977623 Change a polygcd test to one that is more numerically accurate (bug #42742). Daniel J Sebald <daniel.sebald@ieee.org> parents: 17744 diff changeset	114 %! poly (- intersect (p1, p2)), sqrt (eps));
13045 92cb87addf25 codesprint: Add tests to polygcd Carlo de Falco <kingcrimson@tiscali.it> parents: 11523 diff changeset	115 %! endfor

Mercurial > octave

annotate scripts/polynomial/polygcd.m @ 30564:796f54d4ddbf stable