summaryrefslogtreecommitdiff
path: root/numpy
diff options
context:
space:
mode:
authorRalf Gommers <ralf.gommers@gmail.com>2021-03-18 10:37:13 +0100
committerGitHub <noreply@github.com>2021-03-18 10:37:13 +0100
commitff8377692eb2d318d9d61bba3a889c86aa8a6308 (patch)
tree940647c7e2d903cd7ddeab3bd7fb2057e3e3f2ca /numpy
parent3211891160619b862f114f5db8bf86ad23cca081 (diff)
parente78ec032a0cc5497a5d4683b0fbb635b9a20ab67 (diff)
downloadnumpy-ff8377692eb2d318d9d61bba3a889c86aa8a6308.tar.gz
Merge pull request #18320 from madphysicist/patch-4
DOC: add links to polynomial function/class listing
Diffstat (limited to 'numpy')
-rw-r--r--numpy/polynomial/__init__.py35
1 files changed, 17 insertions, 18 deletions
diff --git a/numpy/polynomial/__init__.py b/numpy/polynomial/__init__.py
index c832094e2..d629df29f 100644
--- a/numpy/polynomial/__init__.py
+++ b/numpy/polynomial/__init__.py
@@ -15,25 +15,24 @@ information can be found in the docstring for the module of interest.
This package provides *convenience classes* for each of six different kinds
of polynomials:
- ============ ================
- **Name** **Provides**
- ============ ================
- Polynomial Power series
- Chebyshev Chebyshev series
- Legendre Legendre series
- Laguerre Laguerre series
- Hermite Hermite series
- HermiteE HermiteE series
- ============ ================
+ ======================== ================
+ **Name** **Provides**
+ ======================== ================
+ `~polynomial.Polynomial` Power series
+ `~chebyshev.Chebyshev` Chebyshev series
+ `~legendre.Legendre` Legendre series
+ `~laguerre.Laguerre` Laguerre series
+ `~hermite.Hermite` Hermite series
+ `~hermite_e.HermiteE` HermiteE series
+ ======================== ================
These *convenience classes* provide a consistent interface for creating,
manipulating, and fitting data with polynomials of different bases.
The convenience classes are the preferred interface for the `~numpy.polynomial`
-package, and are available from the `numpy.polynomial` namespace.
-This eliminates the need to
-navigate to the corresponding submodules, e.g. ``np.polynomial.Polynomial``
-or ``np.polynomial.Chebyshev`` instead of
-``np.polynomial.polynomial.Polynomial`` or
+package, and are available from the ``numpy.polynomial`` namespace.
+This eliminates the need to navigate to the corresponding submodules, e.g.
+``np.polynomial.Polynomial`` or ``np.polynomial.Chebyshev`` instead of
+``np.polynomial.polynomial.Polynomial`` or
``np.polynomial.chebyshev.Chebyshev``, respectively.
The classes provide a more consistent and concise interface than the
type-specific functions defined in the submodules for each type of polynomial.
@@ -45,7 +44,7 @@ by arrays ``xdata`` and ``ydata``, the
>>> c = Chebyshev.fit(xdata, ydata, deg=1)
is preferred over the `chebyshev.chebfit` function from the
-`numpy.polynomial.chebyshev` module::
+``np.polynomial.chebyshev`` module::
>>> from numpy.polynomial.chebyshev import chebfit
>>> c = chebfit(xdata, ydata, deg=1)
@@ -58,8 +57,8 @@ Convenience Classes
The following lists the various constants and methods common to all of
the classes representing the various kinds of polynomials. In the following,
the term ``Poly`` represents any one of the convenience classes (e.g.
-``Polynomial``, ``Chebyshev``, ``Hermite``, etc.) while the lowercase ``p``
-represents an **instance** of a polynomial class.
+`~polynomial.Polynomial`, `~chebyshev.Chebyshev`, `~hermite.Hermite`, etc.)
+while the lowercase ``p`` represents an **instance** of a polynomial class.
Constants
---------