Mercurial > octave

comparison scripts/polynomial/poly.m @ 20165: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 516bb87ea72e
comparison
equal deleted inserted replaced
20164:df437a52bcaf 20165:f1d0f506ee78
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {} poly (@var{A}) 20 ## @deftypefn {Function File} {} poly (@var{A})
21 ## @deftypefnx {Function File} {} poly (@var{x}) 21 ## @deftypefnx {Function File} {} poly (@var{x})
22 ## If @var{A} is a square @math{N}-by-@math{N} matrix, @code{poly (@var{A})} 22 ## If @var{A} is a square @math{N}-by-@math{N} matrix, @code{poly (@var{A})}
23 ## is the row vector of the coefficients of @code{det (z * eye (N) - A)}, 23 ## is the row vector of the coefficients of @code{det (z * eye (N) - A)},
24 ## the characteristic polynomial of @var{A}. For example, 24 ## the characteristic polynomial of @var{A}.
25 ## the following code finds the eigenvalues of @var{A} which are the roots of 25 ##
26 ## @code{poly (@var{A})}. 26 ## For example, the following code finds the eigenvalues of @var{A} which are
27 ## the roots of @code{poly (@var{A})}.
27 ## 28 ##
28 ## @example 29 ## @example
29 ## @group 30 ## @group
30 ## roots (poly (eye (3))) 31 ## roots (poly (eye (3)))
31 ## @result{} 1.00001 + 0.00001i 32 ## @result{} 1.00001 + 0.00001i
38 ## numerical performance the @code{eig} function should be used to compute 39 ## numerical performance the @code{eig} function should be used to compute
39 ## eigenvalues. 40 ## eigenvalues.
40 ## 41 ##
41 ## If @var{x} is a vector, @code{poly (@var{x})} is a vector of the 42 ## If @var{x} is a vector, @code{poly (@var{x})} is a vector of the
42 ## coefficients of the polynomial whose roots are the elements of @var{x}. 43 ## coefficients of the polynomial whose roots are the elements of @var{x}.
43 ## That is, if @var{c} is a polynomial, then the elements of @code{@var{d} = 44 ## That is, if @var{c} is a polynomial, then the elements of
44 ## roots (poly (@var{c}))} are contained in @var{c}. The vectors @var{c} and 45 ## @code{@var{d} = roots (poly (@var{c}))} are contained in @var{c}. The
45 ## @var{d} are not identical, however, due to sorting and numerical errors. 46 ## vectors @var{c} and @var{d} are not identical, however, due to sorting and
47 ## numerical errors.
46 ## @seealso{roots, eig} 48 ## @seealso{roots, eig}
47 ## @end deftypefn 49 ## @end deftypefn
48 50
49 ## Author: KH <Kurt.Hornik@wu-wien.ac.at> 51 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
50 ## Created: 24 December 1993 52 ## Created: 24 December 1993