summaryrefslogtreecommitdiff
path: root/doc/source/reference
diff options
context:
space:
mode:
authorRoss Barnowski <rossbar@berkeley.edu>2020-03-12 01:26:06 -0700
committerGitHub <noreply@github.com>2020-03-12 10:26:06 +0200
commit5cfc2d3ca06fb6afc95c16db172f710ed6e7eed4 (patch)
treed89d6946c296a05714f08d466d26b1e4247b72fc /doc/source/reference
parentef0957302c6383524448cef2cd4cf18c7da18ea8 (diff)
downloadnumpy-5cfc2d3ca06fb6afc95c16db172f710ed6e7eed4.tar.gz
DOC: Refactor `np.polynomial` docs using `automodule` (#15662)
* DOC: Refactor polynomial docs using automodule.
Diffstat (limited to 'doc/source/reference')
-rw-r--r--doc/source/reference/routines.polynomials.chebyshev.rst94
-rw-r--r--doc/source/reference/routines.polynomials.hermite.rst94
-rw-r--r--doc/source/reference/routines.polynomials.hermite_e.rst94
-rw-r--r--doc/source/reference/routines.polynomials.laguerre.rst94
-rw-r--r--doc/source/reference/routines.polynomials.legendre.rst94
-rw-r--r--doc/source/reference/routines.polynomials.package.rst24
-rw-r--r--doc/source/reference/routines.polynomials.polynomial.rst86
-rw-r--r--doc/source/reference/routines.polynomials.rst18
8 files changed, 43 insertions, 555 deletions
diff --git a/doc/source/reference/routines.polynomials.chebyshev.rst b/doc/source/reference/routines.polynomials.chebyshev.rst
index 60c816f03..087b7beb9 100644
--- a/doc/source/reference/routines.polynomials.chebyshev.rst
+++ b/doc/source/reference/routines.polynomials.chebyshev.rst
@@ -1,92 +1,6 @@
-Chebyshev Module (:mod:`numpy.polynomial.chebyshev`)
-====================================================
-
.. versionadded:: 1.4.0
-.. currentmodule:: numpy.polynomial.chebyshev
-
-This module provides a number of objects (mostly functions) useful for
-dealing with Chebyshev series, including a `Chebyshev` 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`).
-
-Chebyshev Class
----------------
-
-.. autosummary::
- :toctree: generated/
-
- Chebyshev
-
-Basics
-------
-
-.. autosummary::
- :toctree: generated/
-
- chebval
- chebval2d
- chebval3d
- chebgrid2d
- chebgrid3d
- chebroots
- chebfromroots
-
-Fitting
--------
-
-.. autosummary::
- :toctree: generated/
-
- chebfit
- chebvander
- chebvander2d
- chebvander3d
-
-Calculus
---------
-
-.. autosummary::
- :toctree: generated/
-
- chebder
- chebint
-
-Algebra
--------
-
-.. autosummary::
- :toctree: generated/
-
- chebadd
- chebsub
- chebmul
- chebmulx
- chebdiv
- chebpow
-
-Quadrature
-----------
-
-.. autosummary::
- :toctree: generated/
-
- chebgauss
- chebweight
-
-Miscellaneous
--------------
-
-.. autosummary::
- :toctree: generated/
-
- chebcompanion
- chebdomain
- chebzero
- chebone
- chebx
- chebtrim
- chebline
- cheb2poly
- poly2cheb
+.. automodule:: numpy.polynomial.chebyshev
+ :no-members:
+ :no-inherited-members:
+ :no-special-members:
diff --git a/doc/source/reference/routines.polynomials.hermite.rst b/doc/source/reference/routines.polynomials.hermite.rst
index 8ee72e97c..c881d9aaf 100644
--- a/doc/source/reference/routines.polynomials.hermite.rst
+++ b/doc/source/reference/routines.polynomials.hermite.rst
@@ -1,92 +1,6 @@
-Hermite Module, "Physicists'" (:mod:`numpy.polynomial.hermite`)
-===============================================================
-
.. versionadded:: 1.6.0
-.. 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
-
-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
+.. automodule:: numpy.polynomial.hermite
+ :no-members:
+ :no-inherited-members:
+ :no-special-members:
diff --git a/doc/source/reference/routines.polynomials.hermite_e.rst b/doc/source/reference/routines.polynomials.hermite_e.rst
index 33a15bb44..bfcb900c8 100644
--- a/doc/source/reference/routines.polynomials.hermite_e.rst
+++ b/doc/source/reference/routines.polynomials.hermite_e.rst
@@ -1,92 +1,6 @@
-HermiteE Module, "Probabilists'" (:mod:`numpy.polynomial.hermite_e`)
-====================================================================
-
.. versionadded:: 1.6.0
-.. currentmodule:: numpy.polynomial.hermite_e
-
-This module provides a number of objects (mostly functions) useful for
-dealing with HermiteE series, including a `HermiteE` 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`).
-
-HermiteE Class
---------------
-
-.. autosummary::
- :toctree: generated/
-
- HermiteE
-
-Basics
-------
-
-.. autosummary::
- :toctree: generated/
-
- hermeval
- hermeval2d
- hermeval3d
- hermegrid2d
- hermegrid3d
- hermeroots
- hermefromroots
-
-Fitting
--------
-
-.. autosummary::
- :toctree: generated/
-
- hermefit
- hermevander
- hermevander2d
- hermevander3d
-
-Calculus
---------
-
-.. autosummary::
- :toctree: generated/
-
- hermeder
- hermeint
-
-Algebra
--------
-
-.. autosummary::
- :toctree: generated/
-
- hermeadd
- hermesub
- hermemul
- hermemulx
- hermediv
- hermepow
-
-Quadrature
-----------
-
-.. autosummary::
- :toctree: generated/
-
- hermegauss
- hermeweight
-
-Miscellaneous
--------------
-
-.. autosummary::
- :toctree: generated/
-
- hermecompanion
- hermedomain
- hermezero
- hermeone
- hermex
- hermetrim
- hermeline
- herme2poly
- poly2herme
+.. automodule:: numpy.polynomial.hermite_e
+ :no-members:
+ :no-inherited-members:
+ :no-special-members:
diff --git a/doc/source/reference/routines.polynomials.laguerre.rst b/doc/source/reference/routines.polynomials.laguerre.rst
index 45e288cb9..68c446300 100644
--- a/doc/source/reference/routines.polynomials.laguerre.rst
+++ b/doc/source/reference/routines.polynomials.laguerre.rst
@@ -1,92 +1,6 @@
-Laguerre Module (:mod:`numpy.polynomial.laguerre`)
-==================================================
-
.. versionadded:: 1.6.0
-.. currentmodule:: numpy.polynomial.laguerre
-
-This module provides a number of objects (mostly functions) useful for
-dealing with Laguerre series, including a `Laguerre` 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`).
-
-Laguerre Class
---------------
-
-.. autosummary::
- :toctree: generated/
-
- Laguerre
-
-Basics
-------
-
-.. autosummary::
- :toctree: generated/
-
- lagval
- lagval2d
- lagval3d
- laggrid2d
- laggrid3d
- lagroots
- lagfromroots
-
-Fitting
--------
-
-.. autosummary::
- :toctree: generated/
-
- lagfit
- lagvander
- lagvander2d
- lagvander3d
-
-Calculus
---------
-
-.. autosummary::
- :toctree: generated/
-
- lagder
- lagint
-
-Algebra
--------
-
-.. autosummary::
- :toctree: generated/
-
- lagadd
- lagsub
- lagmul
- lagmulx
- lagdiv
- lagpow
-
-Quadrature
-----------
-
-.. autosummary::
- :toctree: generated/
-
- laggauss
- lagweight
-
-Miscellaneous
--------------
-
-.. autosummary::
- :toctree: generated/
-
- lagcompanion
- lagdomain
- lagzero
- lagone
- lagx
- lagtrim
- lagline
- lag2poly
- poly2lag
+.. automodule:: numpy.polynomial.laguerre
+ :no-members:
+ :no-inherited-members:
+ :no-special-members:
diff --git a/doc/source/reference/routines.polynomials.legendre.rst b/doc/source/reference/routines.polynomials.legendre.rst
index fe6edc216..e10065b4d 100644
--- a/doc/source/reference/routines.polynomials.legendre.rst
+++ b/doc/source/reference/routines.polynomials.legendre.rst
@@ -1,92 +1,6 @@
-Legendre Module (:mod:`numpy.polynomial.legendre`)
-==================================================
-
.. versionadded:: 1.6.0
-.. currentmodule:: numpy.polynomial.legendre
-
-This module provides a number of objects (mostly functions) useful for
-dealing with Legendre series, including a `Legendre` 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`).
-
-Legendre Class
---------------
-
-.. autosummary::
- :toctree: generated/
-
- Legendre
-
-Basics
-------
-
-.. autosummary::
- :toctree: generated/
-
- legval
- legval2d
- legval3d
- leggrid2d
- leggrid3d
- legroots
- legfromroots
-
-Fitting
--------
-
-.. autosummary::
- :toctree: generated/
-
- legfit
- legvander
- legvander2d
- legvander3d
-
-Calculus
---------
-
-.. autosummary::
- :toctree: generated/
-
- legder
- legint
-
-Algebra
--------
-
-.. autosummary::
- :toctree: generated/
-
- legadd
- legsub
- legmul
- legmulx
- legdiv
- legpow
-
-Quadrature
-----------
-
-.. autosummary::
- :toctree: generated/
-
- leggauss
- legweight
-
-Miscellaneous
--------------
-
-.. autosummary::
- :toctree: generated/
-
- legcompanion
- legdomain
- legzero
- legone
- legx
- legtrim
- legline
- leg2poly
- poly2leg
+.. automodule:: numpy.polynomial.legendre
+ :no-members:
+ :no-inherited-members:
+ :no-special-members:
diff --git a/doc/source/reference/routines.polynomials.package.rst b/doc/source/reference/routines.polynomials.package.rst
index 7e40d9f00..ca1217f80 100644
--- a/doc/source/reference/routines.polynomials.package.rst
+++ b/doc/source/reference/routines.polynomials.package.rst
@@ -1,20 +1,6 @@
-.. module:: numpy.polynomial
+:orphan:
-Polynomial Package
-==================
-
-.. versionadded:: 1.4.0
-
-.. currentmodule:: numpy.polynomial
-
-.. toctree::
- :maxdepth: 2
-
- routines.polynomials.classes
- routines.polynomials.polynomial
- routines.polynomials.chebyshev
- routines.polynomials.legendre
- routines.polynomials.laguerre
- routines.polynomials.hermite
- routines.polynomials.hermite_e
- routines.polynomials.polyutils
+.. automodule:: numpy.polynomial
+ :no-members:
+ :no-inherited-members:
+ :no-special-members:
diff --git a/doc/source/reference/routines.polynomials.polynomial.rst b/doc/source/reference/routines.polynomials.polynomial.rst
index 365c8da98..71000a60d 100644
--- a/doc/source/reference/routines.polynomials.polynomial.rst
+++ b/doc/source/reference/routines.polynomials.polynomial.rst
@@ -1,84 +1,6 @@
-.. module:: numpy.polynomial.polynomial
-
-Polynomial Module (:mod:`numpy.polynomial.polynomial`)
-======================================================
-
.. versionadded:: 1.4.0
-.. currentmodule:: numpy.polynomial.polynomial
-
-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
-
-Basics
-------
-
-.. autosummary::
- :toctree: generated/
-
- polyval
- polyval2d
- polyval3d
- polygrid2d
- polygrid3d
- polyroots
- polyfromroots
- polyvalfromroots
-
-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
+.. automodule:: numpy.polynomial.polynomial
+ :no-members:
+ :no-inherited-members:
+ :no-special-members:
diff --git a/doc/source/reference/routines.polynomials.rst b/doc/source/reference/routines.polynomials.rst
index e85d0549b..e74c5a683 100644
--- a/doc/source/reference/routines.polynomials.rst
+++ b/doc/source/reference/routines.polynomials.rst
@@ -1,15 +1,17 @@
+.. _routines.polynomial:
+
Polynomials
***********
Polynomials in NumPy can be *created*, *manipulated*, and even *fitted* using
-the :doc:`routines.polynomials.classes`
+the :doc:`convenience classes <routines.polynomials.classes>`
of the `numpy.polynomial` package, introduced in NumPy 1.4.
Prior to NumPy 1.4, `numpy.poly1d` was the class of choice and it is still
available in order to maintain backward compatibility.
However, the newer Polynomial package is more complete than `numpy.poly1d`
and its convenience classes are better behaved in the numpy environment.
-Therefore Polynomial is recommended for new coding.
+Therefore :mod:`numpy.polynomial` is recommended for new coding.
Transition notice
-----------------
@@ -22,9 +24,17 @@ degree i.
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
+
+ routines.polynomials.classes
+ routines.polynomials.polynomial
+ routines.polynomials.chebyshev
+ routines.polynomials.hermite
+ routines.polynomials.hermite_e
+ routines.polynomials.laguerre
+ routines.polynomials.legendre
+ routines.polynomials.polyutils
- routines.polynomials.package
.. toctree::
:maxdepth: 2