octave: scripts/polynomial/mkpp.m annotate

annotate scripts/polynomial/mkpp.m @ 23084:ef4d915df748

maint: Merge stable to default.

author	John W. Eaton <jwe@octave.org>
date	Mon, 23 Jan 2017 14:27:48 -0500
parents	3a2b891d0b33 e9a0469dedd9
children	092078913d54

rev	line source
22323 bac0d6f07a3e maint: Update copyright notices for 2016. John W. Eaton <jwe@octave.org> parents: 21546 diff changeset	1 ## Copyright (C) 2000-2016 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
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	8 ## (at 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
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	13 ## GNU General Public License for more details.
5824 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 --
20852 516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20181 diff changeset	20 ## @deftypefn {} {@var{pp} =} mkpp (@var{breaks}, @var{coefs})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20181 diff changeset	21 ## @deftypefnx {} {@var{pp} =} mkpp (@var{breaks}, @var{coefs}, @var{d})
12608 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
20165 f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	24 ## @var{breaks} and coefficients @var{coefs}.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11536 diff changeset	25 ##
20165 f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	26 ## @var{breaks} must be a vector of strictly increasing values. The number of
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	27 ## intervals is given by @code{@var{ni} = length (@var{breaks}) - 1}.
20181 aa36fb998a4d maint: Remove unnecessary whitespace at end of lines. Rik <rik@octave.org> parents: 20165 diff changeset	28 ##
20165 f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	29 ## When @var{m} is the polynomial order @var{coefs} must be of size:
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	30 ## @var{ni} x @var{m} + 1.
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	31 ##
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	32 ## The i-th row of @var{coefs}, @code{@var{coefs} (@var{i},:)}, contains the
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	33 ## coefficients for the polynomial over the @var{i}-th interval, ordered from
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	34 ## highest (@var{m}) to lowest (@var{0}).
5824 448f9982e7fb [project @ 2006-05-19 06:53:31 by jwe] jwe parents: diff changeset	35 ##
21546 f7f97d7e9294 doc: Wrap m-file docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 20852 diff changeset	36 ## @var{coefs} may also be a multi-dimensional array, specifying a
f7f97d7e9294 doc: Wrap m-file docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 20852 diff changeset	37 ## vector-valued or array-valued polynomial. In that case the polynomial
f7f97d7e9294 doc: Wrap m-file docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 20852 diff changeset	38 ## order is defined by the length of the last dimension of @var{coefs}. The
f7f97d7e9294 doc: Wrap m-file docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 20852 diff changeset	39 ## size of first dimension(s) are given by the scalar or vector @var{d}. If
f7f97d7e9294 doc: Wrap m-file docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 20852 diff changeset	40 ## @var{d} is not given it is set to @code{1}. In any case @var{coefs} is
f7f97d7e9294 doc: Wrap m-file docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 20852 diff changeset	41 ## reshaped to a 2-D matrix of 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
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 14868 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
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 14868 diff changeset	53 ## check x
12608 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
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	58 if (! isvector (x))
12608 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));
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14237 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);
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	95 %!assert (pp.pieces, 2)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	96 %!assert (pp.order, 12)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	97 %!assert (pp.dim, 1)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	98 %!assert (size (pp.coefs), [2,12])
14868 5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14363 diff changeset	99 %! pp = mkpp (b,c,2);
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	100 %!assert (pp.pieces, 2)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	101 %!assert (pp.order, 6)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	102 %!assert (pp.dim, 2)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	103 %!assert (size (pp.coefs), [4,6])
14868 5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14363 diff changeset	104 %! pp = mkpp (b,c,3);
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	105 %!assert (pp.pieces, 2)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	106 %!assert (pp.order, 4)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	107 %!assert (pp.dim, 3)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	108 %!assert (size (pp.coefs), [6,4])
14868 5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14363 diff changeset	109 %! pp = mkpp (b,c,[2,3]);
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	110 %!assert (pp.pieces, 2)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	111 %!assert (pp.order, 2)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	112 %!assert (pp.dim, [2,3])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	113 %!assert (size (pp.coefs), [12,2])

Mercurial > octave

annotate scripts/polynomial/mkpp.m @ 23084:ef4d915df748