Mercurial > octave-nkf

comparison scripts/polynomial/polyval.m @ 20200:f1d0f506ee78 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
comparison
equal deleted inserted replaced
20199:df437a52bcaf 20200:f1d0f506ee78
20 ## @deftypefn {Function File} {@var{y} =} polyval (@var{p}, @var{x}) 20 ## @deftypefn {Function File} {@var{y} =} polyval (@var{p}, @var{x})
21 ## @deftypefnx {Function File} {@var{y} =} polyval (@var{p}, @var{x}, [], @var{mu}) 21 ## @deftypefnx {Function File} {@var{y} =} polyval (@var{p}, @var{x}, [], @var{mu})
22 ## @deftypefnx {Function File} {[@var{y}, @var{dy}] =} polyval (@var{p}, @var{x}, @var{s}) 22 ## @deftypefnx {Function File} {[@var{y}, @var{dy}] =} polyval (@var{p}, @var{x}, @var{s})
23 ## @deftypefnx {Function File} {[@var{y}, @var{dy}] =} polyval (@var{p}, @var{x}, @var{s}, @var{mu}) 23 ## @deftypefnx {Function File} {[@var{y}, @var{dy}] =} polyval (@var{p}, @var{x}, @var{s}, @var{mu})
24 ## 24 ##
25 ## Evaluate the polynomial @var{p} at the specified values of @var{x}. When 25 ## Evaluate the polynomial @var{p} at the specified values of @var{x}.
26 ## @var{mu} is present, evaluate the polynomial for 26 ##
27 ## (@var{x}-@var{mu}(1))/@var{mu}(2).
28 ## If @var{x} is a vector or matrix, the polynomial is evaluated for each of 27 ## If @var{x} is a vector or matrix, the polynomial is evaluated for each of
29 ## the elements of @var{x}. 28 ## the elements of @var{x}.
30 ## 29 ##
31 ## In addition to evaluating the polynomial, the second output 30 ## When @var{mu} is present, evaluate the polynomial for
32 ## represents the prediction interval, @var{y} +/- @var{dy}, which 31 ## (@var{x}-@var{mu}(1))/@var{mu}(2).
33 ## contains at least 50% of the future predictions. To calculate the 32 ##
34 ## prediction interval, the structured variable @var{s}, originating 33 ## In addition to evaluating the polynomial, the second output represents the
35 ## from @code{polyfit}, must be supplied. 34 ## prediction interval, @var{y} +/- @var{dy}, which contains at least 50% of
35 ## the future predictions. To calculate the prediction interval, the
36 ## structured variable @var{s}, originating from @code{polyfit}, must be
37 ## supplied.
36 ## 38 ##
37 ## @seealso{polyvalm, polyaffine, polyfit, roots, poly} 39 ## @seealso{polyvalm, polyaffine, polyfit, roots, poly}
38 ## @end deftypefn 40 ## @end deftypefn
39 41
40 ## Author: Tony Richardson <arichard@stark.cc.oh.us> 42 ## Author: Tony Richardson <arichard@stark.cc.oh.us>