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

annotate scripts/polynomial/mkpp.m @ 13929:9cae456085c2

Grammarcheck of documentation before 3.6.0 release. * accumarray.m, blkdiag.m, nargoutchk.m, nthargout.m, profexplore.m, profile.m, computer.m, orderfields.m, recycle.m, version.m, sqp.m, matlabroot.m, __plt_get_axis_arg__.m, isonormals.m, isosurface.m, __fltk_file_filter__.m, __is_function__.m, __uigetdir_fltk__.m, __uigetfile_fltk__.m, __uiobject_split_args__.m, __uiputfile_fltk__.m, uicontextmenu.m, uiresume.m, uiwait.m, mkpp.m, ppder.m, residue.m, addpref.m, getpref.m, ispref.m, loadprefs.m, prefsfile.m, saveprefs.m, rmpref.m, setpref.m, fftshift.m, bicg.m, bicgstab.m, cgs.m, gmres.m, __sprand_impl__.m, quantile.m, deblank.m, strsplit.m, addtodate.m, bsxfun.cc, kron.cc, regexp.cc, data.cc, file-io.cc, graphics.cc, load-save.cc, mappers.cc: Grammarcheck of documentation before 3.6.0 release.

author	Rik <octave@nomad.inbox5.com>
date	Wed, 23 Nov 2011 08:38:19 -0800
parents	e81ddf9cacd5
children	614505385171

