summaryrefslogtreecommitdiff
path: root/numpy/polynomial/__init__.py
diff options
context:
space:
mode:
Diffstat (limited to 'numpy/polynomial/__init__.py')
-rw-r--r--numpy/polynomial/__init__.py15
1 files changed, 15 insertions, 0 deletions
diff --git a/numpy/polynomial/__init__.py b/numpy/polynomial/__init__.py
index 6aedbef47..7e755ca52 100644
--- a/numpy/polynomial/__init__.py
+++ b/numpy/polynomial/__init__.py
@@ -1,3 +1,18 @@
+"""
+A sub-package for efficiently dealing with polynomials.
+
+Within the documentation for this sub-package, a "finite power series,"
+i.e., a polynomial (also referred to simply as a "series") is represented
+by a 1-D numpy array of the polynomial's coefficients, ordered from lowest
+order term to highest. For example, array([1,2,3]) represents
+``P_0 + 2*P_1 + 3*P_2``, where P_n is the n-th order basis polynomial
+applicable to the specific module in question, e.g., `polynomial` (which
+"wraps" the "standard" basis) or `chebyshev`. For optimal performance,
+all operations on polynomials, including evaluation at an argument, are
+implemented as operations on the coefficients. Additional (module-specific)
+information can be found in the docstring for the module of interest.
+
+"""
from polynomial import *
from chebyshev import *
from polyutils import *