summaryrefslogtreecommitdiff
path: root/numpy/lib/polynomial.py
diff options
context:
space:
mode:
authorrgommers <ralf.gommers@googlemail.com>2011-03-02 12:43:47 +0800
committerrgommers <ralf.gommers@googlemail.com>2011-03-02 13:23:48 +0800
commit4ca2465fe169576b46dee783dd0279cfd536d9c4 (patch)
treed682c1b79e51bb52dd5493337facf2afc5dbca76 /numpy/lib/polynomial.py
parent7ef5d601b4fe281c797fa497c317861c7340e3ec (diff)
downloadnumpy-4ca2465fe169576b46dee783dd0279cfd536d9c4.tar.gz
DOC: merge more doc wiki edits.
Diffstat (limited to 'numpy/lib/polynomial.py')
-rw-r--r--numpy/lib/polynomial.py22
1 files changed, 10 insertions, 12 deletions
diff --git a/numpy/lib/polynomial.py b/numpy/lib/polynomial.py
index 603655ec2..f3146d691 100644
--- a/numpy/lib/polynomial.py
+++ b/numpy/lib/polynomial.py
@@ -151,13 +151,14 @@ def roots(p):
Return the roots of a polynomial with coefficients given in p.
The values in the rank-1 array `p` are coefficients of a polynomial.
- If the length of `p` is n+1 then the polynomial is described by
- p[0] * x**n + p[1] * x**(n-1) + ... + p[n-1]*x + p[n]
+ If the length of `p` is n+1 then the polynomial is described by::
+
+ p[0] * x**n + p[1] * x**(n-1) + ... + p[n-1]*x + p[n]
Parameters
----------
- p : array_like of shape(M,)
- Rank-1 array of polynomial co-efficients.
+ p : array_like
+ Rank-1 array of polynomial coefficients.
Returns
-------
@@ -166,32 +167,29 @@ def roots(p):
Raises
------
- ValueError:
+ ValueError :
When `p` cannot be converted to a rank-1 array.
See also
--------
-
- poly : Find the coefficients of a polynomial with
- a given sequence of roots.
+ poly : Find the coefficients of a polynomial with a given sequence
+ of roots.
polyval : Evaluate a polynomial at a point.
polyfit : Least squares polynomial fit.
poly1d : A one-dimensional polynomial class.
Notes
-----
-
The algorithm relies on computing the eigenvalues of the
companion matrix [1]_.
References
----------
- .. [1] Wikipedia, "Companion matrix",
- http://en.wikipedia.org/wiki/Companion_matrix
+ .. [1] R. A. Horn & C. R. Johnson, *Matrix Analysis*. Cambridge, UK:
+ Cambridge University Press, 1999, pp. 146-7.
Examples
--------
-
>>> coeff = [3.2, 2, 1]
>>> np.roots(coeff)
array([-0.3125+0.46351241j, -0.3125-0.46351241j])