Mercurial > octave-antonio
comparison scripts/polynomial/roots.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 |
comparison
equal
deleted
inserted
replaced
| 20164:df437a52bcaf | 20165:f1d0f506ee78 |
|---|---|
| 15 ## You should have received a copy of the GNU General Public License | 15 ## You should have received a copy of the GNU General Public License |
| 16 ## along with Octave; see the file COPYING. If not, see | 16 ## along with Octave; see the file COPYING. If not, see |
| 17 ## <http://www.gnu.org/licenses/>. | 17 ## <http://www.gnu.org/licenses/>. |
| 18 | 18 |
| 19 ## -*- texinfo -*- | 19 ## -*- texinfo -*- |
| 20 ## @deftypefn {Function File} {} roots (@var{v}) | 20 ## @deftypefn {Function File} {} roots (@var{c}) |
| 21 ## | 21 ## |
| 22 ## For a vector @var{v} with @math{N} components, return | 22 ## Compute the roots of the polynomial @var{c}. |
| 23 ## the roots of the polynomial | 23 ## |
| 24 ## For a vector @var{c} with @math{N} components, return the roots of the | |
| 25 ## polynomial | |
| 24 ## @tex | 26 ## @tex |
| 25 ## $$ | 27 ## $$ |
| 26 ## v_1 z^{N-1} + \cdots + v_{N-1} z + v_N. | 28 ## c_1 x^{N-1} + \cdots + c_{N-1} x + c_N. |
| 27 ## $$ | 29 ## $$ |
| 28 ## @end tex | 30 ## @end tex |
| 29 ## @ifnottex | 31 ## @ifnottex |
| 30 ## | 32 ## |
| 31 ## @example | 33 ## @example |
| 32 ## v(1) * z^(N-1) + @dots{} + v(N-1) * z + v(N) | 34 ## c(1) * x^(N-1) + @dots{} + c(N-1) * x + c(N) |
| 33 ## @end example | 35 ## @end example |
| 34 ## | 36 ## |
| 35 ## @end ifnottex | 37 ## @end ifnottex |
| 36 ## | 38 ## |
| 37 ## As an example, the following code finds the roots of the quadratic | 39 ## As an example, the following code finds the roots of the quadratic |