octave_packages/m/polynomial/polygcd.m

   1 ## Copyright (C) 2000-2012 Paul Kienzle
   2 ##
   3 ## This file is part of Octave.
   4 ##
   5 ## Octave is free software; you can redistribute it and/or modify it
   6 ## under the terms of the GNU General Public License as published by
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   9 ##
  10 ## Octave is distributed in the hope that it will be useful, but
  11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 ## General Public License for more details.
  14 ##
  15 ## You should have received a copy of the GNU General Public License
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn  {Function File} {@var{q} =} polygcd (@var{b}, @var{a})
  21 ## @deftypefnx {Function File} {@var{q} =} polygcd (@var{b}, @var{a}, @var{tol})
  22 ##
  23 ## Find the greatest common divisor of two polynomials.  This is equivalent
  24 ## to the polynomial found by multiplying together all the common roots.
  25 ## Together with deconv, you can reduce a ratio of two polynomials.
  26 ## The tolerance @var{tol} defaults to @code{sqrt(eps)}.
  27 ##
  28 ## @strong{Caution:} This is a numerically unstable algorithm and should not
  29 ## be used on large polynomials.
  30 ##
  31 ## Example code:
  32 ##
  33 ## @example
  34 ## @group
  35 ## polygcd (poly (1:8), poly (3:12)) - poly (3:8)
  36 ## @result{} [ 0, 0, 0, 0, 0, 0, 0 ]
  37 ## deconv (poly (1:8), polygcd (poly (1:8), poly (3:12))) - poly(1:2)
  38 ## @result{} [ 0, 0, 0 ]
  39 ## @end group
  40 ## @end example
  41 ## @seealso{poly, roots, conv, deconv, residue}
  42 ## @end deftypefn
  43
  44 function x = polygcd (b, a, tol)
  45
  46   if (nargin == 2 || nargin == 3)
  47     if (nargin == 2)
  48       if (isa (a, "single") || isa (b, "single"))
  49         tol = sqrt (eps ("single"));
  50       else
  51         tol = sqrt (eps);
  52       endif
  53     endif
  54     if (length (a) == 1 || length (b) == 1)
  55       if (a == 0)
  56         x = b;
  57       elseif (b == 0)
  58         x = a;
  59       else
  60         x = 1;
  61       endif
  62     else
  63       a /= a(1);
  64       while (1)
  65         [d, r] = deconv (b, a);
  66         nz = find (abs (r) > tol);
  67         if (isempty (nz))
  68           x = a;
  69           break;
  70         else
  71           r = r(nz(1):length(r));
  72         endif
  73         b = a;
  74         a = r / r(1);
  75       endwhile
  76     endif
  77   else
  78     print_usage ();
  79   endif
  80
  81 endfunction
  82
  83
  84 %!test
  85 %! poly1 = [1 6 11 6]; % (x+1)(x+2)(x+3)
  86 %! poly2 = [1 3 2]; % (x+1)(x+2)
  87 %! poly3 = polygcd (poly1, poly2);
  88 %! assert (poly3, poly2, sqrt (eps))
  89
  90 %!test
  91 %! assert (polygcd (poly(1:8), poly(3:12)), poly(3:8), sqrt (eps))
  92
  93 %!test
  94 %! assert (deconv (poly(1:8), polygcd (poly(1:8), poly(3:12))), poly(1:2), sqrt (eps))
  95
  96 %!test
  97 %! for ii=1:10
  98 %!   p  = (unique (randn (10, 1)) * 10).';
  99 %!   p1 = p(3:end);
 100 %!   p2 = p(1:end-2);
 101 %!   assert (polygcd (poly (-p1), poly (-p2)), poly (- intersect (p1, p2)), sqrt (eps))
 102 %! endfor