summaryrefslogtreecommitdiff
path: root/doc/source/reference/routines.polynomials.hermite.rst
diff options
context:
space:
mode:
authorCharles Harris <charlesr.harris@gmail.com>2011-12-24 22:14:18 -0700
committerCharles Harris <charlesr.harris@gmail.com>2012-01-09 11:09:36 -0700
commit2e6ef3517c49b0dbd3a9d92d13852b34730ff516 (patch)
treeabbea9417724f8ef5b50a06426a8bdf35733b866 /doc/source/reference/routines.polynomials.hermite.rst
parent3c2603f1fe11ef6bc44de1160a7ab43325a35883 (diff)
downloadnumpy-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.hermite.rst')
-rw-r--r--doc/source/reference/routines.polynomials.hermite.rst90
1 files changed, 90 insertions, 0 deletions
diff --git a/doc/source/reference/routines.polynomials.hermite.rst b/doc/source/reference/routines.polynomials.hermite.rst
new file mode 100644
index 000000000..0600b3ea6
--- /dev/null
+++ b/doc/source/reference/routines.polynomials.hermite.rst
@@ -0,0 +1,90 @@
+Hermite Module (:mod:`numpy.polynomial.hermite`)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. currentmodule:: numpy.polynomial.hermite
+
+This module provides a number of objects (mostly functions) useful for
+dealing with Hermite series, including a `Hermite` 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`).
+
+Hermite Class
+-------------
+.. autosummary::
+ :toctree: generated/
+
+ .. _hermite-class:
+ Hermite
+
+Basics
+------
+
+.. autosummary::
+ :toctree: generated/
+
+ hermval
+ hermval2d
+ hermval3d
+ hermgrid2d
+ hermgrid3d
+ hermroots
+ hermfromroots
+
+Fitting
+-------
+
+.. autosummary::
+ :toctree: generated/
+
+ hermfit
+ hermvander
+ hermvander2d
+ hermvander3d
+
+Calculus
+--------
+
+.. autosummary::
+ :toctree: generated/
+
+ hermder
+ hermint
+
+Algebra
+-------
+
+.. autosummary::
+ :toctree: generated/
+
+ hermadd
+ hermsub
+ hermmul
+ hermmulx
+ hermdiv
+ hermpow
+
+Quadrature
+----------
+
+.. autosummary::
+ :toctree: generated/
+
+ hermgauss
+ hermweight
+
+Miscellaneous
+-------------
+
+.. autosummary::
+ :toctree: generated/
+
+ hermcompanion
+ hermdomain
+ hermzero
+ hermone
+ hermx
+ hermtrim
+ hermline
+ herm2poly
+ poly2herm