Skip to content

Commit

Permalink
DOC: Add release note for polynomial symbol.
Browse files Browse the repository at this point in the history
  • Loading branch information
rossbar committed Jun 1, 2022
1 parent 5fdfef5 commit da2fae3
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions doc/release/upcoming_changes/16154.new_feature.rst
@@ -0,0 +1,25 @@
New attribute ``symbol`` added to polynomial classes
----------------------------------------------------

The polynomial classes in the ``numpy.polynomial`` package have a new
``symbol`` attribute which is used to represent the indeterminate
of the polynomial.
This can be used to change the value of the variable when printing::

>>> P_y = np.polynomial.Polynomial([1, 0, -1], symbol="y")
>>> print(P_y)
1.0 + 0.0·y¹ - 1.0·y²

Note that the polynomial classes only support 1D polynomials, so operations
that involve polynomials with different symbols are disallowed when the
result would be multivariate::

>>> P = np.polynomial.Polynomial([1, -1]) # default symbol is "x"
>>> P_z = np.polynomial.Polynomial([1, 1], symbol="z")
>>> P * P_z
Traceback (most recent call last)
...
ValueError: Polynomial symbols differ

The symbol can be any valid Python identifier. The default is ``symbol=x``,
consistent with existing behavior.

0 comments on commit da2fae3

Please sign in to comment.