Mercurial > hg > octave-lyh
diff scripts/polynomial/polygcd.m @ 14104:614505385171 stable
doc: Overhaul docstrings for polynomial functions.
* mkpp.m, mpoles.m, pchip.m, poly.m, polyaffine.m, polyder.m, polyfit.m,
polygcd.m, polyint.m, polyout.m, polyreduce.m, polyval.m, polyvalm.m, ppder.m,
ppval.m, residue.m, roots.m, spline.m, unmkpp.m: Improve docstrings.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Fri, 23 Dec 2011 20:09:27 -0800 |
| parents | 663594b481e5 |
| children | 72c96de7a403 |
line wrap: on
line diff
--- a/scripts/polynomial/polygcd.m +++ b/scripts/polynomial/polygcd.m @@ -23,12 +23,11 @@ ## Find the greatest common divisor of two polynomials. This is equivalent ## to the polynomial found by multiplying together all the common roots. ## Together with deconv, you can reduce a ratio of two polynomials. -## Tolerance defaults to @code{sqrt(eps)}. +## The tolerance @var{tol} defaults to @code{sqrt(eps)}. ## -## Note that this is a numerically unstable algorithm, and should not be used -## on large polynomials. +## @strong{Caution:} This is a numerically unstable algorithm and should not be used on large polynomials. ## -## Example: +## Example code: ## ## @example ## @group @@ -39,8 +38,7 @@ ## @result{} [ 0, 0, 0 ] ## @end group ## @end example -## @seealso{poly, polyint, polyder, polyreduce, roots, conv, deconv, -## residue, filter, polyval, polyvalm} +## @seealso{poly, roots, conv, deconv, residue} ## @end deftypefn function x = polygcd (b, a, tol)