8000 ENH: Add the polynomial module to the documentation. by charris · Pull Request #91 · numpy/numpy · GitHub
[go: up one dir, main page]
Skip to content

ENH: Add the polynomial module to the documentation. #91

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

ENH: Add the polynomial module to the documentation. #91

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
853d8db
ENH: Add the polynomial module to the documentation.
charris Jun 18, 2011
6ea4ff6
Put poly1d and polynomial under a single heading
charris Jun 19, 2011
68cd432
ENH: A few tweaks to the polynomial documentation.
charris Jun 20, 2011
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
ENH: Add the polynomial module to the documentation.
  • Loading branch information
@charris
charris committed Jun 18, 2011
commit 853d8db53972f7fd76cf79eb0bd56e718a83ade5
4 changes: 2 additions & 2 deletions doc/source/reference/routines.poly.rst → doc/source/reference/routines.poly1d.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Polynomials
***********
Poly1d
******

.. currentmodule:: numpy

Expand Down
18 changes: 18 additions & 0 deletions doc/source/reference/routines.polynomial.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
.. _routines.polynomial:

Polynomials (:mod:`numpy.polynomial`)
*************************************

.. currentmodule:: numpy.polynomial

Polynomial Classes
==================
.. autosummary::
:toctree: generated/

Polynomial
Chebyshev
Legendre
Hermite
HermiteE
Laguerre
3 changes: 2 additions & 1 deletion doc/source/reference/routines.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ indentation.
routines.statistics
routines.math
routines.functional
routines.poly
routines.polynomial
routines.poly1d
routines.datetime
routines.financial
routines.set
Expand Down
12 changes: 8 additions & 4 deletions numpy/polynomial/polytemplate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@
class $name(pu.PolyBase) :
"""A $name series class.

$name instances provide the standard Python numerical methods '+',
'-', '*', '//', '%', 'divmod', '**', and '()' as well as the listed
methods.

Parameters
----------
coef : array_like
Expand Down Expand Up @@ -60,10 +64,10 @@ class $name(pu.PolyBase) :

Notes
-----
It is important to specify the domain for many uses of graded polynomial,
for instance in fitting data. This is because many of the important
properties of the polynomial basis only hold in a specified interval and
thus the data must be mapped into that domain in order to benefit.
It is important to specify the domain in many cases, for instance in
fitting data, because many of the important properties of the
polynomial basis only hold in a specified interval and consequently
the data must be mapped into that interval in order to benefit.

Examples
--------
Expand Down
0