rev	line source
11523 fd0a3ac60b0e update copyright notices John W. Eaton <jwe@octave.org> parents: 11472 diff changeset	1 ## Copyright (C) 2000-2011 Paul Kienzle
5824 448f9982e7fb [project @ 2006-05-19 06:53:31 by jwe] jwe parents: diff changeset	2 ##
448f9982e7fb [project @ 2006-05-19 06:53:31 by jwe] jwe parents: diff changeset	3 ## This file is part of Octave.
448f9982e7fb [project @ 2006-05-19 06:53:31 by jwe] jwe parents: diff changeset	4 ##
448f9982e7fb [project @ 2006-05-19 06:53:31 by jwe] jwe parents: diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
448f9982e7fb [project @ 2006-05-19 06:53:31 by jwe] jwe 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: 6746 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: 6746 diff changeset	8 ## your option) any later version.
5824 448f9982e7fb [project @ 2006-05-19 06:53:31 by jwe] jwe parents: diff changeset	9 ##
448f9982e7fb [project @ 2006-05-19 06:53:31 by jwe] jwe parents: diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
448f9982e7fb [project @ 2006-05-19 06:53:31 by jwe] jwe parents: diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
448f9982e7fb [project @ 2006-05-19 06:53:31 by jwe] jwe parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
448f9982e7fb [project @ 2006-05-19 06:53:31 by jwe] jwe parents: diff changeset	13 ## General Public License for more details.
448f9982e7fb [project @ 2006-05-19 06:53:31 by jwe] jwe parents: diff changeset	14 ##
448f9982e7fb [project @ 2006-05-19 06:53:31 by jwe] jwe 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: 6746 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: 6746 diff changeset	17 ## <http://www.gnu.org/licenses/>.
5824 448f9982e7fb [project @ 2006-05-19 06:53:31 by jwe] jwe parents: diff changeset	18
448f9982e7fb [project @ 2006-05-19 06:53:31 by jwe] jwe parents: diff changeset	19 ## -- texinfo --
12608 59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	20 ## @deftypefn {Function File} {@var{pp} =} mkpp (@var{breaks}, @var{coefs})
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	21 ## @deftypefnx {Function File} {@var{pp} =} mkpp (@var{breaks}, @var{coefs}, @var{d})
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	22 ##
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	23 ## Construct a piece-wise polynomial (pp) structure from sample points
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	24 ## @var{breaks} and coefficients @var{coefs}. @var{breaks} must be a vector of
13929 9cae456085c2 Grammarcheck of documentation before 3.6.0 release. Rik <octave@nomad.inbox5.com> parents: 13141 diff changeset	25 ## strictly increasing values. The number of intervals is given by
12608 59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	26 ## @code{@var{ni} = length (@var{breaks}) - 1}.
13141 e81ddf9cacd5 maint: untabify and remove trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 12608 diff changeset	27 ## When @var{m} is the polynomial order @var{coefs} must be of
12608 59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	28 ## size: @var{ni} x @var{m} + 1.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11536 diff changeset	29 ##
12608 59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	30 ## The i-th row of @var{coefs},
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	31 ## @code{@var{coefs} (@var{i},:)}, contains the coefficients for the polynomial
13141 e81ddf9cacd5 maint: untabify and remove trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 12608 diff changeset	32 ## over the @var{i}-th interval, ordered from highest (@var{m}) to
12608 59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	33 ## lowest (@var{0}).
5824 448f9982e7fb [project @ 2006-05-19 06:53:31 by jwe] jwe parents: diff changeset	34 ##
12608 59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	35 ## @var{coefs} may also be a multi-dimensional array, specifying a vector-valued
13929 9cae456085c2 Grammarcheck of documentation before 3.6.0 release. Rik <octave@nomad.inbox5.com> parents: 13141 diff changeset	36 ## or array-valued polynomial. In that case the polynomial order is defined
12608 59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	37 ## by the length of the last dimension of @var{coefs}.
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	38 ## The size of first dimension(s) are given by the scalar or
13929 9cae456085c2 Grammarcheck of documentation before 3.6.0 release. Rik <octave@nomad.inbox5.com> parents: 13141 diff changeset	39 ## vector @var{d}. If @var{d} is not given it is set to @code{1}.
9cae456085c2 Grammarcheck of documentation before 3.6.0 release. Rik <octave@nomad.inbox5.com> parents: 13141 diff changeset	40 ## In any case @var{coefs} is reshaped to a 2-D matrix of
12608 59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	41 ## size @code{[@var{ni}*prod(@var{d} @var{m})] }
5824 448f9982e7fb [project @ 2006-05-19 06:53:31 by jwe] jwe parents: diff changeset	42 ##
448f9982e7fb [project @ 2006-05-19 06:53:31 by jwe] jwe parents: diff changeset	43 ## @seealso{unmkpp, ppval, spline}
448f9982e7fb [project @ 2006-05-19 06:53:31 by jwe] jwe parents: diff changeset	44 ## @end deftypefn
448f9982e7fb [project @ 2006-05-19 06:53:31 by jwe] jwe parents: diff changeset	45
448f9982e7fb [project @ 2006-05-19 06:53:31 by jwe] jwe parents: diff changeset	46 function pp = mkpp (x, P, d)
12608 59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	47
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	48 # check number of arguments
5824 448f9982e7fb [project @ 2006-05-19 06:53:31 by jwe] jwe parents: diff changeset	49 if (nargin < 2 \|\| nargin > 3)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5824 diff changeset	50 print_usage ();
5824 448f9982e7fb [project @ 2006-05-19 06:53:31 by jwe] jwe parents: diff changeset	51 endif
12608 59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	52
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	53 # check x
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	54 if (length (x) < 2)
9768 31900e17b5f5 improve Matlab compatibility & performance of ppval/mkpp and some associated funcs Jaroslav Hajek <highegg@gmail.com> parents: 9051 diff changeset	55 error ("mkpp: at least one interval is needed");
31900e17b5f5 improve Matlab compatibility & performance of ppval/mkpp and some associated funcs Jaroslav Hajek <highegg@gmail.com> parents: 9051 diff changeset	56 endif
12608 59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	57
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	58 if (!isvector (x))
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	59 error ("mkpp: x must be a vector");
5824 448f9982e7fb [project @ 2006-05-19 06:53:31 by jwe] jwe parents: diff changeset	60 endif
12608 59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	61
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	62 len = length (x) - 1;
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	63 dP = length (size (P));
9768 31900e17b5f5 improve Matlab compatibility & performance of ppval/mkpp and some associated funcs Jaroslav Hajek <highegg@gmail.com> parents: 9051 diff changeset	64
12608 59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	65 pp = struct ("form", "pp",
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	66 "breaks", x(:).',
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	67 "coefs", [],
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	68 "pieces", len,
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	69 "order", prod (size (P)) / len,
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	70 "dim", 1);
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	71
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	72 if (nargin == 3)
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	73 pp.dim = d;
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	74 pp.order /= prod (d);
13141 e81ddf9cacd5 maint: untabify and remove trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 12608 diff changeset	75 endif
12608 59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	76
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	77 dim_vec = [pp.pieces * prod(pp.dim), pp.order];
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	78 pp.coefs = reshape (P, dim_vec);
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	79
5824 448f9982e7fb [project @ 2006-05-19 06:53:31 by jwe] jwe parents: diff changeset	80 endfunction
448f9982e7fb [project @ 2006-05-19 06:53:31 by jwe] jwe parents: diff changeset	81
448f9982e7fb [project @ 2006-05-19 06:53:31 by jwe] jwe parents: diff changeset	82 %!demo # linear interpolation
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11536 diff changeset	83 %! x=linspace(0,pi,5)';
5824 448f9982e7fb [project @ 2006-05-19 06:53:31 by jwe] jwe parents: diff changeset	84 %! t=[sin(x),cos(x)];
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11536 diff changeset	85 %! m=diff(t)./(x(2)-x(1));
5824 448f9982e7fb [project @ 2006-05-19 06:53:31 by jwe] jwe parents: diff changeset	86 %! b=t(1:4,:);
448f9982e7fb [project @ 2006-05-19 06:53:31 by jwe] jwe parents: diff changeset	87 %! pp = mkpp(x, [m(:),b(:)]);
448f9982e7fb [project @ 2006-05-19 06:53:31 by jwe] jwe parents: diff changeset	88 %! xi=linspace(0,pi,50);
6746 a8105a726e68 [project @ 2007-06-19 08:18:34 by dbateman] dbateman parents: 6721 diff changeset	89 %! plot(x,t,"x",xi,ppval(pp,xi));
a8105a726e68 [project @ 2007-06-19 08:18:34 by dbateman] dbateman parents: 6721 diff changeset	90 %! legend("control","interp");
12608 59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	91
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	92 %!shared b,c,pp
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	93 %! b = 1:3; c = 1:24; pp=mkpp(b,c);
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	94 %!assert (pp.pieces,2);
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	95 %!assert (pp.order,12);
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	96 %!assert (pp.dim,1);
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	97 %!assert (size(pp.coefs),[2,12]);
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	98 %! pp=mkpp(b,c,2);
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	99 %!assert (pp.pieces,2);
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	100 %!assert (pp.order,6);
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	101 %!assert (pp.dim,2);
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	102 %!assert (size(pp.coefs),[4,6]);
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	103 %! pp=mkpp(b,c,3);
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	104 %!assert (pp.pieces,2);
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	105 %!assert (pp.order,4);
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	106 %!assert (pp.dim,3);
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	107 %!assert (size(pp.coefs),[6,4]);
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	108 %! pp=mkpp(b,c,[2,3]);
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	109 %!assert (pp.pieces,2);
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	110 %!assert (pp.order,2);
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	111 %!assert (pp.dim,[2,3]);
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	112 %!assert (size(pp.coefs),[12,2]);

Mercurial > hg > octave-nkf

annotate scripts/polynomial/mkpp.m @ 13929:9cae456085c2