octave_packages/m/polynomial/polyint.m

   1 ## Copyright (C) 1996-2012 John W. Eaton
   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} {} polyint (@var{p})
  21 ## @deftypefnx {Function File} {} polyint (@var{p}, @var{k})
  22 ## Return the coefficients of the integral of the polynomial whose
  23 ## coefficients are represented by the vector @var{p}.  The variable
  24 ## @var{k} is the constant of integration, which by default is set to zero.
  25 ## @seealso{polyder, polyval}
  26 ## @end deftypefn
  27
  28 ## Author: Tony Richardson <arichard@stark.cc.oh.us>
  29 ## Created: June 1994
  30 ## Adapted-By: jwe
  31
  32 function retval = polyint (p, k)
  33
  34   if (nargin < 1 || nargin > 2)
  35     print_usage ();
  36   endif
  37
  38   if (nargin == 1)
  39     k = 0;
  40   elseif (! isscalar (k))
  41     error ("polyint: the constant of integration must be a scalar");
  42   endif
  43
  44   if (! (isvector (p) || isempty (p)))
  45     error ("polyint: argument must be a vector");
  46   endif
  47
  48   lp = length (p);
  49
  50   if (lp == 0)
  51     retval = [];
  52     return;
  53   endif
  54
  55   if (rows (p) > 1)
  56     ## Convert to column vector
  57     p = p.';
  58   endif
  59
  60   retval = [(p ./ [lp:-1:1]), k];
  61
  62 endfunction
  63
  64 %!test
  65 %! A = [3, 2, 1];
  66 %! assert (polyint(A),polyint(A,0));
  67 %! assert (polyint(A),polyint(A'));
  68 %! assert (polyint(A),[1, 1, 1, 0]);
  69 %! assert (polyint(A,1),ones(1,4));
  70
  71 %!test
  72 %! A = ones(1,8);
  73 %! B = [length(A):-1:1];
  74 %! assert (polyint(A),[1./B, 0]);
  75
  76 %!error polyint()
  77 %!error polyint(ones(2,2))