octave: scripts/polynomial/splinefit.m annotate

annotate scripts/polynomial/splinefit.m @ 31191:bb9d776eafac stable

Fix wrong color in PDF printout of some latex strings (bug #62884) * octave-svgconvert (draw): For "rect" elements only set brush color if necessary and eventually restore to previous color.

author	Pantxo Diribarne <pantxo.diribarne@gmail.com>
date	Sun, 14 Aug 2022 18:24:07 +0200
parents	796f54d4ddbf
children	597f3ee61a48

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ########################################################################
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 ##
30564 796f54d4ddbf update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	3 ## Copyright (C) 2012-2022 The Octave Project Developers
27918 b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 27069 diff changeset	4 ##
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 ## See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 ## distribution or <https://octave.org/copyright/>.
14509 a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	7 ##
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	8 ## This file is part of Octave.
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	9 ##
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	10 ## Octave is free software: you can redistribute it and/or modify it
14509 a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	11 ## under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	12 ## the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	13 ## (at your option) any later version.
14509 a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	14 ##
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	15 ## Octave is distributed in the hope that it will be useful, but
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	18 ## GNU General Public License for more details.
14509 a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	19 ##
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	20 ## You should have received a copy of the GNU General Public License
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	21 ## along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	22 ## <https://www.gnu.org/licenses/>.
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 ##
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ########################################################################
14509 a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	25
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	26 ## -- texinfo --
20852 516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20165 diff changeset	27 ## @deftypefn {} {@var{pp} =} splinefit (@var{x}, @var{y}, @var{breaks})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20165 diff changeset	28 ## @deftypefnx {} {@var{pp} =} splinefit (@var{x}, @var{y}, @var{p})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20165 diff changeset	29 ## @deftypefnx {} {@var{pp} =} splinefit (@dots{}, "periodic", @var{periodic})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20165 diff changeset	30 ## @deftypefnx {} {@var{pp} =} splinefit (@dots{}, "robust", @var{robust})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20165 diff changeset	31 ## @deftypefnx {} {@var{pp} =} splinefit (@dots{}, "beta", @var{beta})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20165 diff changeset	32 ## @deftypefnx {} {@var{pp} =} splinefit (@dots{}, "order", @var{order})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20165 diff changeset	33 ## @deftypefnx {} {@var{pp} =} splinefit (@dots{}, "constraints", @var{constraints})
16489 36dba9be680b doc: Make documentation compatible with Texinfo 5.0 (bug #38392) Amod Mulay <amodmulay1@gmail.com> parents: 15082 diff changeset	34 ##
14620 cd375519eab0 doc: Periodic grammar check of documentation Rik <octave@nomad.inbox5.com> parents: 14551 diff changeset	35 ## Fit a piecewise cubic spline with breaks (knots) @var{breaks} to the
20165 f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	36 ## noisy data, @var{x} and @var{y}.
14509 a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	37 ##
20165 f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	38 ## @var{x} is a vector, and @var{y} is a vector or N-D array. If @var{y} is an
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	39 ## N-D array, then @var{x}(j) is matched to @var{y}(:,@dots{},:,j).
14509 a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	40 ##
21546 f7f97d7e9294 doc: Wrap m-file docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 20852 diff changeset	41 ## @var{p} is a positive integer defining the number of intervals along
f7f97d7e9294 doc: Wrap m-file docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 20852 diff changeset	42 ## @var{x}, and @var{p}+1 is the number of breaks. The number of points in
f7f97d7e9294 doc: Wrap m-file docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 20852 diff changeset	43 ## each interval differ by no more than 1.
14509 a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	44 ##
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	45 ## The optional property @var{periodic} is a logical value which specifies
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	46 ## whether a periodic boundary condition is applied to the spline. The
14868 5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14621 diff changeset	47 ## length of the period is @code{max (@var{breaks}) - min (@var{breaks})}.
14509 a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	48 ## The default value is @code{false}.
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	49 ##
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	50 ## The optional property @var{robust} is a logical value which specifies
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	51 ## if robust fitting is to be applied to reduce the influence of outlying
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	52 ## data points. Three iterations of weighted least squares are performed.
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	53 ## Weights are computed from previous residuals. The sensitivity of outlier
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	54 ## identification is controlled by the property @var{beta}. The value of
20165 f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	55 ## @var{beta} is restricted to the range, 0 < @var{beta} < 1. The default
14509 a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	56 ## value is @var{beta} = 1/2. Values close to 0 give all data equal
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	57 ## weighting. Increasing values of @var{beta} reduce the influence of
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	58 ## outlying data. Values close to unity may cause instability or rank
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	59 ## deficiency.
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	60 ##
20165 f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	61 ## The fitted spline is returned as a piecewise polynomial, @var{pp}, and
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	62 ## may be evaluated using @code{ppval}.
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	63 ##
14551 60ed9260399a Improve/correct documentation for splinefit.m Ben Abbott <bpabbott@mac.com> parents: 14531 diff changeset	64 ## The splines are constructed of polynomials with degree @var{order}.
14509 a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	65 ## The default is a cubic, @var{order}=3. A spline with P pieces has
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	66 ## P+@var{order} degrees of freedom. With periodic boundary conditions
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	67 ## the degrees of freedom are reduced to P.
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	68 ##
26644 49a40c5ad734 splinefit.m: Fix typo in documentation. Rik <rik@octave.org> parents: 26376 diff changeset	69 ## The optional property, @var{constraints}, is a structure specifying linear
20165 f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	70 ## constraints on the fit. The structure has three fields, @qcode{"xc"},
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 16491 diff changeset	71 ## @qcode{"yc"}, and @qcode{"cc"}.
14509 a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	72 ##
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	73 ## @table @asis
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 16491 diff changeset	74 ## @item @qcode{"xc"}
14551 60ed9260399a Improve/correct documentation for splinefit.m Ben Abbott <bpabbott@mac.com> parents: 14531 diff changeset	75 ## Vector of the x-locations of the constraints.
14620 cd375519eab0 doc: Periodic grammar check of documentation Rik <octave@nomad.inbox5.com> parents: 14551 diff changeset	76 ##
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 16491 diff changeset	77 ## @item @qcode{"yc"}
16491 b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	78 ## Constraining values at the locations @var{xc}.
14551 60ed9260399a Improve/correct documentation for splinefit.m Ben Abbott <bpabbott@mac.com> parents: 14531 diff changeset	79 ## The default is an array of zeros.
14620 cd375519eab0 doc: Periodic grammar check of documentation Rik <octave@nomad.inbox5.com> parents: 14551 diff changeset	80 ##
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 16491 diff changeset	81 ## @item @qcode{"cc"}
14509 a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	82 ## Coefficients (matrix). The default is an array of ones. The number of
14620 cd375519eab0 doc: Periodic grammar check of documentation Rik <octave@nomad.inbox5.com> parents: 14551 diff changeset	83 ## rows is limited to the order of the piecewise polynomials, @var{order}.
14509 a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	84 ## @end table
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	85 ##
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	86 ## Constraints are linear combinations of derivatives of order 0 to
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	87 ## @var{order}-1 according to
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	88 ##
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	89 ## @example
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	90 ## @group
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	91 ## @tex
14551 60ed9260399a Improve/correct documentation for splinefit.m Ben Abbott <bpabbott@mac.com> parents: 14531 diff changeset	92 ## $cc(1,j) \cdot y(xc(j)) + cc(2,j) \cdot y\prime(xc(j)) + ... = yc(:,\dots,:,j)$.
14509 a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	93 ## @end tex
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	94 ## @ifnottex
14551 60ed9260399a Improve/correct documentation for splinefit.m Ben Abbott <bpabbott@mac.com> parents: 14531 diff changeset	95 ## cc(1,j) * y(xc(j)) + cc(2,j) * y'(xc(j)) + ... = yc(:,...,:,j).
14509 a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	96 ## @end ifnottex
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	97 ## @end group
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	98 ## @end example
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	99 ##
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	100 ## @seealso{interp1, unmkpp, ppval, spline, pchip, ppder, ppint, ppjumps}
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	101 ## @end deftypefn
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	102
16491 b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	103 function pp = splinefit (x, y, breaks, varargin)
21758 ffad2baa90f7 maint: Use newlines to make code more readable. Rik <rik@octave.org> parents: 21580 diff changeset	104
16491 b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	105 if (nargin > 3)
17386 6dbc866379e2 Replace cellfun() occurrences with faster code where possible. Rik <rik@octave.org> parents: 17281 diff changeset	106 n = cellfun ("isclass", varargin, "char");
16491 b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	107 varargin(n) = lower (varargin(n));
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	108 try
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	109 props = struct (varargin{:});
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	110 catch
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	111 print_usage ();
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	112 end_try_catch
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	113 else
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	114 props = struct ();
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	115 endif
21758 ffad2baa90f7 maint: Use newlines to make code more readable. Rik <rik@octave.org> parents: 21580 diff changeset	116
16491 b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	117 fields = fieldnames (props);
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	118 for f = 1:numel (fields)
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	119 if (! any (strcmp (fields{f},
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	120 {"periodic", "robust", "beta", "order", "constraints"})))
27069 0a62d9a6aa2d Place Octave's warning and error IDs in to the "Octave" namespace (bug #56213). Rik <rik@octave.org> parents: 26646 diff changeset	121 error ("Octave:splinefit:invalidproperty",
16491 b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	122 "unrecognized property '%s'", fields{f});
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	123 endif
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	124 endfor
21758 ffad2baa90f7 maint: Use newlines to make code more readable. Rik <rik@octave.org> parents: 21580 diff changeset	125
16491 b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	126 args = {};
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	127 if (isfield (props, "periodic") && props.periodic)
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	128 args{end+1} = "p";
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	129 endif
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	130 if (isfield (props, "robust") && props.robust)
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	131 args{end+1} = "r";
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	132 endif
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	133 if (isfield (props, "beta"))
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	134 if (0 < props.beta && props.beta < 1)
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	135 args{end+1} = props.beta;
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	136 else
27069 0a62d9a6aa2d Place Octave's warning and error IDs in to the "Octave" namespace (bug #56213). Rik <rik@octave.org> parents: 26646 diff changeset	137 error ("Octave:splinefit:invalidbeta", "invalid beta parameter (0 < BETA < 1)");
16491 b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	138 endif
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	139 endif
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	140 if (isfield (props, "order"))
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	141 if (props.order >= 0)
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	142 args{end+1} = props.order + 1;
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	143 else
27069 0a62d9a6aa2d Place Octave's warning and error IDs in to the "Octave" namespace (bug #56213). Rik <rik@octave.org> parents: 26646 diff changeset	144 error ("Octave:splinefit:invalidorder", "invalid ORDER");
16491 b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	145 endif
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	146 endif
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	147 if (isfield (props, "constraints"))
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	148 args{end+1} = props.constraints;
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	149 endif
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	150 if (nargin < 3)
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	151 print_usage ();
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	152 elseif (! isnumeric (breaks) \|\| ! isvector (breaks))
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	153 print_usage ();
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	154 endif
21758 ffad2baa90f7 maint: Use newlines to make code more readable. Rik <rik@octave.org> parents: 21580 diff changeset	155
16491 b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	156 pp = __splinefit__ (x, y, breaks, args{:});
21758 ffad2baa90f7 maint: Use newlines to make code more readable. Rik <rik@octave.org> parents: 21580 diff changeset	157
16491 b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	158 endfunction
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	159
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	160
14509 a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	161 %!demo
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	162 %! % Noisy data
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	163 %! x = linspace (0, 2*pi, 100);
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	164 %! y = sin (x) + 0.1 * randn (size (x));
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	165 %! % Breaks
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	166 %! breaks = [0:5, 2*pi];
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	167 %! % Fit a spline of order 5
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	168 %! pp = splinefit (x, y, breaks, "order", 4);
21580 ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21546 diff changeset	169 %! clf;
ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21546 diff changeset	170 %! plot (x, y, "s", x, ppval (pp, x), "r", breaks, ppval (pp, breaks), "+r");
ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21546 diff changeset	171 %! xlabel ("Independent Variable");
ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21546 diff changeset	172 %! ylabel ("Dependent Variable");
14509 a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	173 %! title ("Fit a piece-wise polynomial of order 4");
21580 ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21546 diff changeset	174 %! legend ({"data", "fit", "breaks"});
14509 a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	175 %! axis tight
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	176 %! ylim auto
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	177
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	178 %!demo
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	179 %! % Noisy data
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	180 %! x = linspace (0,2*pi, 100);
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	181 %! y = sin (x) + 0.1 * randn (size (x));
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	182 %! % Breaks
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	183 %! breaks = [0:5, 2*pi];
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	184 %! % Fit a spline of order 3 with periodic boundary conditions
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	185 %! pp = splinefit (x, y, breaks, "order", 2, "periodic", true);
21580 ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21546 diff changeset	186 %! clf;
ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21546 diff changeset	187 %! plot (x, y, "s", x, ppval (pp, x), "r", breaks, ppval (pp, breaks), "+r");
ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21546 diff changeset	188 %! xlabel ("Independent Variable");
ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21546 diff changeset	189 %! ylabel ("Dependent Variable");
14509 a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	190 %! title ("Fit a periodic piece-wise polynomial of order 2");
21580 ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21546 diff changeset	191 %! legend ({"data", "fit", "breaks"});
14509 a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	192 %! axis tight
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	193 %! ylim auto
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	194
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	195 %!demo
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	196 %! % Noisy data
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	197 %! x = linspace (0, 2*pi, 100);
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	198 %! y = sin (x) + 0.1 * randn (size (x));
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	199 %! % Breaks
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	200 %! breaks = [0:5, 2*pi];
14551 60ed9260399a Improve/correct documentation for splinefit.m Ben Abbott <bpabbott@mac.com> parents: 14531 diff changeset	201 %! % Constraints: y(0) = 0, y'(0) = 1 and y(3) + y"(3) = 0
14509 a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	202 %! xc = [0 0 3];
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	203 %! yc = [0 1 0];
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	204 %! cc = [1 0 1; 0 1 0; 0 0 1];
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	205 %! con = struct ("xc", xc, "yc", yc, "cc", cc);
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	206 %! % Fit a cubic spline with 8 pieces and constraints
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	207 %! pp = splinefit (x, y, 8, "constraints", con);
21580 ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21546 diff changeset	208 %! clf;
ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21546 diff changeset	209 %! plot (x, y, "s", x, ppval (pp, x), "r", breaks, ppval (pp, breaks), "+r");
ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21546 diff changeset	210 %! xlabel ("Independent Variable");
ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21546 diff changeset	211 %! ylabel ("Dependent Variable");
ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21546 diff changeset	212 %! title ("Fit a cubic spline with constraints");
ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21546 diff changeset	213 %! legend ({"data", "fit", "breaks"});
14509 a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	214 %! axis tight
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	215 %! ylim auto
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	216
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	217 %!demo
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	218 %! % Noisy data
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	219 %! x = linspace (0, 2*pi, 100);
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	220 %! y = sin (x) + 0.1 * randn (size (x));
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	221 %! % Breaks
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	222 %! breaks = [0:5, 2*pi];
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	223 %! xc = [0 0 3];
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	224 %! yc = [0 1 0];
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	225 %! cc = [1 0 1; 0 1 0; 0 0 1];
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	226 %! con = struct ("xc", xc, "yc", yc, "cc", cc);
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	227 %! % Fit a spline of order 6 with constraints and periodicity
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	228 %! pp = splinefit (x, y, breaks, "constraints", con, "order", 5, "periodic", true);
21580 ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21546 diff changeset	229 %! clf;
ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21546 diff changeset	230 %! plot (x, y, "s", x, ppval (pp, x), "r", breaks, ppval (pp, breaks), "+r");
ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21546 diff changeset	231 %! xlabel ("Independent Variable");
ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21546 diff changeset	232 %! ylabel ("Dependent Variable");
ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21546 diff changeset	233 %! title ("Fit a 5th order piece-wise periodic polynomial with constraints");
ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21546 diff changeset	234 %! legend ({"data", "fit", "breaks"});
14509 a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	235 %! axis tight
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	236 %! ylim auto
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	237
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	238 %!shared xb, yb, x
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	239 %! xb = 0:2:10;
15082 902a8e27b2a2 splinefit.m: Increase tolerance for %!tests. Use rand, not randn, for generating test data. Rik <rik@octave.org> parents: 15077 diff changeset	240 %! yb = 2*rand (size (xb)) - 1;
14509 a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	241 %! x = 0:0.1:10;
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	242
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	243 %!test
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	244 %! y = interp1 (xb, yb, x, "linear");
26646 46fa64c0ae40 splinefit.m: Relax tolerance of BIST tests (bug #55587). Rik <rik@octave.org> parents: 26644 diff changeset	245 %! assert (ppval (splinefit (x, y, xb, "order", 1), x), y, 20 * eps ());
14509 a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	246 %!test
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	247 %! y = interp1 (xb, yb, x, "spline");
26646 46fa64c0ae40 splinefit.m: Relax tolerance of BIST tests (bug #55587). Rik <rik@octave.org> parents: 26644 diff changeset	248 %! assert (ppval (splinefit (x, y, xb, "order", 3), x), y, 20 * eps ());
14509 a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	249 %!test
a88f8e4fae56 New Function, splinefit.m Ben Abbott <bpabbott@mac.com> parents: diff changeset	250 %! y = interp1 (xb, yb, x, "spline");
26646 46fa64c0ae40 splinefit.m: Relax tolerance of BIST tests (bug #55587). Rik <rik@octave.org> parents: 26644 diff changeset	251 %! assert (ppval (splinefit (x, y, xb), x), y, 20 * eps ());

Mercurial > octave

annotate scripts/polynomial/splinefit.m @ 31191:bb9d776eafac stable