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.polynomial.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.polynomial.rst')
| -rw-r--r-- | doc/source/reference/routines.polynomials.polynomial.rst | 83 |
1 files changed, 73 insertions, 10 deletions
diff --git a/doc/source/reference/routines.polynomials.polynomial.rst b/doc/source/reference/routines.polynomials.polynomial.rst index aa92ce8fc..d555a1145 100644 --- a/doc/source/reference/routines.polynomials.polynomial.rst +++ b/doc/source/reference/routines.polynomials.polynomial.rst @@ -1,16 +1,79 @@ -Polynomial Package (:mod:`numpy.polynomial`) -============================================ +Polynomial Module (:mod:`numpy.polynomial.polynomial`) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. currentmodule:: numpy.polynomial +.. currentmodule:: numpy.polynomial.polynomial -Polynomial Classes ------------------- +This module provides a number of objects (mostly functions) useful for +dealing with Polynomial series, including a `Polynomial` class that +encapsulates the usual arithmetic operations. (General information +on how this module represents and works with such polynomials is in the +docstring for its "parent" sub-package, `numpy.polynomial`). + +Polynomial Class +---------------- .. autosummary:: :toctree: generated/ + .. _polynomial-class: Polynomial - Chebyshev - Legendre - Hermite - HermiteE - Laguerre + +Basics +------ + +.. autosummary:: + :toctree: generated/ + + polyval + polyval2d + polyval3d + polygrid2d + polygrid3d + polyroots + polyfromroots + +Fitting +------- + +.. autosummary:: + :toctree: generated/ + + polyfit + polyvander + polyvander2d + polyvander3d + +Calculus +-------- + +.. autosummary:: + :toctree: generated/ + + polyder + polyint + +Algebra +------- + +.. autosummary:: + :toctree: generated/ + + polyadd + polysub + polymul + polymulx + polydiv + polypow + +Miscellaneous +------------- + +.. autosummary:: + :toctree: generated/ + + polycompanion + polydomain + polyzero + polyone + polyx + polytrim + polyline |