octave-nkf: scripts/polynomial/polyint.m annotate

annotate scripts/polynomial/polyint.m @ 20354:227d582fa300 stable

build: Sort generated PKG_ADD contents consistently * libinterp/mk-pkg-add: Set LC_COLLATE=C when sorting for consistent output.

author	Mike Miller <mtmiller@octave.org>
date	Fri, 10 Jul 2015 01:10:30 -0400
parents	f1d0f506ee78
children

rev	line source
19731 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	1 ## Copyright (C) 1996-2015 John W. Eaton
6853 02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	2 ##
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	3 ## This file is part of Octave.
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	4 ##
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	6 ## under the terms of the GNU General Public License as published by
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6853 diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6853 diff changeset	8 ## your option) any later version.
6853 02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	9 ##
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	13 ## General Public License for more details.
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	14 ##
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	15 ## 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: 6853 diff changeset	16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6853 diff changeset	17 ## <http://www.gnu.org/licenses/>.
6853 02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	18
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	19 ## -- texinfo --
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10635 diff changeset	20 ## @deftypefn {Function File} {} polyint (@var{p})
c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10635 diff changeset	21 ## @deftypefnx {Function File} {} polyint (@var{p}, @var{k})
6853 02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	22 ## Return the coefficients of the integral of the polynomial whose
20200 f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19731 diff changeset	23 ## coefficients are represented by the vector @var{p}.
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19731 diff changeset	24 ##
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19731 diff changeset	25 ## The variable @var{k} is the constant of integration, which by default is
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19731 diff changeset	26 ## set to zero.
14104 614505385171 doc: Overhaul docstrings for polynomial functions. Rik <octave@nomad.inbox5.com> parents: 13963 diff changeset	27 ## @seealso{polyder, polyval}
6853 02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	28 ## @end deftypefn
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	29
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	30 ## Author: Tony Richardson <arichard@stark.cc.oh.us>
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	31 ## Created: June 1994
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	32 ## Adapted-By: jwe
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	33
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10635 diff changeset	34 function retval = polyint (p, k)
6853 02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	35
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	36 if (nargin < 1 \|\| nargin > 2)
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	37 print_usage ();
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	38 endif
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	39
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	40 if (nargin == 1)
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	41 k = 0;
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	42 elseif (! isscalar (k))
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	43 error ("polyint: the constant of integration must be a scalar");
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	44 endif
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	45
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	46 if (! (isvector (p) \|\| isempty (p)))
10635 d1978e7364ad Print name of function in error() string messages. Rik <octave@nomad.inbox5.com> parents: 9245 diff changeset	47 error ("polyint: argument must be a vector");
6853 02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	48 endif
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	49
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	50 lp = length (p);
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	51
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	52 if (lp == 0)
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10635 diff changeset	53 retval = [];
6853 02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	54 return;
7151 aeeb646f6538 [project @ 2007-11-09 19:34:17 by jwe] jwe parents: 7017 diff changeset	55 endif
6853 02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	56
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	57 if (rows (p) > 1)
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	58 ## Convert to column vector
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	59 p = p.';
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	60 endif
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	61
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10635 diff changeset	62 retval = [(p ./ [lp:-1:1]), k];
6853 02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	63
02106856b8f6 [project @ 2007-08-31 22:51:29 by dbateman] dbateman parents: diff changeset	64 endfunction
12854 4e9576618df8 codesprint: Wrote 2 tests for polyint.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	65
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	66
12854 4e9576618df8 codesprint: Wrote 2 tests for polyint.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	67 %!test
4e9576618df8 codesprint: Wrote 2 tests for polyint.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	68 %! A = [3, 2, 1];
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	69 %! assert (polyint (A), polyint (A,0));
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	70 %! assert (polyint (A), polyint (A'));
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	71 %! assert (polyint (A), [1, 1, 1, 0]);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	72 %! assert (polyint (A,1), ones (1,4));
12854 4e9576618df8 codesprint: Wrote 2 tests for polyint.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	73
4e9576618df8 codesprint: Wrote 2 tests for polyint.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	74 %!test
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	75 %! A = ones (1,8);
12854 4e9576618df8 codesprint: Wrote 2 tests for polyint.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	76 %! B = [length(A):-1:1];
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	77 %! assert (polyint (A), [1./B, 0]);
12854 4e9576618df8 codesprint: Wrote 2 tests for polyint.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	78
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	79 %!error polyint ()
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	80 %!error polyint (ones (2,2))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	81

Mercurial > octave-nkf

annotate scripts/polynomial/polyint.m @ 20354:227d582fa300 stable