Mercurial > octave-antonio
view scripts/polynomial/unmkpp.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 | 9fc020886ae9 |
children |
line wrap: on
line source
## Copyright (C) 2000-2015 Paul Kienzle ## ## 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{x}, @var{p}, @var{n}, @var{k}, @var{d}] =} unmkpp (@var{pp}) ## ## Extract the components of a piecewise polynomial structure @var{pp}. ## ## The components are: ## ## @table @asis ## @item @var{x} ## Sample points. ## ## @item @var{p} ## Polynomial coefficients for points in sample interval. ## @code{@var{p} (@var{i}, :)} contains the coefficients for the polynomial ## over interval @var{i} ordered from highest to lowest. If ## @code{@var{d} > 1}, @code{@var{p} (@var{r}, @var{i}, :)} contains the ## coefficients for the r-th polynomial defined on interval @var{i}. ## ## @item @var{n} ## Number of polynomial pieces. ## ## @item @var{k} ## Order of the polynomial plus 1. ## ## @item @var{d} ## Number of polynomials defined for each interval. ## @end table ## ## @seealso{mkpp, ppval, spline, pchip} ## @end deftypefn function [x, P, n, k, d] = unmkpp (pp) if (nargin != 1) print_usage (); endif if (! (isstruct (pp) && isfield (pp, "form") && strcmp (pp.form, "pp"))) error ("unmkpp: PP must be a piecewise polynomial structure"); endif x = pp.breaks; P = pp.coefs; n = pp.pieces; k = pp.order; d = pp.dim; endfunction %!test %! b = 1:3; %! c = 1:24; %! pp = mkpp (b,c); %! [x, P, n, k, d] = unmkpp (pp); %! assert (x, b); %! assert (P, reshape (c, [2 12])); %! assert (n, 2); %! assert (k, 12); %! assert (d, 1); ## Test input validation %!error unmkpp () %!error unmkpp (1,2) %!error <piecewise polynomial structure> unmkpp (1) %!error <piecewise polynomial structure> unmkpp (struct ("field1", "pp")) %!error <piecewise polynomial structure> unmkpp (struct ("form", "not_a_pp"))