Mercurial > hg > octave-lyh
comparison scripts/polynomial/poly.m @ 9051:1bf0ce0930be
Grammar check TexInfo in all .m files
Cleanup documentation sources to follow a few consistent rules.
Spellcheck was NOT done. (but will be in another changeset)
author | Rik <rdrider0-list@yahoo.com> |
---|---|
date | Fri, 27 Mar 2009 22:31:03 -0700 |
parents | eb63fbe60fab |
children | 16f53d29049f |
comparison
equal
deleted
inserted
replaced
9044:656ad518f385 | 9051:1bf0ce0930be |
---|---|
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}. As an example we can use | 24 ## the characteristic polynomial of @var{a}. As an example we can use |
25 ## this to find the eigenvalues of @var{a} as the roots of @code{poly (@var{a})}. | 25 ## this to find the eigenvalues of @var{a} as the roots of @code{poly (@var{a})}. |
26 ## @example | 26 ## @example |
27 ## @group | |
27 ## roots(poly(eye(3))) | 28 ## roots(poly(eye(3))) |
28 ## @result{} 1.00000 + 0.00000i | 29 ## @result{} 1.00000 + 0.00000i |
29 ## @result{} 1.00000 - 0.00000i | 30 ## @result{} 1.00000 - 0.00000i |
30 ## @result{} 1.00000 + 0.00000i | 31 ## @result{} 1.00000 + 0.00000i |
32 ## @end group | |
31 ## @end example | 33 ## @end example |
32 ## In real-life examples you should, however, use the @code{eig} function | 34 ## In real-life examples you should, however, use the @code{eig} function |
33 ## for computing eigenvalues. | 35 ## for computing eigenvalues. |
34 ## | 36 ## |
35 ## If @var{x} is a vector, @code{poly (@var{x})} is a vector of coefficients | 37 ## If @var{x} is a vector, @code{poly (@var{x})} is a vector of coefficients |