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.classes.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.classes.rst')
-rw-r--r-- | doc/source/reference/routines.polynomials.classes.rst | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/source/reference/routines.polynomials.classes.rst b/doc/source/reference/routines.polynomials.classes.rst new file mode 100644 index 000000000..803251fbf --- /dev/null +++ b/doc/source/reference/routines.polynomials.classes.rst @@ -0,0 +1,15 @@ +Using the Convenience Classes +============================= + +The classes in the polynomial package can be imported directly from +numpy.polynomial as well as from the corresponding modules.:: + + >>> from numpy.polynomial import Polynomial as P + >>> p = P([0, 0, 1]) + >>> p**2 + Polynomial([ 0., 0., 0., 0., 1.], [-1., 1.], [-1., 1.]) + +Because most of the functionality in the modules of the polynomial package +is available through the corresponding classes, including fitting, shifting +and scaling, and conversion between classes, it should not be necessary to +use the functions in the modules except for multi-dimensional work. |