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

annotate scripts/polynomial/mkpp.m @ 14237:11949c9795a0

Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Add clf() to all demos using plot features to get reproducibility. Use 64 as input to all colormaps (jet (64)) to get reproducibility. * bicubic.m, cell2mat.m, celldisp.m, cplxpair.m, interp1.m, interp2.m, interpft.m, interpn.m, profile.m, profshow.m, convhull.m, delaunay.m, griddata.m, inpolygon.m, voronoi.m, autumn.m, bone.m, contrast.m, cool.m, copper.m, flag.m, gmap40.m, gray.m, hot.m, hsv.m, image.m, imshow.m, jet.m, ocean.m, pink.m, prism.m, rainbow.m, spring.m, summer.m, white.m, winter.m, condest.m, onenormest.m, axis.m, clabel.m, colorbar.m, comet.m, comet3.m, compass.m, contour.m, contour3.m, contourf.m, cylinder.m, daspect.m, ellipsoid.m, errorbar.m, ezcontour.m, ezcontourf.m, ezmesh.m, ezmeshc.m, ezplot.m, ezplot3.m, ezpolar.m, ezsurf.m, ezsurfc.m, feather.m, fill.m, fplot.m, grid.m, hold.m, isosurface.m, legend.m, loglog.m, loglogerr.m, pareto.m, patch.m, pbaspect.m, pcolor.m, pie.m, pie3.m, plot3.m, plotmatrix.m, plotyy.m, polar.m, quiver.m, quiver3.m, rectangle.m, refreshdata.m, ribbon.m, rose.m, scatter.m, scatter3.m, semilogx.m, semilogxerr.m, semilogy.m, semilogyerr.m, shading.m, slice.m, sombrero.m, stairs.m, stem.m, stem3.m, subplot.m, surf.m, surfc.m, surfl.m, surfnorm.m, text.m, title.m, trimesh.m, triplot.m, trisurf.m, uigetdir.m, uigetfile.m, uimenu.m, uiputfile.m, waitbar.m, xlim.m, ylim.m, zlim.m, mkpp.m, pchip.m, polyaffine.m, spline.m, bicgstab.m, cgs.m, gplot.m, pcg.m, pcr.m, treeplot.m, strtok.m, demo.m, example.m, rundemos.m, speed.m, test.m, calendar.m, datestr.m, datetick.m, weekday.m: Revamp %!demos to use Octave coding conventions on spacing, etc.

author	Rik <octave@nomad.inbox5.com>
date	Fri, 20 Jan 2012 12:59:53 -0800
parents	72c96de7a403
children	f3d52523cde1

rev	line source
14138 72c96de7a403 maint: update copyright notices for 2012 John W. Eaton <jwe@octave.org> parents: 14104 diff changeset	1 ## Copyright (C) 2000-2012 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 ##
14104 614505385171 doc: Overhaul docstrings for polynomial functions. Rik <octave@nomad.inbox5.com> parents: 13929 diff changeset	23 ## Construct a piecewise polynomial (pp) structure from sample points
12608 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 ##
14104 614505385171 doc: Overhaul docstrings for polynomial functions. Rik <octave@nomad.inbox5.com> parents: 13929 diff changeset	43 ## @seealso{unmkpp, ppval, spline, pchip, ppder, ppint, ppjumps}
5824 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
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	82
5824 448f9982e7fb [project @ 2006-05-19 06:53:31 by jwe] jwe parents: diff changeset	83 %!demo # linear interpolation
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	84 %! x = linspace (0,pi,5)';
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	85 %! t = [sin(x), cos(x)];
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	86 %! m = diff (t) ./ (x(2)-x(1));
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	87 %! b = t(1:4,:);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	88 %! pp = mkpp (x, [m(:),b(:)]);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	89 %! xi = linspace (0,pi,50);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	90 %! plot (x,t,"x", xi,ppval (pp,xi));
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	91 %! legend ("control","interp");
12608 59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	92
59e2460acae1 make piecewise polynomial (pp) functions more compatible Kai Habel <kai.habel@gmx.de> parents: 11587 diff changeset	93 %!shared b,c,pp
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	94 %! b = 1:3; c = 1:24; pp = mkpp (b,c);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	95 %!assert (pp.pieces, 2);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	96 %!assert (pp.order, 12);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	97 %!assert (pp.dim, 1);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	98 %!assert (size (pp.coefs), [2,12]);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	99 %! pp = mkpp(b,c,2);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	100 %!assert (pp.pieces, 2);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	101 %!assert (pp.order, 6);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	102 %!assert (pp.dim, 2);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	103 %!assert (size (pp.coefs), [4,6]);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	104 %! pp = mkpp(b,c,3);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	105 %!assert (pp.pieces, 2);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	106 %!assert (pp.order, 4);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	107 %!assert (pp.dim, 3);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	108 %!assert (size (pp.coefs), [6,4]);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	109 %! pp = mkpp(b,c,[2,3]);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	110 %!assert (pp.pieces, 2);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	111 %!assert (pp.order, 2);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	112 %!assert (pp.dim, [2,3]);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	113 %!assert (size (pp.coefs), [12,2]);
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	114

Mercurial > hg > octave-lyh

annotate scripts/polynomial/mkpp.m @ 14237:11949c9795a0