Mercurial > octave-antonio
view scripts/polynomial/ppjumps.m @ 20165:f1d0f506ee78 stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed optimization, polynomial, signal script directories.
* scripts/optimization/fminbnd.m, scripts/optimization/fminsearch.m,
scripts/optimization/fminunc.m, scripts/optimization/fsolve.m,
scripts/optimization/fzero.m, scripts/optimization/glpk.m,
scripts/optimization/lsqnonneg.m, scripts/optimization/pqpnonneg.m,
scripts/optimization/qp.m, scripts/optimization/sqp.m,
scripts/polynomial/compan.m, scripts/polynomial/mkpp.m,
scripts/polynomial/mpoles.m, scripts/polynomial/pchip.m,
scripts/polynomial/poly.m, scripts/polynomial/polyaffine.m,
scripts/polynomial/polyder.m, scripts/polynomial/polyeig.m,
scripts/polynomial/polyfit.m, scripts/polynomial/polygcd.m,
scripts/polynomial/polyint.m, scripts/polynomial/polyout.m,
scripts/polynomial/polyval.m, scripts/polynomial/ppder.m,
scripts/polynomial/ppint.m, scripts/polynomial/ppjumps.m,
scripts/polynomial/ppval.m, scripts/polynomial/residue.m,
scripts/polynomial/roots.m, scripts/polynomial/spline.m,
scripts/polynomial/splinefit.m, scripts/polynomial/unmkpp.m,
scripts/signal/arch_fit.m, scripts/signal/arch_rnd.m,
scripts/signal/arma_rnd.m, scripts/signal/autoreg_matrix.m,
scripts/signal/bartlett.m, scripts/signal/blackman.m, scripts/signal/detrend.m,
scripts/signal/diffpara.m, scripts/signal/durbinlevinson.m,
scripts/signal/fftconv.m, scripts/signal/fftfilt.m, scripts/signal/fftshift.m,
scripts/signal/filter2.m, scripts/signal/freqz.m, scripts/signal/hamming.m,
scripts/signal/hanning.m, scripts/signal/hurst.m, scripts/signal/ifftshift.m,
scripts/signal/periodogram.m, scripts/signal/sinc.m, scripts/signal/sinetone.m,
scripts/signal/sinewave.m, scripts/signal/spectral_adf.m,
scripts/signal/spectral_xdf.m, scripts/signal/spencer.m, scripts/signal/stft.m,
scripts/signal/synthesis.m, scripts/signal/unwrap.m,
scripts/signal/yulewalker.m:
Update more docstrings to have one sentence summary as first line.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 04 May 2015 21:50:57 -0700 |
parents | 4197fc428c7d |
children |
line wrap: on
line source
## Copyright (C) 2008-2015 VZLU Prague, a.s., Czech Republic ## ## This file is part of Octave. ## ## Octave is free software; you can redistribute it and/or modify ## it under the terms of the GNU General Public License as published by ## the Free Software Foundation; either version 3 of the License, or ## (at your option) any later version. ## ## Octave is distributed in the hope that it will be useful, ## but WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ## GNU General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {@var{jumps} =} ppjumps (@var{pp}) ## Evaluate the boundary jumps of a piecewise polynomial. ## ## If there are @math{n} intervals, and the dimensionality of @var{pp} is ## @math{d}, the resulting array has dimensions @code{[d, n-1]}. ## @seealso{mkpp} ## @end deftypefn function jumps = ppjumps (pp) if (nargin != 1) print_usage (); endif if (! (isstruct (pp) && strcmp (pp.form, "pp"))) error ("ppjumps: PP must be a structure"); endif ## Extract info. [x, P, n, k, d] = unmkpp (pp); nd = length (d) + 1; ## Offsets. dx = diff (x(1:n)); dx = repmat (dx, [prod(d), 1]); dx = reshape (dx, [d, n-1]); dx = shiftdim (dx, nd - 1); ## Use Horner scheme. if (k>1) llim = shiftdim (reshape (P(1:(n-1) * prod (d), 1), [d, n-1]), nd - 1); endif for i = 2 : k; llim .*= dx; llim += shiftdim (reshape (P(1:(n-1) * prod (d), i), [d, n-1]), nd - 1); endfor rlim = shiftdim (ppval (pp, x(2:end-1)), nd - 1); jumps = shiftdim (rlim - llim, 1); endfunction %!test %! p = [1 6 11 6]; %! x = linspace (5, 6, 4); %! y = polyval (p, x); %! pp = spline (x, y); %! jj = ppjumps (pp); %! assert (jj, [0 0], eps); %!test %! breaks = [0 1 2]; %! pp1 = poly (-[1 2 3]); %! pp2 = poly (-([1 2 3]+1)); %! pp = mkpp (breaks, [pp1;pp2]); %! assert (ppjumps (pp), 0, eps); %!test %! breaks = [0 1 2]; %! pp1 = poly (-[1 2 3]); %! pp2 = poly (([1 2 3]+1)); %! pp = mkpp (breaks, [pp1;pp2]); %! j = - 2 * polyval (pp1, 1); %! assert (ppjumps (pp), j, eps);