diff options
| author | Charles Harris <charlesr.harris@gmail.com> | 2011-12-24 22:14:18 -0700 |
|---|---|---|
| committer | Charles Harris <charlesr.harris@gmail.com> | 2012-01-09 11:09:36 -0700 |
| commit | 2e6ef3517c49b0dbd3a9d92d13852b34730ff516 (patch) | |
| tree | abbea9417724f8ef5b50a06426a8bdf35733b866 /doc/source/reference/routines.polynomials.rst | |
| parent | 3c2603f1fe11ef6bc44de1160a7ab43325a35883 (diff) | |
| download | numpy-2e6ef3517c49b0dbd3a9d92d13852b34730ff516.tar.gz | |
DOC: Rearrange the polynomial documents.
This is the first step in cleaning up the polynomial documentation
and writing an instructional section on the convenience classes.
Diffstat (limited to 'doc/source/reference/routines.polynomials.rst')
| -rw-r--r-- | doc/source/reference/routines.polynomials.rst | 17 |
1 files changed, 13 insertions, 4 deletions
diff --git a/doc/source/reference/routines.polynomials.rst b/doc/source/reference/routines.polynomials.rst index 59d6bc499..94d1af8e7 100644 --- a/doc/source/reference/routines.polynomials.rst +++ b/doc/source/reference/routines.polynomials.rst @@ -1,14 +1,23 @@ Polynomials *********** -The poly1d functions are considered outdated but are retained for -backward compatibility. New software needing polynomials should -use the classes in the Polynomial Package. +The polynomial package is newer and more complete than poly1d and the +convenience classes are better behaved in the numpy environment. When +backwards compatibility is not an issue it should be the package of choice. +Note that the various routines in the polynomial package all deal with +series whose coefficients go from degree zero upward, which is the reverse +of the poly1d convention. The easy way to remember this is that indexes +correspond to degree, i.e., coef[i] is the coefficient of the term of +degree i. + .. toctree:: :maxdepth: 2 - routines.polynomials.polynomial routines.polynomials.poly1d +.. toctree:: + :maxdepth: 3 + + routines.polynomials.package |