From 2e6ef3517c49b0dbd3a9d92d13852b34730ff516 Mon Sep 17 00:00:00 2001 From: Charles Harris Date: Sat, 24 Dec 2011 22:14:18 -0700 Subject: 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. --- doc/source/reference/routines.polynomials.classes.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 doc/source/reference/routines.polynomials.classes.rst (limited to 'doc/source/reference/routines.polynomials.classes.rst') 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. -- cgit v1.2.1