class documentation

class poly1d:

View In Hierarchy

A one-dimensional polynomial class.

Note

This forms part of the old polynomial API. Since version 1.4, the new polynomial API defined in numpy.polynomial is preferred. A summary of the differences can be found in the :doc:`transition guide </reference/routines.polynomials>`.

A convenience class, used to encapsulate "natural" operations on polynomials so that said operations may take on their customary form in code (see Examples).

Parameters

c_or_r : array_like
The polynomial's coefficients, in decreasing powers, or if the value of the second parameter is True, the polynomial's roots (values where the polynomial evaluates to 0). For example, poly1d([1, 2, 3]) returns an object that represents x2 + 2x + 3, whereas poly1d([1, 2, 3], True) returns one that represents (x − 1)(x − 2)(x − 3) = x3 − 6x2 + 11x − 6.
r : bool, optional
If True, c_or_r specifies the polynomial's roots; the default is False.
variable : str, optional
Changes the variable used when printing p from x to variable (see Examples).

Examples

Construct the polynomial x2 + 2x + 3:

>>> p = np.poly1d([1, 2, 3])
>>> print(np.poly1d(p))
   2
1 x + 2 x + 3

Evaluate the polynomial at x = 0.5:

>>> p(0.5)
4.25

Find the roots:

>>> p.r
array([-1.+1.41421356j, -1.-1.41421356j])
>>> p(p.r)
array([ -4.44089210e-16+0.j,  -4.44089210e-16+0.j]) # may vary

These numbers in the previous line represent (0, 0) to machine precision

Show the coefficients:

>>> p.c
array([1, 2, 3])

Display the order (the leading zero-coefficients are removed):

>>> p.order
2

Show the coefficient of the k-th power in the polynomial (which is equivalent to p.c[-(i+1)]):

>>> p[1]
2

Polynomials can be added, subtracted, multiplied, and divided (returns quotient and remainder):

>>> p * p
poly1d([ 1,  4, 10, 12,  9])
>>> (p**3 + 4) / p
(poly1d([ 1.,  4., 10., 12.,  9.]), poly1d([4.]))

asarray(p) gives the coefficient array, so polynomials can be used in all functions that accept arrays:

>>> p**2 # square of polynomial
poly1d([ 1,  4, 10, 12,  9])
>>> np.square(p) # square of individual coefficients
array([1, 4, 9])

The variable used in the string representation of p can be modified, using the variable parameter:

>>> p = np.poly1d([1,2,3], variable='z')
>>> print(p)
   2
1 z + 2 z + 3

Construct a polynomial from its roots:

>>> np.poly1d([1, 2], True)
poly1d([ 1., -3.,  2.])

This is the same polynomial as obtained by:

>>> np.poly1d([1, -1]) * np.poly1d([1, -2])
poly1d([ 1, -3,  2])
Method __add__ Undocumented
Method __array__ Undocumented
Method __call__ Undocumented
Method __div__ Undocumented
Method __eq__ Undocumented
Method __getitem__ Undocumented
Method __init__ Undocumented
Method __iter__ Undocumented
Method __len__ Undocumented
Method __mul__ Undocumented
Method __ne__ Undocumented
Method __neg__ Undocumented
Method __pos__ Undocumented
Method __pow__ Undocumented
Method __radd__ Undocumented
Method __rdiv__ Undocumented
Method __repr__ Undocumented
Method __rmul__ Undocumented
Method __rsub__ Undocumented
Method __setitem__ Undocumented
Method __str__ Undocumented
Method __sub__ Undocumented
Method ​_coeffs.setter Undocumented
Method coeffs.setter Undocumented
Method deriv Return a derivative of this polynomial.
Method integ Return an antiderivative (indefinite integral) of this polynomial.
Class Variable __hash__ Undocumented
Instance Variable ​_coeffs Undocumented
Instance Variable ​_variable Undocumented
Property coeffs The polynomial coefficients
Property order The order or degree of the polynomial
Property roots The roots of the polynomial, where self(x) == 0
Property variable The name of the polynomial variable
def __add__(self, other):

Undocumented

def __array__(self, t=None):

Undocumented

def __call__(self, val):

Undocumented

def __div__(self, other):

Undocumented

def __eq__(self, other):

Undocumented

def __getitem__(self, val):

Undocumented

def __init__(self, c_or_r, r=False, variable=None):

Undocumented

def __iter__(self):

Undocumented

def __len__(self):

Undocumented

def __mul__(self, other):

Undocumented

def __ne__(self, other):

Undocumented

def __neg__(self):

Undocumented

def __pos__(self):

Undocumented

def __pow__(self, val):

Undocumented

def __radd__(self, other):

Undocumented

def __rdiv__(self, other):

Undocumented

def __repr__(self):

Undocumented

def __rmul__(self, other):

Undocumented

def __rsub__(self, other):

Undocumented

def __setitem__(self, key, val):

Undocumented

def __str__(self):

Undocumented

def __sub__(self, other):

Undocumented

@_coeffs.setter
def _coeffs(self, coeffs):

Undocumented

@coeffs.setter
def coeffs(self, value):

Undocumented

def deriv(self, m=1):

Return a derivative of this polynomial.

Refer to polyder for full documentation.

See Also

polyder : equivalent function

def integ(self, m=1, k=0):

Return an antiderivative (indefinite integral) of this polynomial.

Refer to polyint for full documentation.

See Also

polyint : equivalent function

__hash__ =

Undocumented

@property
_coeffs =

Undocumented

_variable =

Undocumented

@property
coeffs =
The polynomial coefficients
@property
order =
The order or degree of the polynomial
@property
roots =
The roots of the polynomial, where self(x) == 0
@property
variable =
The name of the polynomial variable